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

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

Прежде чем приступать к написанию кода, крайне важно понимать основные концепции WordPress-плагинов. WordPress-плагин по сути представляет собой набор одного или нескольких PHP-файлов, который использует различные возможности, предоставляемые системой WordPress, для расширения её функционала.APIиHookПлагины позволяют расширять или изменять основные функции WordPress. Они могут быть довольно простыми — например, предназначенными лишь для добавления специальных кодов (шорткодов) — или сложными, включающими в себя функционал полноценной электронной коммерческой платформы. Все плагины хранятся в определенном месте (обычно в/wp-content/plugins/Внутри каталога каждый плагин находится в своей отдельной папке.

Суть разработки плагинов заключается в понимании принципов работы системы WordPress.动作钩子и过滤器钩子。动作钩子Это позволяет выполнять пользовательский PHP-код в определенные моменты времени — например, при загрузке страницы или при публикации статьи.过滤器钩子Это позволяет вам изменять различные данные, генерируемые WordPress во время его работы (например, содержимое статей, их заголовки, аннотации). Умение эффективно использовать эти хаки („hooks“) является ключевым моментом при разработке плагинов.

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

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

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

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

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

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

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

Инициализация каталога плагинов и главного файла

Во-первых, вам необходимо настроить локальную среду разработки или тестовый сайт. /wp-content/plugins/ Создайте новую папку в каталоге. Назовём её… my-first-pluginЗатем внутри этой папки создайте основной PHP-файл. Обычно его называют в соответствии с названием плагина; в данном случае мы создадим такой файл. my-first-plugin.php。

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

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

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

Далее мы добавим к нему первую функцию. Для этого мы используем… add_action() Функция позволяет подключить пользовательскую функцию к одному из действий (actions) в WordPress. Под комментарием в начале файла добавьте следующий код:

// 在仪表盘顶部添加欢迎信息
function my_first_plugin_admin_notice() {
    echo '<div class="notice notice-success is-dismissible"><p>Добро пожаловать к использованию вашего первого плагина! Это успешный старт на пути разработки программного обеспечения.</p></div>';
}
add_action( 'admin_notices', 'my_first_plugin_admin_notice' );

Здесь мы создали объект с именем… my_first_plugin_admin_notice Функция предназначена для вывода блока HTML-кода, используемого для отображения уведомлений в стиле веб-сервера WordPress. Затем мы используем этот код для реализации необходимой функциональности. add_action( ‘admin_notices’, ‘my_first_plugin_admin_notice’ ) Подключите эту функцию (монтируйте её)… admin_notices Эта функция привязана к определенному событию в системе WordPress. Это означает, что каждый раз, когда WordPress готовит к отображению уведомления для администраторов в фоновом режиме, наша функция будет автоматически выполняться.

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

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

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

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

Добавьте страницу настроек для плагина.

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

Создать пункт меню "Администрирование".

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

// 添加插件设置页面到后台菜单
function my_first_plugin_add_menu() {
    add_menu_page(
        ‘我的第一个插件设置’， // 页面标题
        ‘第一个插件’，         // 菜单标题
        ‘manage_options’，     // 权限 (manage_options 表示管理员权限)
        ‘my-first-plugin-settings’， // 菜单 slug
        ‘my_first_plugin_settings_page’， // 用于显示页面内容的回调函数
        ‘dashicons-smiley’，   // 菜单图标 (Dashicons)
        100                    // 菜单位置
    );
}
add_action( ‘admin_menu’， ‘my_first_plugin_add_menu’ );

add_menu_page() Эта функция является встроенной функцией ядра WordPress и используется для добавления главного меню в бэкенде. Мы задали заголовок страницы, текст, который будет отображаться в меню, а также права доступа (здесь установлено, что доступ возможен только для администратора). manage_optionsуникальныйslugА также имена функций-обратных вызовов (callback functions), используемых для вывода содержимого страницы. my_first_plugin_settings_page。

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

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

Далее нам необходимо определить… my_first_plugin_settings_page Функция предназначена для отображения HTML-контента страницы настройок и обработки логики сохранения формы. Она создает простую форму, данные из которой будут переданы через систему WordPress. options С использованием API выполняются операции сохранения и чтения данных.

// 设置页面的内容
function my_first_plugin_settings_page() {
    // 检查用户权限
    if ( !current_user_can( ‘manage_options’ ) ) {
        wp_die( __( ‘你没有权限访问此页面。’ ) );
    }

// 保存表单数据
    if ( isset( $_POST[‘my_first_plugin_message’] ) ) {
        update_option( ‘my_first_plugin_custom_message’， sanitize_text_field( $_POST[‘my_first_plugin_message’] ) );
        echo ‘<div class="“notice" notice-success is-dismissible”><p>Настройки сохранены!</p></div>’;
    }

// 获取已保存的消息
    $saved_message = get_option( ‘my_first_plugin_custom_message’， ‘这是一个通过设置页面定制的欢迎消息！’ );

// 输出表单 HTML
    ?&gt;
    <div class="“wrap”">
        <h1>Настройки моего первого плагина</h1>
        <form method="“post”" action="/ru/“”/" data-trp-original-action="“”">
            <table class="“form-table”">
                <tr>
                    <th scope="“row”"><label for="“custom_message”">Пользовательские приветственные сообщения</label></th>
                    <td>
                        <input type="“text”" id="“custom_message”" name="“my_first_plugin_message”" value="”NO NUMERIC NOISE KEY" 1001” class="“regular-text”" />
                        <p class="“description”">Введите текст, который вы хотите отобразить в уведомлениях на панели инструментов.</p>
                    </td>
                </tr>
            </table>
            <?php submit_button( ‘保存更改’ ); ?>
        <input type="hidden" name="trp-form-language" value="ru"/></form>
    </div>
    &lt;?php
}

В этой функции мы сначала проверяем права пользователя. Затем мы проверяем, был ли отправлен запрос типа POST (то есть пользователь нажал кнопку сохранения). Если да, то мы используем… update_option() Функция сохраняет сообщения, введенные в форму, в базу данных WordPress. options В таблице базы данных… и используется. sanitize_text_field() Производится безопасная фильтрация данных. Затем мы используем… get_option() Читаем значение, сохраненное ранее; если его нет, используем значение по умолчанию. В конце выводим HTML-форму с входным полем.

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

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

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

Измените функцию уведомлений так, чтобы она использовала пользовательские сообщения.

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

// 修改后的通知函数
function my_first_plugin_admin_notice() {
    // 从数据库获取自定义消息
    $custom_message = get_option( ‘my_first_plugin_custom_message’， ‘欢迎使用“我的第一个插件”！这是一个成功的开始。’ );
    echo ‘<div class="“notice" notice-success is-dismissible”><p>’ . esc_html( $custom_message ) . ‘</p></div>’;
}

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

Лучшие практики разработки плагинов и продвинутые техники

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

Обеспечение безопасности кода и очистка данных

Безопасность является главным приоритетом при разработке плагинов. Никогда не доверяйте данным, вводимым пользователями, или данным из внешних источников. WordPress предоставляет множество функций, которые помогают очистить, обработать (эскапировать) и проверить данные.
* 净化输入：使用函数如 sanitize_text_field()、sanitize_email()、sanitize_url() Обрабатываем данные, переданные при отправке формы.
* 转义输出：在将任何数据输出到 HTML、JavaScript 或 URL 时，必须进行转义。使用 esc_html()、esc_attr()、esc_url() и wp_kses_post() Такие функции…
* 权限检查：在进行任何管理操作之前，务必使用 current_user_can() Проверьте, имеет ли текущий пользователь необходимые права. current_user_can( ‘manage_options’ )。
* Nonce验证：对于涉及数据更改的操作（如表单提交、AJAX请求），使用 wp_nonce_field()、wp_verify_nonce() Для предотвращения атак типа «фальшивых запросов между сайтами» (Cross-Site Request Forgery, CSRF) мы можем улучшить формы настроек, созданные ранее, добавив проверку с помощью токена nonce (нонс). Это повысит уровень безопасности системы.

Реализация интернационализации плагина

Чтобы ваш плагин мог использоваться пользователями по всему миру, интернационализация является неотъемлемым шагом. Для этого необходимо подготовить переводы всех текстовых строк, предназначенных для пользователей.
1. Использование текстового поля: определите это в комментариях, расположенных в начале плагина. Text Domain(Например, my-first-plugin), и использовать это во всех строках, которые необходимо перевести. __(‘文本’， ‘my-first-plugin’) или _e(‘文本’， ‘my-first-plugin’) Функциональные оболочки (function wrappers).
2. Создание файла с переводом: Используйте такие инструменты, как Poedit, чтобы сканировать все переводимые строки в плагине и сгенерировать файл с результатами перевода. .pot Шаблонные файлы, затем их перевод на различные языки. .po и .mo Документ.
3. Загрузка текстового поля: используется при инициализации плагина. load_plugin_textdomain() Функция загружает ваш файл с переводами.

Управление жизненным циклом плагинов

Профессиональный плагин должен правильно обрабатывать события активации, деактивации и удаления. Для этого можно создать соответствующие хук-функции.
* 激活钩子：使用 register_activation_hook() Необходимо зарегистрировать функцию, которая будет выполняться при активации плагина. Обычно такие функции используются для создания таблиц в базе данных, инициализации параметров по умолчанию или проверки совместимости среды.
* 停用钩子：使用 register_deactivation_hook()Обычно используется для удаления временных данных или остановки запланированных задач.
* 卸载钩子：使用 register_uninstall_hook()Внимание: этот хук предназначен для выполнения при полном удалении плагина из системы WordPress с целью очистки всех созданных плагином записей в базе данных, пользовательских таблиц и файлов. Действия следует проводить осторожно, и пользователей необходимо предварительно проинформировать об этом.

резюме

В этой статье вы познакомились с основными этапами разработки плагинов для WordPress, начиная с нуля. Сначала вы узнали о базовых концепциях плагинов, в частности о роли действий (actions) и фильтров (filters). Затем вы сами создали шаблон плагина, включающий папку, основной файл и стандартные элементы кода (например, заголовочный файл). add_action() Функции и admin_notices Хук реализовал первую функцию отображения информации. Затем, добавив страницу настроек для плагина, вы узнали, как им пользоваться. add_menu_page() Создание меню в бэкенде и способы его использования update_option() и get_option() Мы выполнили операции добавления, удаления, изменения и поиска данных. В заключение рассмотрели такие важные аспекты профессионального разработчика, как безопасное кодирование, интернационализация и управление жизненным циклом плагинов. Следуя этим шагам и принципам, вы сможете самостоятельно создавать простые, удобные в использовании и безопасные плагины для WordPress, а затем постепенно разрабатывать более сложные функции.

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

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

Вам необходимо овладеть основами грамматики языка PHP, поскольку код плагинов в основном написан на этом языке. Кроме того, вам следует иметь представление об HTML, CSS и базовых возможностях JavaScript для создания пользовательского интерфейса и обеспечения его взаимодействия с пользователем. Самое важное – хорошо знать архитектуру WordPress, особенно её основные принципы работы.HookСистема (действия и фильтры)选项API、数据库APIслишкомREST APIТакже крайне важно знать стандарты кодирования и наилучшие практики обеспечения безопасности в WordPress.

Как отладить и тестировать мой плагин?

Существует множество способов отладки при разработке плагинов для WordPress. Во-первых, вам следует… wp-config.php Файл открыт в приложении WP_DEBUG и WP_DEBUG_LOG Константа, которая используется для записи ошибок и предупреждений PHP в определенный файл. /wp-content/debug.log В файле будет удобнее выявлять ошибки. Кроме того, для кода с сложной логикой можно использовать… error_log() Функция выводит значения переменных в логи. Кроме того, рекомендуется выполнять разработку в локальной среде (например, Local by Flywheel, XAMPP) или на временных тестовых сайтах, чтобы не влиять на производственный сайт. Использование системы управления версиями кода (например, Git) также является хорошей практикой.

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

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

Как распространить мой плагин после его разработки?

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