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

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

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

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

Создание вашей среды разработки

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

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

Настройка локальной серверной среды

Рекомендуется использовать интегрированные решения для работы с локальными серверами, такие как Local by Flywheel, XAMPP или MAMP. С их помощью можно одним кликом установить Apache/Nginx, PHP и MySQL. Убедитесь, что версия PHP совместима с вашей целевой версией WordPress; обычно рекомендуется использовать PHP 7.4 или более новые версии. Кроме того, необходимо установить новую версию WordPress на локальном сервере для тестирования плагинов в условиях “песочницы” (исолированной среды).

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

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

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

Редактор кода и инструменты отладки

Выберите мощный кодовый редактор, такой как Visual Studio Code или PHPStorm. Эти редакторы обеспечивают выделение синтаксиса, предложения по редактированию кода и интеграцию с системами управления версиями. Для отладки необходимо включить режим отладки в WordPress. Для этого потребуется доступ к корневому каталогу WordPress. wp-config.php Файл, будет… WP_DEBUG Константа установлена на true。

define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true ); // 将错误日志保存到 /wp-content/debug.log
define( 'WP_DEBUG_DISPLAY', false ); // 不要在页面上显示错误

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

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

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

Структура основного файла плагина

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

Рекомендуемое чтение Руководство по пользовательскому развитию плагинов для WooCommerce: Создание собственного интернет-магазина。

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

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

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

Добавляем первую функцию: управление меню.

Далее давайте добавим к плагину простую функцию: создадим новый пункт меню в боковой панели административной панели WordPress.

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

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

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

Мы будем использовать… add_action() Функция предназначена для подключения (монтирования) обратного вызова (callback-функции) к другой функции. admin_menu Этот элемент (Action) находится на соответствующем “крючке” (hook).

// 在插件主文件中，插件头部注释块之后，添加以下代码

if ( ! defined( 'ABSPATH' ) ) {
    exit; // 禁止直接访问
}

// 钩子到 admin_menu 动作
add_action( 'admin_menu', 'mfp_add_admin_menu' );

/**
 * 注册一个自定义管理菜单
 */
function mfp_add_admin_menu() {
    add_menu_page(
        '我的第一个插件设置', // 页面标题
        '我的插件',          // 菜单标题
        'manage_options',    // 所需权限
        'my-first-plugin',   // 菜单别名 (slug)
        'mfp_display_admin_page', // 显示页面内容的回调函数
        'dashicons-smiley', // 菜单图标 (使用 Dashicon)
        6                    // 菜单位置
    );
}

/**
 * 管理页面的显示内容
 */
function mfp_display_admin_page() {
    ?>
    <div class="wrap">
        <h1></h1>
        <p>Здравствуйте, мир! Это моя первая страница управления плагинами для WordPress.</p>
    </div>
    &lt;?php
}

Сохраните файл и обновите интерфейс веб-сервера WordPress. В левой меню появится новый пункт под названием “Мои плагины” (My Plugins). Нажав на него, вы перейдете на простую страницу с приветственным сообщением.

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

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

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

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

Акционные хаки (action hooks) в WordPress активируются в определенные моменты выполнения сайта — например, при сохранении статьи, загрузке верхней части страницы или выводе нижней части страницы. Ваш плагин может “слушать” за этими моментами и выполнять свои собственные функции. Мы использовали именно такой подход в приведенном выше примере. admin_menu Это просто хук действия.

Еще один распространенный пример – автоматическое добавление фрагмента текста в конце статьи.

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

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

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

add_action( 'the_content', 'mfp_append_text_to_content' );

function mfp_append_text_to_content( $content ) {
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $append_text = '<p><em>Эта статья была сгенерирована моим первым плагином.</em></p>';
        $content .= $append_text;
    }
    return $content;
}

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

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

add_filter( 'the_title', 'mfp_modify_post_title' );

function mfp_modify_post_title( $title ) {
    // 只在非后台的主查询中修改
    if ( ! is_admin() && in_the_loop() ) {
        $title = '[重要] ' . $title;
    }
    return $title;
}

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

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

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

Проверка и эскапирование данных

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

// 输出到 HTML 内容中
echo esc_html( $untrusted_data );
// 输出到 HTML 属性中
echo esc_attr( $untrusted_data );
// 输出到 URL 中
echo esc_url( $untrusted_data );
// 在 JavaScript 变量中输出
$js_data = wp_json_encode( $untrusted_data );

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

Использование пространств имен и классов

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

<?php
namespace MyFirstPluginAdmin;

class Admin_Menu {
    public function __construct() {
        add_action( 'admin_menu', [ $this, 'add_menu_page' ] );
    }

public function add_menu_page() {
        add_menu_page( ... );
    }
}

// 初始化
new Admin_Menu();

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

резюме

Разработка плагинов для WordPress – это процесс, который можно освоить постепенно, начиная с создания базовых файлов, признаваемых системой WordPress, и заканчивая использованием мощных инструментов вроде действий (actions) и фильтров (filters) для расширения функционала. Каждый шаг этого процесса основан на понимании архитектуры WordPress. Локальная среда разработки служит вашей «лабораторией», инструменты отладки – вашими «микроскопами», а соблюдение правил безопасности и передовых практик является основой для обеспечения стабильности и надежности ваших плагинов.

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

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

Как минимум, какое количество файлов требуется для создания плагина для WordPress?

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

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

Существует два основных способа избежания конфликтов в названиях функций. Первый – это добавление уникального префикса ко всем вашим функциям; например, можно использовать аббревиатуры или сокращения, связанные с используемыми плагинами. mfp_ или myplugin_Во-вторых, используйте классы и пространства имен в PHP для инкапсуляции ваших функций в методах классов. Это более современный и рекомендуемый подход, который позволяет избежать конфликтов в именах на корневом уровне.

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

Для добавления страницы настроек для плагина обычно используется… add_options_page() или add_submenu_page() Для регистрации страниц используется соответствующая функция, а затем с помощью API настроек WordPress (Settings API) осуществляется безопасное создание, проверка и сохранение параметров. API настроек включает в себя необходимые инструменты и методы для работы с данными пользовательских настроек. register_setting()、add_settings_section() и add_settings_field() Функции подобного типа упрощают процесс создания форм с стандартизированными настройками и автоматически обеспечивают защиту данных, а также их хранение.

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

Чтобы опубликовать плагин в официальном каталоге WordPress.org, сначала необходимо зарегистрировать SVN-репозиторий для своего плагина на сайте WordPress.org. Далее следует убедиться, что код плагина соответствует официальным требованиям и стандартам: качество кода, безопасность, лицензия (обязательно должна быть совместима с лицензией GPL), наличие стандартного файла readme.txt и т. д. После этого используйте инструменты для работы с SVN, чтобы отправить свой код в указанный репозиторий. Команда WordPress проведет проверку, и если она будет успешной, ваш плагин появится в официальном каталоге, где пользователи смогут его скачать и установить.