От нуля до мастерства: путем практики научимся основным навыкам разработки плагинов для WordPress

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

Основная структура и принципы работы плагинов для WordPress

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

Основной файл плагина

Каждый плагин должен иметь главный файл. Этот главный файл обычно называется так же, как и сам плагин. Например: my-first-plugin.phpВ начале этого файла обязательно должна быть присутствовать специальная заголовочная строка, относящаяся к плагину. WordPress использует эти сведения для идентификации и отображения плагина.

Рекомендуемое чтение Полное руководство по разработке плагинов для WordPress: от нуля до мастерства в практическом применении。

<?php
/**
 * Plugin Name: 我的第一个插件
 * Plugin URI:  https://example.com/my-first-plugin
 * Description: 这是一个用于演示的简单WordPress插件。
 * Version:     1.0.0
 * Author:      开发者名称
 * License:     GPL v2 or later
 */

Этот комментарий содержит метаданные плагина, такие как его название, описание, версия и т. д., необходимые для работы с интерфейсом администрирования в WordPress. Без этих данных WordPress не сможет распознать и использовать данный плагин.

Ультахост (UltaHost) – хостинг-провайдер, предоставляющий услуги хостинга для сайтов, построенных на платформе WordPress.

Гарантия возврата средств в течение 30 дней, неограниченная пропускная способность интернет-канала и объем баз данных, бесплатная защита от DDoS-атак. При покупке на срок 3 лет предоставляется скидка в размере 501 ТБ до 4 ТБ.

страница доступа

Механизм хуков (hooks): мост между плагинами и основной программой

Основной движущей силой WordPress является система “хуков” (Hooks), которая позволяет плагинам в определенные моменты времени вставлять свой собственный код с целью изменения или расширения стандартного поведения сайта. Хуки делятся на два основных типа: действия (Actions) и фильтры (Filters).

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

Фильтровые хаки позволяют вам изменять данные. Перед тем, как данные будут отправлены в базу данных или браузер, вы можете их перехватить и изменить. Это достигается с помощью… add_filter() Реализация функций с использованием этих двух механизмов (хуков) является основой для разработки продвинутых плагинов. Понимание и умелое применение этих инструментов крайне важно для создания эффективных и надежных плагинов.

Настройка среды разработки и создание первого плагина

Перед началом работы над кодом необходимо наличие надежной локальной среды разработки. Она позволяет свободно проводить тестирование и отладку без влияния на работу веб-сайта в реальном времени.

Рекомендуемое чтение Руководство по техническим аспектам создания веб-сайта: практические рекомендации и стратегии оптимизации от начала до запуска.。

Настройка локальной среды разработки

Рекомендуется использовать интегрированные решения для работы с локальными серверами, такие как Local by Flywheel, XAMPP или MAMP. Эти инструменты позволяют одним кликом установить необходимую для работы с WordPress среду: PHP, MySQL и веб-сервер. После установки создайте новый сайт на WordPress, предназначенный для разработки плагинов.

Создайте и активируйте простой плагин.

На вашем локальном сайте, созданном с использованием системы WordPress… wp-content/plugins В каталоге создайте новую папку, например, назовите её «NewFolder». my-first-pluginВ этой папке создайте главный файл. my-first-plugin.phpИ добавьте это в примечание к заголовку упомянутого плагина.

После сохранения файла войдите в панель управления WordPress и перейдите в меню “Плагины”. Там вы должны увидеть плагин “Мой первый плагин” в списке плагинов. Нажмите кнопку “Включить”, и ваш первый плагин будет активирован. Хотя на данный момент он не выполняет никаких функций, вы успешно создали базовую структуру плагина.

hosting.com Общий хостинг

Высокая производительность благодаря процессорам AMD EPYC, SSD-накопителям NVMe и LiteSpeed, круглосуточная экспертная поддержка, передовые меры безопасности, включая SSL, защиту от грубой силы, вредоносных программ и DDoS, экономия до 73%

страница доступа

Реализация основных функций и соблюдение правил безопасности

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

Использование фильтров для изменения содержимого статьи

Мы будем использовать… the_content Фильтр-хук. Добавьте следующий код в основной файл вашего плагина:

function myplugin_add_text_to_content( $content ) {
    // 检查是否为单篇文章页面
    if ( is_single() ) {
        $custom_text = '<p><em>Спасибо за прочтение! Эта статья была добавлена моим первым плагином.</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
add_filter( 'the_content', 'myplugin_add_text_to_content' );

Этот код определяет функцию. myplugin_add_text_to_contentОно принимает содержимое статей. $content В качестве параметра. Внутри функции этот параметр используется. is_single() Используйте теги условного вывода, чтобы текст отображался только на странице конкретной статьи. В конце концов, это позволит обеспечить корректное функционирование системы. add_filter() Монтируйте эту функцию на… the_content Фильтр активирован. Сохраните файл и обновите страницу блоговой статьи — тогда вы увидите добавленный текст.

Рекомендуемое чтение Я пошагово научу вас создавать профессиональный независимый сайт на базе WooCommerce с нуля.。

Основные аспекты, учитываемые при оценке безопасности плагинов

Безопасность является одним из главных приоритетов при разработке плагинов. Никогда не следует слепо доверять пользовательским вводимым данным или данным, хранящимся на сайте.
1. Экранирование данных: При выводе любых данных в браузер необходимо их экранировать, чтобы предотвратить атаки типа XSS (Cross-Site Scripting). WordPress предоставляет для этого соответствующие инструменты и функции. esc_html(), esc_attr(), esc_url() Вспомогательные функции и т. д.
2. Проверка и очистка вводимых данных: Данные, полученные из пользовательских форм или URL-параметров, должны быть проверены (на соответствие правилам формата) и очищены (от недопустимых символов) перед их использованием. Для этого могут быть использованы специальные функции. sanitize_text_field()。
3. Безопасность от несанкционированных изменений: Если ваш плагин влияет на изменение данных (например, сохранение настроек), необходимо использовать механизм несанкционированных значений (Nonce) от WordPress для проверки цели запроса, чтобы предотвратить атаки типа CSRF (Cross-Site Request Forgery).

Добавить интерфейс управления для плагина

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

Общий хостинг InterServer

Общий хостинг $2.50 USD в месяц, первый месяц $0.1 USD промо-код tryinterserver, 461 скрипт облачных приложений, установка в один клик.

страница доступа

Создание меню и страниц управления

Мы можем использовать это. add_menu_page() или add_options_page() Функция предназначена для добавления пункта меню в бэкенд WordPress. Приведённый ниже код добавляет страницу с опциями, расположенную в подменю “Настройки”.

function myplugin_add_admin_menu() {
    add_options_page(
        '我的插件设置',          // 页面标题
        '我的插件',              // 菜单标题
        'manage_options',        // 所需权限
        'myplugin-settings',     // 菜单Slug
        'myplugin_render_settings_page' // 用于渲染页面的回调函数
    );
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );

Далее нам необходимо определить функцию обратного вызова. myplugin_render_settings_page Для генерации HTML-контента страницы настроек и обработки логики сохранения формы необходимо воспользоваться API настроек WordPress. Однако в качестве простого примера для начинающих представлен упрощенный вариант реализации:

function myplugin_render_settings_page() {
    ?>
    <div class="wrap">
        <h2>Настройки моего плагина.</h2>
        <form action="/ru/options.php/" method="post" data-trp-original-action="options.php">
            <?php settings_fields( 'myplugin_settings_group' ); ?>
            <label for="custom_text">Пользовательский текст:</label><br/>
            <textarea id="custom_text" name="myplugin_custom_text" rows="4" cols="50"><?php echo esc_textarea( get_option( 'myplugin_custom_text' ) ); ?></textarea>
            <p class="submit">
                <input type="submit" name="submit" class="button-primary" value="Сохранить изменения" />
            </p>
        <input type="hidden" name="trp-form-language" value="ru"/></form>
    </div>
    &lt;?php
}

Зарегистрируйтесь, настройте параметры и обработайте данные.

Нам необходимо зарегистрировать определенный параметр настроек и обеспечить его безопасное сохранение. Обычно это происходит при инициализации плагина.

function myplugin_register_settings() {
    register_setting(
        'myplugin_settings_group', // 设置分组
        'myplugin_custom_text',    // 选项名称
        'sanitize_textarea_field'  // 清理回调函数
    );
}
add_action( 'admin_init', 'myplugin_register_settings' );

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

резюме

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

После освоения этих основных навыков у вас уже есть все необходимое, чтобы продолжить изучение более сложных аспектов разработки плагинов для WordPress. Далее вы сможете изучить такие продвинутые темы, как пользовательские типы статей, метаданные (Meta Box), шорткоды (Shortcodes), REST API-эндпоинты и Ajax-запросы, что позволит вам создавать более функциональные и мощные плагины для этой платформы.

Часто задаваемые вопросы

Какие знания необходимы для разработки плагинов?

Вам потребуются базовые знания языка программирования PHP, поскольку ядро WordPress и его плагины написаны на этом языке. Также будет полезно знать HTML, CSS и основы JavaScript, особенно при создании пользовательских интерфейсов. Знакомство с основными концепциями базы данных MySQL также является преимуществом.

Как отладить код моего плагина?

Наиболее распространенным методом отладки при разработке с использованием WordPress является включение функции отладки (debugging mode). WP_DEBUGВы можете сделать это на сайте. wp-config.php В документе будет указано, что... define(‘WP_DEBUG’， true); Измените значение в этой строке на… trueЭто отобразит все ошибки, предупреждения и уведомления PHP на экране, а также запишет их в файл журнала (лога). Кроме того, используется… error_log() Функция позволяет выводить информацию о переменных в ошибочный журнал сервера, что также является очень полезным приемом для отладки программы.

Как моему плагину следует реализовать поддержку нескольких языков?

Чтобы сделать ваш плагин международным (то есть доступным для пользователей разных языков), вам необходимо использовать функции перевода, предоставляемые WordPress. __()， _e()Используйте специальные теги для обвала всех строк, предназначенных для пользователей. Затем с помощью таких инструментов, как Poedit, сгенерируйте необходимый код. .pot Шаблонный файл, с помощью которого переводчики могут создавать тексты на разных языках. .po и .mo Файл. Наконец, используйте его в основном файле плагина. load_plugin_textdomain() Функция для загрузки файлов с переводами.

После завершения разработки, как отправить плагин в официальный каталог?

Во-первых, убедитесь, что ваш плагин полностью соответствует официальным стандартам кодирования WordPress и требованиям лицензии GPL. Затем подайте заявку на создание SVN-репозитория для вашего плагина на сайте WordPress.org. Для этого вам понадобится использовать инструменты, предназначенные для работы с SVN, чтобы загружать код вашего плагина в этот репозиторий. /trunk Содержание. В то же время необходимо подготовить материалы высокого качества. readme.txt Снимки экрана файлов, плагинов и их иконок. После отправки вашего плагина команда официальных рецензентов проведет его проверку. После одобрения плагин сможет быть опубликован в официальном каталоге.