Разработчики WordPress: использовать Boilerplate — это хорошо

Опубликовано: 2017-10-04

Термин «шаблонный код» часто используется в уничижительной манере, поскольку никто особенно не любит его писать (включая разработчиков WordPress). Это относится к коду, который повторяется во многих местах без изменений, как к каркасу перед написанием кода, который действительно что-то делает. Некоторые языки, такие как Java и C++, подвергались критике за то, что они такие. Но все эти строительные леса, однако, существуют не просто так. То есть обеспечить и обеспечить соблюдение принципов хорошей организации в структуре кода (лучшие практики).

В контексте тем и плагинов WordPress преимущества использования стандартного кода демонстрируются более четко и прямо. Есть несколько проектов WordPress, которые предоставляют набор хорошо продуманного шаблонного кода, который может помочь вам организовать код и избежать ошибок.

Что такое шаблонный код?

Стандартный код — это, по сути, скелет каталогов и файлов исходного кода, которые вы можете использовать при разработке своего проекта. Каталоги помогают упорядочить различные файлы исходного кода по своим местам, и обычно их структура совпадает со структурой на вашей платформе разработки.

В случае плагинов WordPress файлы исходного кода обычно содержат определения функций-заполнителей, значения и комментарии, описывающие, какая часть кода находится где. Шаблонные темы WordPress также предоставляют структуру каталогов с организованными и аннотированными скелетными файлами js и CSS.

Преимущества шаблона в разработке WordPress

Все плагины WordPress имеют некоторые общие функции, такие как активация, деактивация, а также различные хуки, которые они должны реализовать. Стандартный код может обеспечить общую структуру, которая хорошо спроектирована и обеспечивает соблюдение передовых методов работы с программным обеспечением. Используя шаблонный код, вы получаете три хороших преимущества: более высокое качество кода, более простое обслуживание и более быстрая разработка. А это, в свою очередь, делает вас лучшим разработчиком WordPress.

Лучшее качество кода

Хотя качество кода ядра WordPress отличное, это обычно не относится к плагинам WordPress. Естественным следствием использования шаблонов является стандартизация. Плагины, которые соответствуют стандарту, который обеспечивает соблюдение передовой практики, имеют более чистый код и, самое главное, находятся в нужном месте. Boilerplate также призывает разработчиков полностью реализовать интерфейс и функциональность плагина. Предоставляя эту основу, она помогает вам не упустить что-то или плохо реализовать это где-то не так.

Это также отличное подспорье для начинающих разработчиков WordPress из-за того, что все выложено правильно и снабжено комментариями.

Более простое обслуживание

Все вышеперечисленное приводит к более легкому обслуживанию. Код, написанный с использованием шаблонов, легче читать, понимать и устранять неполадки. Благодаря стандартизации разработчик может взять ваш код и точно знать, где его искать. Однако это касается не только других разработчиков WordPress, но и вас самих. Код, который был написан неделю назад и все еще свеж в вашей памяти, через несколько месяцев быстро станет непонятным.

Более быстрая разработка

Шаблонный код также помогает сократить время разработки. Предоставляя вам полный рабочий скелет проекта, он позволяет вам начать писать код и проектировать там, где это важно. Вам не нужно тратить время на организацию кода или выяснение того, какие функции по умолчанию или компоненты CSS вам нужны, а затем писать их.

Но самая большая выгода — когда вы создаете свои собственные, более продвинутые стандартные пакеты. Если вы обычно создаете определенные типы сайтов WordPress, например сайты электронной коммерции или личные страницы, то происходит волшебство. Вы можете написать пакет со скелетными файлами, содержащими замещающий код и функции темы, которые являются общими для всех проектов определенного типа. Таким образом, вы просто распаковываете пакет и начинаете заполнять его только спецификой проекта.

Разместите свой сайт с Pressidium

60- ДНЕВНАЯ ГАРАНТИЯ ВОЗВРАТА ДЕНЕГ

ПОСМОТРЕТЬ НАШИ ПЛАНЫ

Если вы являетесь клиентом Pressidium, вы можете использовать наш инструмент клонирования, который был создан с учетом этой простой концепции. Например, предположим, вы создали стандартный сайт электронной коммерции WordPress на платформе Pressidium. Вы клонируете его одним щелчком мыши, а затем начинаете работать над деталями вместо того, чтобы каждый раз начинать с нуля.

Использование шаблона в проектах WordPress

Существует несколько шаблонных «систем» для WordPress. Но в этой статье мы сосредоточимся на двух, которые хорошо известны и задокументированы: The WordPress Plugin Boilerplate и roots.io.

Шаблон плагина WordPress

WordPress Plugin Boilerplate рекламирует себя как «стандартизированную, организованную, объектно-ориентированную основу для создания высококачественных плагинов WordPress» и, безусловно, оправдывает себя. Он соответствует стандартам API и документации WordPress, построен на основе API плагинов WordPress и обеспечивает удобный способ локализации. Давайте взглянем на его содержимое:

Содержимое каталога WordPress Plugin BoilerPlate

Changelog.md
Это файл журнала изменений в Markdown.

plugin-name/
Основная папка, в которой находится все остальное.

admin/
Здесь размещен весь функционал, связанный с администрированием. Он включает в себя три соответствующие папки, css , js и partials для этого.

includes/
Этот каталог включает классы для функций активации/деактивации, локализацию i18n и класс загрузчика для определения всех функций/перехватчиков.

  • class-plugin-name-activator.php
  • class-plugin-name-deactivator.php
  • class-plugin-name-i18n.php
  • class-plugin-name-loader.php
  • class-plugin-name.php
  • index.php

languages/plugin-name.pot
Шаблонный файл .pot, содержащий локализованные строки для вашего плагина.

public/
Здесь вы размещаете весь общедоступный код подключаемого модуля. Опять же, у вас есть соответствующие папки css , js и partials .

ПРИМЕЧАНИЕ . Перед началом не забудьте переименовать все вхождения «plugin-name» в имя вашего плагина.

Наша вторая предпочтительная система шаблонов намного сложнее, поэтому в этой статье невозможно полностью осветить ее. Тем не менее, у него есть отличная онлайн-документация. Разработчики также написали серию электронных книг для каждого компонента, которые вы можете приобрести на официальном сайте!

The roots.io Boilerplate: Trellis, Bedrock и Sage

Roots.io — это продвинутая шаблонная система, предлагающая три компонента (Trellis, Bedrock и Sage), которые можно использовать по отдельности или вместе. Он предназначен для использования в проектах WordPress, а не только в плагинах или темах. Он имеет расширенные функции, такие как подготовка виртуальных машин через Vagrant, управление зависимостями с помощью Composer, поддержка Sass для написания таблиц стилей, автоматическое исправление ошибок Javascript, тестирование браузера, оптимизация изображений и многое другое. Он основан на шаблоне HTML5 и поставляется с последней версией Bootstrap.

В заключение

Существует множество шаблонных систем, каждая из которых предназначена для разных нужд. Выберите Roots.io, если вы являетесь опытным разработчиком WordPress и нуждаетесь в полном шаблонном решении для проекта WordPress, а также с функциями интеграции и набором инструментов. Если вы начинающий разработчик WordPress или вам просто нужен простой шаблон, чтобы приступить к разработке плагина или темы, шаблон плагина WordPress лучше всего подходит для ваших нужд.