Полное руководство по разработке плагинов для WordPress: от основ до создания собственных функций

Зачем выбирать разработку плагинов для WordPress?

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

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

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

Первый шаг на пути к разработке плагина – это изучение его базовой структуры. Все плагины для WordPress хранятся в определенных папках системы./wp-content/plugins/Внутри каталога каждый плагин находится в своей отдельной папке.

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

Создание основного файла плагина

Ядро плагина представляет собой основной PHP-файл. Вам необходимо создать новую папку, например…my-first-pluginИ создайте внутри него PHP-файл с тем же именем, что и папка.my-first-plugin.phpКомментарии в заголовочной части этого файла имеют чрезвычайно важное значение, поскольку они предоставляют WordPress метаданные о плагине.

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

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

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

<?php
/**
 * Plugin Name:       我的第一个插件
 * Plugin URI:        https://example.com/my-first-plugin
 * Description:       这是一个用于学习插件开发的示例插件。
 * Version:           1.0.0
 * Author:            你的名字
 * Author URI:        https://example.com
 * License:           GPL v2 or later
 * Text Domain:       my-first-plugin
 * Domain Path:       /languages
 */

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

Добавление базовых функций к плагину

После активации плагина мы сможем начать добавлять к нему простые функции. Одним из распространенных примеров для начинающих является добавление строки пользовательского текста в нижнюю часть страницы веб-сайта. Это можно сделать с помощью…wp_footerЭто действие реализуется с помощью специального хука (Action Hook).

В основном файле плагина добавьте следующий код:

// 在网站页脚输出自定义信息
function my_first_plugin_footer_text() {
    echo '<p style="text-align: center;">Спасибо за использование продукта, который поддерживается моим первым плагином!</p>';
}
add_action( 'wp_footer', 'my_first_plugin_footer_text' );

Здесь мы определили функцию.my_first_plugin_footer_text()Затем используйте…add_action()Функция осуществляет её монтирование (то есть присоединяет к нужному объекту или системному компоненту).wp_footerКогда WordPress обрабатывает раздел подвала (footer) страницы, наша функция автоматически вызывается, и выводится заранее подготовленный HTML-контент. Это демонстрирует основное применение механизма “хуков и обратных вызовов” (hooks and callbacks) в WordPress.

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

Глубокий анализ: хаки и фильтры

Основная философия разработки плагинов для WordPress строится на использовании так называемых “хуков” (Hooks). Существует два типа хуков: хуки действий (Action Hooks) и хуки фильтров (Filter Hooks). Понимание их принципа работы является ключевым шагом на пути от начинающего разработчика к профессионалу.

Понимание действий, связанных с использованием хуков (action hooks)

Акционные хаки (action hooks) позволяют вставлять собственный код в определенные моменты выполнения WordPress. Как показано в приведенном примере…wp_footerОно активируется при генерации HTML-кода для футера страницы. Еще один часто используемый хук действий (action hook) — это…initЭта процедура выполняется в WordPress после завершения базовой загрузки системы и перед обработкой запросов пользователей. Часто используется для инициализации настроек плагинов, регистрации пользовательских типов статей и других действий, связанных с настройками сайта.

// 在初始化时执行一些操作
function my_plugin_init_action() {
    // 例如，在这里可以注册一个自定义文章类型
    // if ( ! post_type_exists( 'book' ) ) { ... }
}
add_action( 'init', '_plugin_init_action' );

Овладение фильтрующими хуками (filter hooks)

В отличие от действий-хуков (action hooks), фильтры-хуки (filter hooks) используются для изменения данных. Они принимают значение, позволяют вам его изменить, а затем возвращают обработанное значение. Типичным примером является…the_contentФильтр позволяет вам изменять основной текст статьи или страницы.

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

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

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

// 在文章内容末尾自动添加一段提示文字
function my_plugin_content_filter( $content ) {
    if ( is_single() ) {
        $extra_text = '<div class="my-plugin-note">Содержимое этой статьи было сгенерировано с использованием моего плагина.</div>';
        $content .= $extra_text;
    }
    return $content;
}
add_filter( 'the_content', 'my_plugin_content_filter' );

В этом примере функция…my_plugin_content_filter()Принять исходный материал.$contentНеобходимо проверить, является ли текущий страница отдельной статьей, затем добавить к её содержимому новый фрагмент HTML-кода, и в конце вернуть изменённый текст. WordPress использует этот возвращённый результат вместо исходного содержимого для отображения на странице.

Создание конфигурируемых плагинов

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

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

пользоватьсяadd_menu_page()илиadd_options_page()Функция позволяет добавить для вашего плагина элемент меню и страницу настроек в бэкенде. Обычно это делается…admin_menuДействие выполнено в ходе работы хуков (action hooks).

Рекомендуемое чтение Руководство для начинающих по разработке плагинов WordPress: создание пользовательского функционала с нуля до мастерства。

// 添加插件管理菜单
function my_plugin_add_admin_menu() {
    add_options_page(
        '我的插件设置',          // 页面标题
        '我的插件',             // 菜单标题
        'manage_options',       // 所需权限
        'my-plugin-settings',   // 菜单slug
        'my_plugin_settings_page' // 显示页面的回调函数
    );
}
add_action( 'admin_menu', 'my_plugin_add_admin_menu' );

// 设置页面的HTML内容
function my_plugin_settings_page() {
    ?>
    <div class="wrap">
        <h1>Настройки моего плагина.</h1>
        <form method="post" action="/ru/options.php/" data-trp-original-action="options.php">
            <?php
            settings_fields( 'my_plugin_settings_group' );
            do_settings_sections( 'my-plugin-settings' );
            submit_button();
            ?>
        <input type="hidden" name="trp-form-language" value="ru"/></form>
    </div>
    &lt;?php
}

Настройки регистрации, поля и меры безопасности

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

// 初始化插件设置
function my_plugin_settings_init() {
    // 注册一个新的设置项到“my_plugin_settings_group”
    register_setting( 'my_plugin_settings_group', 'my_plugin_options' );

// 在设置页面添加一个区域
    add_settings_section(
        'my_plugin_section_id',
        '基础配置',
        null,
        'my-plugin-settings'
    );

// 向该区域添加一个字段
    add_settings_field(
        'my_plugin_text_field',
        '提示文本',
        'my_plugin_text_field_render',
        'my-plugin-settings',
        'my_plugin_section_id'
    );
}
add_action( 'admin_init', 'my_plugin_settings_init' );

// 渲染文本框字段
function my_plugin_text_field_render() {
    $options = get_option( 'my_plugin_options' );
    ?>
    <input type='text' name='my_plugin_options[text_field]' value='<?php echo esc_attr( $options['text_field'] ?? '' ); ?>'>
    <p class="description">Текст, введённый здесь, будет отображаться на главной странице сайта.</p>
    &lt;?php
}

Таким образом, данные, введенные пользователем в интерфейсе, проходят встроенную в WordPress обработку (включая кодирование в формате без специальных символов, проверку на подлинность и другие меры безопасности), после чего сохраняются в виде массива.wp_optionsВ таблице. Код вашего плагина можно использовать для…get_option( ‘my_plugin_options’ )Получите эти значения безопасным способом.

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

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

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

Соблюдение лучших практик и подготовка к публикации

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

Организация кода и его безопасность

Никогда не верьте вводимым пользователями данным. Проверяйте всё, что поступает от пользователей.$_GET、$_POSTДанные, полученные из внешних источников или считанные из базы данных и готовые к выводу, необходимо обработать с помощью функций, предоставляемых WordPress. Это включает в себя их эскапирование (обработку специальных символов) и проверку на корректность.esc_html()、esc_attr()、sanitize_text_field()、wp_kses()Итд. Используйте.wp_enqueue_script()иwp_enqueue_style()Необходимо правильно загружать скрипты и стили, а также учитывать вопросы зависимостей между компонентами и контроля версий. Для сложных плагинов рекомендуется использовать объектно-ориентированное программирование (ООП) для организации кода: функции следует размещать в классах, чтобы повысить уровень модульности и повторяемости кода.

Интернационализация и локализация

Чтобы ваш плагин мог использоваться пользователями по всему миру, интернационализация (i18n) является абсолютно необходимой. Это означает, что вам потребуется…__()или_e()Функции типа `etc.` обертывают все строки, предназначенные для пользователей. Они определены в комментариях, расположенных в начале плагина.Text Domain(Например,my-first-pluginЭто значение должно совпадать с текстовым полем, используемым здесь.

// 错误示例
echo “Settings Saved”;

// 正确示例
echo esc_html__( 'Settings Saved', 'my-first-plugin' );

Затем вы можете использовать такие инструменты, как Poedit, чтобы извлечь эти строки и использовать их для создания нужного результата..potШаблонные файлы позволяют создавать контент на разных языках на основе этих шаблонов.zh_CN.poПереводите содержимое этих файлов..moКомпилируемые файлы находятся в каталоге плагинов./languages/В папке WordPress автоматически загрузит соответствующие переводы в зависимости от языка сайта.

Подготовка к публикации в официальном каталоге

Если вы планируете отправить плагин в официальный каталог плагинов WordPress.org, вам необходимо убедиться, что код соответствует установленным стандартам. Это включает в себя создание подробного описания плагина, предоставление всех необходимых файлов и документации, а также соблюдение правил форматирования кода.readme.txtФайлы, описывающие плагины (в специальном формате), скриншоты, инструкции по установке, ответы на частые вопросы (FAQ) и логи обновлений, распространяются под лицензией GPL. Исходный код плагинов загружается в официальный репозиторий Subversion (SVN). Перед публикацией необходимо тщательно проверить совместимость плагина с различными версиями WordPress, PHP, популярными темами и другими плагинами.

резюме

Разработка плагинов для WordPress представляет собой постепенный процесс, в ходе которого от простого инкапсулирования функций развиваются более сложные приложения. Всё начинается с PHP-файла, содержащего правильные заголовочные комментарии; ключевым моментом является умелое использование действий-хуков (action hooks) и фильтров-хуков (filter hooks) для взаимодействия с основной частью системы WordPress. Создание интерфейса администрирования с помощью API Settings API делает плагины более удобными в использовании. Соблюдение стандартов безопасности, реализация международной поддержки (и18n) и четкое организование кода являются основами разработки профессиональных плагинов. Будь то для удовлетворения потребностей личных проектов или вклада в сообщество open-source, освоение этого процесса откроет перед вами возможности для создания мощных, настраиваемых решений.

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

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

Вам потребуются базовые знания PHP-программирования, понимание HTML и CSS, а также знакомство с основными операциями и концепциями WordPress (статьи, страницы, плагины). Будет полезно также знать основные концепции MySQL-базы данных, хотя это и не обязательно, поскольку WordPress предоставляет удобные функции для работы с базой данных.WP_Query、wpdbКласс (class).

Чем отличается файл functions.php в плагине от файла functions.php в теме?

Разместите код в разделе, посвящённом теме (theme-related section).functions.phpВ файле описан способ быстрого добавления новых функций, однако эти функции связаны с конкретным тематическим дизайном сайта. При смене темы эти функции теряются. Плагины, напротив, являются независимыми модулями, которые работают независимо от выбранной темы; их функции сохраняются при активации плагина. Для функций, которые предполагается использовать в течение длительного времени или которые необходимо использовать на нескольких сайтах, разработка плагинов представляется более оптимальным вариантом.

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

WordPress предоставляет множество инструментов для отладки. Во-первых, вы можете…wp-config.phpФайл открыт в приложенииWP_DEBUGРежим…define( 'WP_DEBUG', true );Это отобразит все ошибки, предупреждения и уведомления PHP на экране. Более безопасным способом будет настроить это одновременно.WP_DEBUG_LOGДля…trueЗаписать ошибку в…/wp-content/debug.logВ файле. Кроме того, используйте…error_log()Использование функций или специализированных отладочных плагинов, таких как Query Monitor, позволяет более эффективно отслеживать значения переменных и результаты выполнения запросов к базе данных.

Как мой плагин совместим с более новыми версиями PHP?

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