Лучшие практики

Вот некоторые рекомендации, которые помогут в организации вашего кода, чтобы он хорошо работал вместе с другими плагинами и ядром WordPress.

Добавляйте префиксы

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

Вот несколько примеров использования префиксов в коде:

Организация файлов

Корневой уровень вашей папки с плагином должен содержать plugin-name.php и, опционально, файл для деинсталляции. Все остальные файлы по возможности должны быть собраны в папки.

Также полезно отделять код администратора и использовать условие is_admin, чтобы предотвратить его от загрузки, когда не требуется. Например, в главном файле плагина возможно следующее:

Структура папок

Четкая структура папок поможет вам и другим лучше работать с плагином. Держите подобные файлы вместе. Например, разместите файлы JavaScript в /js папку, файлы стилей в /css папку, и изображения в папке /images.

Вот образец структуры папок для справки:

/my-plugin-name
my-plugin-name.php
uninstall.php
/admin
/js
/css
/images
/includes
/settings

Архитектура плагина

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

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

Шаблоны архитектуры

В то время как есть несколько возможных моделей архитектуры, их в целом можно разделить на три вариации:

Объяснения к шаблонам архитектуры (статьи на англ.)

Конкретные реализации более сложных вышеуказанных примеров организации кода уже написаны в качестве учебных пособий и слайдов:

Отправные точки шаблонов

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

Они также служат в качестве дополнительных примеров различных, но сравнимых архитектур:

  • WordPress Plugin Boilerplate: основа для развития WordPress плагина, которая призвана обеспечить четкую и последовательную инструкцию для строительства.
  • WordPress Plugin Bootstrap: основа, чтобы построить плагин WordPress используя Grunt, Compass, GIT, и SVN.
  • WP Skeleton Plugin: Скелет плагина, фокусирующийся на юнит-тестах и использовании composer для разработки.
  • General search for WordPress plugin boilerplates on GitHub: поиск на гитхабе шаблонов для плагинов.

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

Навигация по разделам:

Оставить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *