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

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

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

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

Создание вашего первого плагина: основная структура

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

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

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

Основной файл плагина является точкой входа в его функционал. Вам необходимо добавить в начало этого файла блок комментариев с стандартной информацией о плагине. Вот пример самого базового кода:

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

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

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

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

Сохраните этот код в файл с расширением `.php` и поместите его в соответствующий каталог на вашем сервере. /wp-content/plugins/ Новая папка в каталоге (например…) my-first-pluginПосле этого вы сможете увидеть этот плагин на странице “Плагины” в области управления WordPress и активировать его. Хотя на данный момент плагин не содержит никаких функций, он уже считается легальным плагином, признанным системой WordPress.

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

По мере увеличения количества функций плагинов разумная структура каталогов становится крайне важной для организации кода. Типичный каталог плагина может включать следующие разделы:
Главный файл плагина (например, my-first-plugin.phpНаходится в корневом каталоге плагина и содержит информацию о заголовках плагина.
- includes/ Каталог: содержит файлы с классами, реализующими основные функции, а также файлы с отдельными функциями.
- admin/ Каталог: содержит код, связанный с интерфейсом административного управления.
- public/ Каталог: содержит код, связанный с логикой пользовательского интерфейса (фронтенда).
- assets/ Каталог: содержит файлы с CSS-шаблонами, JavaScript-скриптами, изображениями и другими ресурсами.
- languages/ Каталог: размещение файлов с международными переводами (.po/.mo).

Такая модульная структура делает код более понятным и удобным для совместной работы и обслуживания командой.

Основные концепции разработки: хендлеры (hooks) и фильтры (filters)

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

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

Использование действий-хуков для выполнения пользовательского кода

Акционные хаки (action hooks) позволяют вам выполнять определенные действия в определенные моменты процесса работы WordPress: например, отправлять уведомления после публикации статьи или добавлять код в верхнюю часть страницы. Используйте их с умом! add_action() Функции позволяют подключать ваши собственные пользовательские функции к определённым механизмам обработки действий (акционным хукам – action hooks).

Например, давайте создадим функцию, которая выводит пользовательские сообщения в нижней части страницы веб-сайта. Сначала вам необходимо определить функцию-обратный вызов (callback function), а затем использовать её для отображения нужной информации. add_action() Привяжите его к… wp_footer Этот крючок.

// 定义一个回调函数
function myplugin_add_footer_text() {
    echo '<p style="text-align:center;">Спасибо за использование этого плагина!</p>';
}
// 将函数挂载到 `wp_footer` 动作钩子
add_action( 'wp_footer', 'myplugin_add_footer_text' );

Когда WordPress обрабатывает раздел подвала (footer) страницы, соответствующие функции автоматически вызываются. myplugin_add_footer_text() Функция выводит текст, который мы определили.

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

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

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

Использование хуков фильтров для изменения данных

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

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

// 定义一个回调函数，它接收原始标题作为参数
function myplugin_add_trademark_to_title( $title ) {
    // 仅在前端文章列表和单篇文章页面修改，避免影响后台
    if ( ! is_admin() ) {
        $title .= ' ™';
    }
    // 必须返回修改后的值
    return $title;
}
// 将函数挂载到 `the_title` 过滤器钩子
add_filter( 'the_title', 'myplugin_add_trademark_to_title' );

В этом примере…$title Параметром является исходный текст заголовка; после его обработки функция должна возвращать новое значение. В этом и заключается ключевое отличие между фильтрами и действиями: фильтры обязательно должны возвращать результат своей работы.

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

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

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

Создать пункт меню для настройки плагина

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

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

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

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

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

\n// Добавление подменю в меню “Настройки” в административной панели
function myplugin_add_settings_page() {
    add_options_page(
        'Настройки моего плагина', // Название страницy
        'Мой плагин', // Название меню
        'manage_options', // Требуемые права (только администраторы могут получить доступ)
        'myplugin-settings', // Ссылка на меню
        'myplugin_render_settings_page' // Функция обратного вызова для отображения содержания страницы
    );
}
// Использование хука `admin_menu` для выполнения вышеуказанной функции при инициализации меню в административной панели
add_action( 'admin_menu', 'myplugin_add_settings_page' );

// Определение функции обратного вызова для отображения страницы настроек
function myplugin_render_settings_page() {
    ?>
    <div class="wrap">
        <h1>Настройки моего плагина.</h1>
        <form action="/ru/options.php/" method="post" data-trp-original-action="options.php">
            <p><strong>Это пример PHP-кода, который выводит на экран список настроек плагина.</strong></p>
        <input type="hidden" name="trp-form-language" value="ru"/></form>
    </div>
    &lt;?php
}

Используйте API настроек для регистрации параметров.

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

Вам необходимо использовать… register_setting(), add_settings_section() и add_settings_field() Используйте такие функции, как `define`, чтобы задать свои настройки.

// 在插件初始化时注册设置
function myplugin_register_settings() {
    // 1. 注册一个设置组及其数据
    register_setting(
        'myplugin_settings_group', // 设置组名称，需与 settings_fields() 参数一致
        'myplugin_option_name' // 存储在数据库中的选项名
    );

// 2. 添加一个设置区域（Section）
    add_settings_section(
        'myplugin_section_main', // Section ID
        '主要设置', // 标题
        null, // 可选的描述回调函数
        'myplugin-settings' // 所属的页面slug
    );

// 3. 向该区域添加一个设置字段
    add_settings_field(
        'myplugin_field_text', // 字段ID
        '示例文本输入', // 字段标签
        'myplugin_render_text_field', // 渲染字段HTML的回调函数
        'myplugin-settings', // 页面slug
        'myplugin_section_main' // Section ID
    );
}
add_action( 'admin_init', 'myplugin_register_settings' );

// 渲染文本输入字段的回调函数
function myplugin_render_text_field() {
    $option = get_option( 'myplugin_option_name' );
    $value = isset( $option['text'] ) ? $option['text'] : '';
    echo '<input type="text" name="myplugin_option_name[text]" value="' . esc_attr( $value ) . '" />';
}

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

резюме

Разработка плагинов для WordPress – это процесс превращения идей в функциональные решения, основой которого является понимание и умелое использование системы хуков (hooks). Начиная с создания простого файла плагина, вы постепенно учитеся добавлять новые функции с помощью хуков действий (action hooks), изменять данные с использованием хуков фильтров (filter hooks), а затем создаете управляемые страницы и используете API настроек для создания профессиональных плагинов с высокой удобством использования. Соблюдение стандартов кодирования WordPress, модульность кода и обеспечение безопасности являются ключевыми принципами разработки качественных плагинов. Практикуя вышеописанные шаги, вы сможете создавать мощные и надежные пользовательские функции для любого сайта на базе WordPress.

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

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

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

Как отладить мой плагин для WordPress?

Прежде всего, убедитесь, что в wp-config.php Файл открыт в приложении WP_DEBUG и WP_DEBUG_LOGЭто приведет к тому, что ошибки и предупреждения PHP будут записываться в соответствующие файлы журнала. /wp-content/debug.log Файлы должны храниться внутри системы, а не отображаться непосредственно на странице, чтобы не влиять на пользовательский опыт. Кроме того, для улучшения пользовательского интерфейса можно использовать различные методы отображения информации. error_log() Функция выводит пользовательские сведения о дебагировании в лог-файл. Для сложных логических операций наиболее эффективным способом является использование функций отладки, предоставляемых интегрированными средами разработки (IDE), таких как Xdebug.

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

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

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

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