0
31
2019-04-15

WordPress - Качественный генератор плагинов WPPB Boilerplate

Генератор основы для плагинов WordPress, WPPB Boilerplate Plugin может быть полезным, если вы планируете создать свой плагин с нуля. Рассмотрим сервис, посмотрим что получится сгенерировать.
Понравилась страница? Поставь свою оценку!
PLUGIN_STAR_RATINGS.SCORE_TEXTPLUGIN_STAR_RATINGS.VOTES_TEXT

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

Помните, что экосистема WordPress основана на открытом исходном коде, а разработчики опираются на плагины друг друга. Это дух открытого исходного кода для совместной работы и создания улучшенного кода. Но нам также нужна основа для эффективной совместной работы. Следовательно, Automattic использует строгие правила при приеме плагина в свой репозиторий (то же самое относится и к темам).

К счастью, есть такие разработчики, как Том Макфарлин и Девин Винсон. Они создали шаблонный плагин WPPB , который призван упростить создание плагинов WordPress.

Зачем использовать генератор плагинов WPPB Boilerplate?

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

Есть несколько ситуаций, в которых использование шаблона WPPB имеет смысл:

  • Вы создаете плагин с нуля с командой разработчиков
  • Плагин предназначен для публикации в репозитории плагинов WP.
  • Ваш плагин станет обязательным в бизнесе ваших клиентов и должен быть надежным и стабильным
  • Вы хотите узнать о стандартах кодирования WordPress и лучших практиках

Давайте разберем эти причины одну за другой:

1: Вы создаете плагин с нуля, с командой разработчиков.

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

  1. Все понимают структуру файла.
  2. Цель каждого отдельного файла и класса ясна.
  3. Функции хорошо документированы
  4. Разработчики понимают, где разместить действия, обратные вызовы и т. Д.
  5. Процесс внесения изменений в ваши промежуточные и действующие системы ясен.

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

Шаблон плагина WPPB помогает избежать путаницы, поскольку он помещает всех на один уровень.

2: Плагин предназначен для публикации в репозитории плагинов WP

Как было сказано ранее, Automattic применяет строгие правила к плагинам, которые принимаются в репозитории WP. Использование шаблонного WPPB делает его более простым , чтобы следовать этим принципам, так как код уже написан следуя стандартам кодирования и стандартам документации . Таким образом, вы экономите время, просматривая кодекс WordPress, и можете сразу приступить к работе, просто следуя структурам, приведенным в шаблоне.

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

3: Бизнес ваших клиентов будет зависеть от вашего плагина

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

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

4-е: Вы хотите узнать о стандартах кодирования WordPress и передовых практиках

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

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

Настройте локальную установку и просмотрите код примеров плагинов.

Начало работы с вашим новым плагином с использованием WPPB Boilerplate для WordPress

Достаточно теории, давайте углубимся в использование WPPB.

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

Первый шаг, используем генератор плагинов WPPB.me .

шаблонный генератор wppb

Этот генератор позволяет вам заполнить плагин с самого начала. Это хорошая экономия времени.

Поскольку шаблон WPPB содержит множество мест, которые ссылаются на имя вашего плагина, слаг, имя автора и т. Д., При загрузке файлов рекомендуется использовать генератор WPPB.me. Вы можете клонировать репозиторий WPPB Github , но это оставит вам работу по поиску + замене.

Для этого примера мы будем использовать следующие детали:

Генератор шаблонов wppb - сборка плагина

После того, как вы нажмете «Построить плагин», ваш браузер загрузит zip-архив, который вы затем сможете установить на свой локальный сайт. Для этого вы можете использовать обычный установщик плагинов или распаковать архив и поместить его в wp-content / plugins. После активации плагина вы увидите его в списке плагинов.

шаблон wppb - список плагинов

Обратите внимание, что «my-plugin» и «Jan Koch» являются частью деталей, которые я добавил в генератор плагинов.

Понимание структуры шаблона плагинов WordPress

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

шаблон wppb - структура файла

Как и следовало ожидать, файлы очень хорошо организованы.

Папка «admin» содержит логику и пользовательские интерфейсы, которые загружаются в области WP-Admin сайта. Каждый разработчик, смотрящий на этот плагин, сразу понимает это.

Папка «includes» содержит суть плагина, здесь вы разместите большую часть функциональности. Например, вы можете расширить class-my-plugin-activator.php для настройки пользовательских таблиц базы данных, пользовательских заданий wp-cron или для проверки других плагинов и зависимостей. Внутри class-my-plugin-deactivator.php вы можете очистить сайт, после деактивировации плагина.

В соответствии со стандартами интернационализацииclass-my-plugin-i18n.php загружает текстовый домен плагинов.

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

шаблон wppb - основной файл

Базовый файл для вашего плагина - отличное место для начала изучения WPPB.

На скриншоте вы можете увидеть файл ядра для вашего нового плагина, который для меня является идеальной отправной точкой для понимания работы логики плагина. Каждый раз, когда вы сталкиваетесь со строкой «my-plugin» или «My_Plugin», помните, что я установил ее в генераторе. Вот почему я предпочитаю создавать шаблон, а не просто клонировать репозиторий Github. Без генератора вам нужно было бы просмотреть все файлы плагинов и настроить эти строки в соответствии с именем вашего плагина.

Давайте кратко коснемся структуры файлов для таких ресурсов, как файлы JS или CSS.

шаблон wppb - файлы js и jcc

Чтобы вывести все догадки из разработки, WPPB организован в отдельные папки для CSS, JS и партиалов. Как и следовало ожидать, class-my-plugin-public.php отвечает за правильную постановку в очередь CSS и JS и за загрузку партиалов по мере необходимости. Когда вы откроете файл, вы увидите, что он использует обычный wp_enqueue_script, wp_enqueue_style.

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

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

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

Пример: настройка страницы параметров в бэкэнде

Как вы можете видеть после активации демонстрационного плагина WPPB, в меню «Плагины» появилась новая страница настроек.

демонстрационный плагин wppb

Чтобы проверить, как эта страница была добавлена, давайте пройдемся по коду плагина.

Поиск места, где была добавлена ​​страница, очень прост, нам нужно взглянуть на папку «admin». Исходя из структуры папок, просто нет другого места для размещения кода, который загружается в области WP-Admin.

шаблон wppb - новый файл с именем class-wppb-demo-plugin-settings

Вы увидите новый файл с именем «class-wppb-demo-plugin-settings.php».

Этот новый файл обрабатывает содержимое, отображаемое на странице администратора. Вы можете проверить его логику, и вы увидите, что он способен:

  • Отображение верхнего или нижнего колонтитула
  • Сохранение ссылок на социальные профили
  • Есть также примеры для обработки ввода

Пожалуйста, ознакомьтесь с этими функциями, как они есть: примеры. Не ожидайте, что они будут глубоко интегрированы в любую тему, которую вы используете. Они предназначены, чтобы объяснить, как вы можете создать аналогичную функциональность с вашим новым плагином. Загрузка содержимого происходит в class-wppb-demo-plugin-admin.php, в функции load_dependencies () в строке 70.

шаблон wppb - функция построения

Эта функция вызывается в функции __construct () и, таким образом, загружается, когда плагин загружается в бэкэнд.

Конечно, это полностью зависит от вас, если вы добавите настройки плагина в качестве элемента в меню «Плагины», в качестве пункта главного меню или страницы параметров. Вы можете изменить реализацию в любое время, изменив функцию setup_plugin_options_menu() в строке 55 class-wppb-demo-plugin-settings.php.

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

Заключение о WPPB Boilerplate Plugin для WordPress

Для меня шаблонный плагин WPPB - фантастическая основа для создания плагина WordPress с нуля.

Я думаю, что это подходит для проектов, которые:

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

Тем не менее, плагин WPPB может быть излишним, особенно если вы:

  • Хотите создать плагин MVP для проверки или тестирования

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

Статья была переведена для блога TechBlog.SDStudio.top
Источник: www.liquidweb.com