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

Понимание основ плагинов и создания среды разработки

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

Чтобы начать разработку, сначала необходимо создать локальную среду для работы с WordPress. Это можно легко сделать с помощью таких инструментов, как Local by Flywheel, MAMP, XAMPP или напрямую с использованием контейнеров Docker. После установки WordPress на локальном компьютере вам нужно будет войти в систему управления сайтом.wp-content/pluginsКаталог. Здесь хранятся все плагины. Создайте новую папку, например…my-first-pluginВ этой папке необходимо создать главный PHP-файл, имя которого обычно совпадает с именем папки. Например:my-first-plugin.phpЭтот главный файл является точкой входа для плагина и содержит специальные аннотационные заголовки, которые сообщают WordPress название плагина, его описание, версию, автора и другую информацию.

Рекомендуется включить эту функцию в среде разработки.WP_DEBUGРежим. Откройте каталог с корневым путем WordPress.wp-config.phpВ документе найдите или добавьте следующую строку:

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

define( ‘WP_DEBUG’, true );
define( ‘WP_DEBUG_LOG’, true );
define( ‘WP_DEBUG_DISPLAY’, false );

Это приведет к тому, что ошибки и предупреждения будут записываться в…wp-content/debug.logВ файле представлена информация, которая поможет вам быстро находить ошибки в процессе разработки. Кроме того, использование мощного кодового редактора или интегрированной среды разработки (IDE), такой как VS Code или PhpStorm, значительно повысит эффективность работы. Эти инструменты обычно обеспечивают хорошую поддержку синтаксиса PHP и функции подсказок во время написания кода.

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

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

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

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

Мы пройдем весь процесс от создания файла до активации плагина, создав простой плагин с текстом “Hello World”. Этот плагин будет отображать приветственное сообщение в верхней части интерфейса административной панели сайта.

В вашем каталоге плагинов…my-first-pluginВ этом процессе необходимо создать главный файл (main file).my-first-plugin.phpОсновная структура содержимого файла должна начинаться с комментариев, расположенных в заголовочной части плагина:

<?php
/**
 * Plugin Name:       我的第一个插件
 * Plugin URI:        https://yourwebsite.com/my-first-plugin
 * Description:       这是一个用于学习插件开发的示例插件，它将在后台显示欢迎信息。
 * Version:           1.0.0
 * Author:            开发者姓名
 * Author URI:        https://yourwebsite.com
 * License:           GPL v2 or later
 * Text Domain:       my-first-plugin
 * Domain Path:       /languages
 */

Эти заголовки комментариев являются обязательными; WordPress использует их для идентификации и отображения вашего плагина на странице управления плагинами. Среди них…Text DomainИспользуется для интернационализации (i18n).Domain PathУказан каталог, в котором находятся языковые файлы (если это необходимо).

Далее мы добавим основные функции. В этом примере мы будем использовать…admin_noticesКрючок. Добавьте следующий код под комментарием в начале файла:

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

// 使用 admin_notices 钩子在管理后台输出提示信息
add_action( ‘admin_notices’, ‘my_first_plugin_display_admin_greeting’ );

/**
 * 在管理后台显示欢迎信息的函数
 * @return void
 */
function my_first_plugin_display_admin_greeting() {
    // 检查当前用户是否有权限，确保只在后台显示
    if ( ! current_user_can( ‘manage_options’ ) ) {
        return;
    }
    ?>
    <div class="notice notice-success is-dismissible">
        <p><?php _e( ‘欢迎使用我的第一个插件！插件开发之旅正式开始！’, ‘my-first-plugin’ ); ?></p>
    </div>
    &lt;?php
}

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

Основные технологии WordPress: хаки (hooks) и фильтры (filters)

Понимание и умелое использование хуков (hooks) является ключевым аспектом разработки плагинов для WordPress. Существует два типа хуков: действия (Actions) и фильтры (Filters). Хуки действий позволяют вставлять и выполнять пользовательский код в определенные моменты времени — например, после публикации статьи или перед загрузкой верхней части страницы. Мы использовали именно хуки действий в приведенном выше примере.admin_noticesЭто просто хук (функция-обработчик) для выполнения определенных действий. Хуки фильтров, напротив, позволяют вам изменять данные, которые генерируются или передаются в процессе работы программы – например, содержимое заголовков статей или результаты запросов плагинов.

Как добавить пользовательское действие (custom action)?

Действие выполнено успешно.add_action()Функция добавляется следующим образом: синтаксис таков:add_action( ‘hook_name’, ‘your_function_name’, priority, accepted_args )Приоритет (priority) представляет собой целое число; чем меньше значение, тем операция выполняется раньше. Значение по умолчанию составляет 10. Например, если вы хотите добавить некоторый пользовательский HTML-код после основного содержимого статьи:

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

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

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

add_action( ‘the_content’, ‘my_custom_content_append’ );
function my_custom_content_append( $content ) {
    // 只在单篇文章主循环内生效
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $extra_content = ‘<div class="“my-custom-box”"><p>Это пользовательский контент, который был добавлен с помощью плагина.</p></div>’;
        $content .= $extra_content;
    }
    return $content;
}

Обратите внимание: хотя…the_contentЭто фильтр; он должен возвращать изменённые данные.$contentWordPress также использует это как точку запуска определенных действий. Более строгим подходом будет использование…add_filter。

Как добавить пользовательский фильтр?

Фильтр прошел проверку (или: Фильтр сработал корректно).add_filter()Добавление функции. Синтаксис:add_action()Аналогичным примером может служить изменение длины выдержки из статьи.

add_filter( ‘excerpt_length’, ‘my_custom_excerpt_length’, 999 );
function my_custom_excerpt_length( $length ) {
    // 将默认的55个词改为20个词
    return 20;
}

Вы можете создать собственные «хаки» (специальные механизмы для взаимодействия с системой), чтобы ваш плагин мог быть расширен другими разработчиками или использован в других темах (дизайнерских схемах интерфейса).do_action()Для определения действия-хака (action hook) используйте следующий подход:apply_filters()Давайте определим хук (filter hook) – это ключевой механизм для создания модульных и расширяемых плагинов.

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

Расширение функционала плагинов и лучшие практики их использования

По мере того как функционал плагинов становится всё более сложным, хорошая организация кода, его безопасность, удобство обслуживания и производительность приобретают крайне важное значение. Распространённым подходом является использование объектно-ориентированного программирования (ООП) для структурирования кода – связанные функции и данные объединяются в один основной класс.

Используйте объектно-ориентированное программирование для обеспечения упаковки кода (то есть для его структуризации и организации).

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

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

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

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

<?php
/**
 * Plugin Name:       进阶示例插件
 */
if ( ! class_exists( ‘My_Advanced_Plugin’ ) ) {
    class My_Advanced_Plugin {
        /**
         * 构造方法，用于初始化钩子
         */
        public function __construct() {
            add_action( ‘init’, array( $this, ‘register_custom_post_type’ ) );
            add_action( ‘admin_menu’, array( $this, ‘add_admin_menu_page’ ) );
            add_filter( ‘the_title’, array( $this, ‘filter_post_title_prefix’ ), 10, 2 );
        }

/**
         * 注册一个自定义文章类型
         */
        public function register_custom_post_type() {
            $args = array(
                ‘public’ => true,
                ‘label’  => ‘我的产品’,
                ‘supports’ => array( ‘title’, ‘editor’, ‘thumbnail’ ),
                ‘has_archive’ => true,
            );
            register_post_type( ‘my_product’, $args );
        }

/**
         * 在文章标题前添加前缀的过滤器
         * @param string $title 原标题
         * @param int    $id    文章ID
         * @return string 修改后的标题
         */
        public function filter_post_title_prefix( $title, $id = null ) {
            if ( ! is_admin() && in_the_loop() ) {
                $title = ‘[精品] ’ . $title;
            }
            return $title;
        }

// ... 其他方法
    }
    // 实例化插件类
    new My_Advanced_Plugin();
}

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

Обеспечение безопасности и производительности плагинов

Безопасность является главным приоритетом при разработке плагинов. Никогда не доверяйте вводимым пользователями данным. Что касается всех данных, поступающих от пользователей…$_GET、$_POSTили$_REQUESTПолученные данные необходимо проверить (validation), очистить (sanitization) и обработать с точки зрения безопасности (escaping). WordPress предоставляет ряд вспомогательных функций для этой цели.
* 验证：check_ajax_referer()， wp_verify_nonce()
* 清理：sanitize_text_field()， sanitize_email()， absint()
* 转义：esc_html()， esc_url()， wp_kses_post()

Перед выводом любых данных в HTML, атрибуты или URL обязательно используйте соответствующие функции экранирования (эскапирования). Что касается производительности, разумно применяйте специальные механизмы («хаки»), чтобы избежать выполнения ресурсоемких запросов при каждом загрузке страницы. Рассмотрите возможность использования API для временного хранения данных в WordPress (Transients API) для сохранения некритически важных, повторяемых результатов запросов на определенный период времени.

Реализация страницы настройок плагина

Большинство плагинов требуют наличия страницы настроек, предназначенной для пользовательской настройки. Обычно это реализуется с помощью…add_options_page()илиadd_menu_page()Функции типа “ожидания” (waiting functions) могут быть монтированы (mounted) на определенные объекты или системные компоненты.admin_menuДля реализации необходимо использовать соответствующие “хаки” (специальные механизмы программирования). Настройки должны регистрироваться, сохраняться и проверяться с использованием API настроек WordPress для обеспечения безопасности. Это подразумевает применение стандартных методов обработки данных и проверки пользовательских вводов.register_setting()、add_settings_section()иadd_settings_field()Такой подход не только обеспечивает безопасность (например, проверку случайных чисел – nonce-значений), но и позволяет согласовать стиль интерфейса веб-панели WordPress.

резюме

Разработка плагинов для WordPress – это процесс превращения идей в функциональные решения, который начинается с понимания основной структуры плагинов и настройки локальной среды разработки. Создав самый простой плагин вида “Hello World”, мы освоили весь процесс от создания файлов до активации его функций. Суть разработки заключается в глубоком понимании и гибком использовании мощной системы хуков WordPress – действий (actions) и фильтров (filters), которые служат инструментами для взаимодействия с ядром WordPress и другими его компонентами. По мере расширения функционала плагина важными шагами становятся применение объектно-ориентированного программирования, соблюдение стандартов безопасного кодирования (проверка входных данных, очистка данных, их экранирование), а также использование API для создания страниц настроек. Следуя этим рекомендациям и лучшим практикам, вы сможете с уверенностью создавать качественные плагины для WordPress – от простых инструментов до сложных приложений.

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

Какие знания необходимы для разработки плагина для WordPress под названием ###?
Вам потребуются базовые знания языка программирования PHP, поскольку плагины в основном написаны на этом языке. Также полезно иметь представление об HTML, CSS и JavaScript, чтобы создавать плагины с интерактивным пользовательским интерфейсом. Самое важное – хорошо ознакомиться с основными концепциями WordPress: статьи, страницы, категории, роли пользователей, а также с системой хуков (hooks).

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

Настоятельно рекомендуется включить эту функцию в среде разработки.WP_DEBUGРасписание работы системы и соответствующие настройки были описаны в разделе, посвящённом настройке основной среды работы приложения. Благодаря этим настройкам ошибки, предупреждения и уведомления PHP будут записываться в файлы журнала (логи). Кроме того, вы можете использовать…error_log()Функции или вспомогательные функции (helper functions)…var_dump()Сотрудничествоwp_die()Необходимо вывести значения переменных для их проверки. Консоль (Console) и вкладка Сеть (Network) в инструментах разработчика браузера также играют ключевую роль при отладке JavaScript-кода и AJAX-запросов.

Как мой плагин совместим с различными версиями WordPress?

В коде плагина следует проверять, существуют ли определённые функции или классы в текущей версии WordPress, прежде чем их использовать. Для этого можно воспользоваться соответствующими проверочными механизмами.function_exists()илиis_admin()Для выполнения условных проверок используются определенные механизмы. В описании плагина эти механизмы могут быть указаны в виде комментариев, размещенных в заголовочном файле плагина.Requires at least:Необходимо указать минимальную версию WordPress, требуемую для использования данного поля. Регулярное тестирование совместимости вашего плагина с последними обновлениями основной версии WordPress является хорошей практикой.

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

Вам необходимо использовать функции перевода WordPress для обработки всех текстовых строк, которые требуют перевода. Например, можно воспользоваться следующими методами:__( ‘文本’, ‘your-plugin-text-domain’ )Выведите переведенный текст, используя_e( ‘文本’, ‘your-plugin-text-domain’ )Для прямого отображения результата необходимо правильно настроить параметры в комментариях, расположенных в начале файла плагина.Text DomainиDomain PathЗатем используйте такой инструмент, как Poedit, для создания нужного результата..potШаблонные файлы, на основе которых переводчики могут создавать свои переводы..poи.moЯзыковой файл.

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

Во-первых, вам необходимо зарегистрировать учетную запись на официальном сайте WordPress и отправить ваш плагин на проверку. Ваш код должен соответствовать официальным стандартам и рекомендациям по кодированию, включая требования к безопасности, отсутствию вредоносного кода и совместимости с лицензией GPL. Структура каталога вашего плагина должна включать основной PHP-файл, а также другие необходимые файлы.readme.txtФайл (формат соответствует определённым стандартам), а также при необходимости — скриншоты и иконки. Процесс проверки может занять некоторое время; команда изучит ваш код и убедится, что он соответствует всем требованиям.