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

Почему стоит изучать разработку плагинов WordPress

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

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

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

Прежде чем начинать писать код, вам понадобится локальная среда разработки. Рекомендуется использовать XAMPP, MAMP или Local by Flywheel. После настройки среды вы сможете приступить к работе над проектом.wp-content/pluginsВ вашем каталоге был создан ваш первый плагин.

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

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

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

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

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

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

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

<?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
 */

После сохранения файла войдите в панель управления WordPress, перейдите на страницу “Плагины”, и вы увидите, что новый плагин появился в списке плагинов; его можно активировать. В настоящее время у него нет никаких функций.

Добавить первую функцию

Теперь давайте добавим к этому плагину простую функцию: автоматическое вставление пользовательского текста в конец содержимого статьи. Для этого нам понадобятся возможности, предоставляемые системой WordPress.the_contentФильтровые хаки (filter hooks).

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

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

// 在文章内容后添加自定义文本
function myfp_add_footer_text($content) {
    // 确保只在主循环的单篇文章中显示
    if (is_single() && in_the_loop() && is_main_query()) {
        $custom_text = '<p><em>Спасибо за прочтение! Данная статья была подготовлена при поддержке проекта “Мой первый плагин” („My First Plugin“).</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
// 将函数挂载到‘the_content’过滤器上
add_filter( 'the_content', 'myfp_add_footer_text' );

Этот код определяет функцию.myfp_add_footer_textОно принимает содержимое статей.$contentВ качестве параметра. Внутри функции с помощью условных проверок обеспечивается, что данный код будет выполнен только на странице отдельной статьи и только в основном цикле главного запроса; затем к полученному результату добавляется пользовательский HTML-текст. В конце используется…add_filter()Функция позволяет подключить эту пользовательскую функцию к системе WordPress.the_contentФильтр активирован. После включения плагина, при просмотре любой статьи вы увидите добавленный текст в нижней части её содержимого.

Глубокий анализ: хаки и API

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

Понимание работы действий (actions) и хуков фильтров (filter hooks)

Существует два основных типа хуков: действия (Action) и фильтры (Filter). Хуки действий позволяют вам выполнять пользовательский код в определенный момент времени. Например,wp_footerДействие запускается перед тегом, расположенным в нижней части страницы. Вы можете это сделать следующим образом:add_action('wp_footer', 'your_function')Вставьте код отслеживания или пользовательский HTML-код.

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

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

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

Фильтровые хаки (filter hooks) позволяют вам “изменять” данные. Они принимают данные, обрабатывают их с помощью вашей функции, а затем возвращают результат. Пример добавления текста в футер в предыдущем тексте является типичным применением фильтров. Еще один распространенный пример…excerpt_lengthФильтр, предназначенный для изменения длины резюме статьи.

// 修改摘要长度为20个单词
function myfp_custom_excerpt_length($length) {
    return 20;
}
add_filter('excerpt_length', 'myfp_custom_excerpt_length');

Использование API базы данных WordPress

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

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

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

// 1. 创建可配置的页脚文本
function myfp_add_footer_text_v2($content) {
    if (is_single() && in_the_loop() && is_main_query()) {
        // 从数据库获取选项值，如果不存在则使用默认值
        $footer_text = get_option('myfp_footer_text', '感谢阅读！本文由“我的第一个插件”提供支持。');
        $custom_text = '<p><em>'`.esc_html($footer_text)`.'</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
add_filter('the_content', 'myfp_add_footer_text_v2');

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

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

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

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

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

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

Добавить меню управления и вспомогательные страницы.

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

Во-первых, используйтеadd_action()Прикрепить функцию к…admin_menuДобавьте пункт меню в эту функцию.

// 添加管理菜单
function myfp_add_admin_menu() {
    add_options_page(
        '我的第一个插件设置', // 页面标题
        '我的插件设置',       // 菜单标题
        'manage_options',     // 所需权限
        'my-first-plugin',    // 菜单slug
        'myfp_options_page_html' // 用于渲染页面的回调函数
    );
}
add_action('admin_menu', 'myfp_add_admin_menu');

add_options_page()Функция создаст подстраницу в меню “Настройки”. Когда пользователь нажимает на это меню, WordPress вызывает нашу указанную обратную вызовную функцию (callback function).myfp_options_page_htmlОтобразить содержимое страницы.

Создание формы для страницы настроек

Далее необходимо определить функцию-обратный вызов (callback function), которая будет использоваться для отображения простого формы настройок. Эта форма будет отправлена на сервер.options.phpЭто стандартный способ обработки настроек в WordPress.

// 渲染设置页面
function myfp_options_page_html() {
    // 检查用户权限
    if (!current_user_can('manage_options')) {
        return;
    }
    ?>
    <div class="wrap">
        <h1><?php echo esc_html(get_admin_page_title()); ?></h1>
        <form action="/ru/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            // 输出必要的安全字段
            settings_fields('myfp_settings');
            // 输出设置章节和字段
            do_settings_sections('my-first-plugin');
            // 提交按钮
            submit_button('保存设置');
            ?>
        <input type="hidden" name="trp-form-language" value="ru"/></form>
    </div>
    &lt;?php
}

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

Просто формы недостаточны; нам необходимо использовать дополнительные инструменты или методы для реализации нашей задачи.register_setting(), add_settings_section()иadd_settings_field()Функции вроде этих позволяют сообщить WordPress, какие параметры настроек у нас есть.

// 初始化插件设置
function myfp_settings_init() {
    // 注册一个设置项‘myfp_settings’，它包含一个字段‘myfp_footer_text’
    register_setting('myfp_settings', 'myfp_footer_text');

// 在页面‘my-first-plugin’上添加一个设置章节
    add_settings_section(
        'myfp_section',
        '页脚文本设置',
        null, // 章节描述回调函数，这里不需要
        'my-first-plugin'
    );

// 在上述章节中添加一个字段
    add_settings_field(
        'myfp_field_footer_text',
        '自定义页脚文本',
        'myfp_field_footer_text_html', // 渲染字段HTML的回调函数
        'my-first-plugin',
        'myfp_section',
        ['label_for' => 'myfp_footer_text']
    );
}
add_action('admin_init', 'myfp_settings_init');

// 渲染文本输入字段
function myfp_field_footer_text_html() {
    // 获取数据库中保存的值
    $value = get_option('myfp_footer_text');
    ?>
    <input type="text" id="myfp_footer_text" name="myfp_footer_text" value="<?php echo esc_attr($value); ?>" class="regular-text">
    <p class="description">Этот текст будет отображаться в конце каждой статьи.</p>
    &lt;?php
}

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

резюме

Этот руководство показывает вам основные этапы разработки плагинов для WordPress: от создания базового файла плагина, содержащего стандартную информацию заголовка, до добавления функций в WordPress с помощью действий (actions) и фильтров (filters), хранения данных с использованием API настроек (options API), а также создания полноценного интерфейса администрирования. Весь процесс отражает модульную и на основе хуков (hooks) ориентированную философию разработки WordPress. Овладев этими основами, вы сможете изучить более сложные темы, такие как настройка пользовательских типов статей, использование шорткодов, интеграция с REST API, обработка запросов AJAX и интернационализация плагинов. Помните: хорошая структура кода, безопасная обработка данных и понятный пользовательский интерфейс являются ключевыми факторами при создании качественных плагинов.

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

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

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

Как отладить плагин, который находится в процессе разработки?

Самым эффективным способом является включение режима отладки в WordPress.wp-config.phpВ документе будет указано, что...WP_DEBUGКонстанта определяется как значение, которое не может быть изменено во время выполнения программы.trueЭто отобразит все ошибки, предупреждения и уведомления PHP на экране. Кроме того, для их управления можно использовать соответствующие инструменты или настройки.error_log()Функция записывает информацию о дебагировании в ошибочный журнал сервера или использует панели Console и Network встраиваемых инструментов разработчика браузера для дебагирования на стороне клиента.

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

WordPress использует процессы интернационализации (i18n) и локализации (l10n) для поддержки работы на нескольких языках. В коде плагинов все текстовые строки, которые требуют перевода, должны быть обозначены специальными тегами или конвенциями.__()или_e()Необходимо обернуть функции перевода в соответствующие оболочки (классы или модули). Затем с помощью инструментов вроде Poedit извлечь эти строки из исходного кода и использовать их для генерации переведенных текстов..potШаблонные файлы, с помощью которых создаются версии сайта на разных языках (например, на русском, английском и т. д.).zh_CN.poВ конце файла с кодом плагина в разделе, расположенном в начале основного файла плагина (например, в заголовочном файле `plugin.js`), укажите свой домен текстовых данных (Text Domain) и используйте его при инициализации плагина.load_plugin_textdomain()Загрузка и перевод функций.

Как опубликовать разработанный плагин в официальный каталог?

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