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

Подготовительные работы перед разработкой плагина для WordPress

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

Во-первых, вам понадобится локальная среда разработки. Рекомендуется использовать такие инструменты, как Local by Flywheel, MAMP, XAMPP или Docker, чтобы быстро настроить среду для работы с WordPress, включающую PHP, MySQL, Apache или Nginx. Убедитесь, что версия PHP соответствует последним требованиям официального сайта WordPress — обычно требуется PHP 7.4 или более поздняя версия.

Во-вторых, четко определите, какую проблему должен решать ваш плагин. Должен ли он добавлять какую-то конкретную функцию на веб-сайт или оптимизировать существующий процесс? Четкое описание плагина и список его функций служат основой для дальнейшей разработки. Рекомендуется использовать инструменты вроде Trello или простые документы для планирования этапов разработки и функциональных требований.

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

В конце концов, вам понадобится кодовый редактор или интегрированная среда разработки. Visual Studio Code, PhpStorm и Sublime Text — отличные варианты, которые обеспечивают хорошую поддержку разработки на PHP и в WordPress, включая выделение синтаксиса, предложения по написанию кода и функции отладки. Как только всё будет готово, вы сможете создать основной файл вашего плагина.

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

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

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

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

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

Создайте новую папку, название которой должно быть уникальным и описывать функции плагина. Например:my-first-pluginВ этой папке создайте основной файл плагина; его обычно называют…plugin-name.phpНужно дать этому файлу имя. Этот файл является точкой входа для работы плагина; WordPress идентифицирует плагин, считывая определенные комментарии, находящиеся в его начале.

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

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

В этом комментарии поле “Plugin Name” является обязательным для заполнения; остальная информация предоставляется по желанию. Однако мы настоятельно рекомендуем ввести все необходимые данные. После этого загрузите папку с плагином в каталог, где установлен WordPress./wp-content/plugins/Путь к файлу плагина уже указан. Зайдите в меню “Плагины” в области управления WordPress, и там вы увидите свой плагин; вы сможете его активировать. На данный момент у плагина ещё нет никаких функций, но вы успешно создали плагин, признанный системой WordPress.

Рекомендуемое чтение Разработка плагинов для WordPress — это процесс, начинающийся с нуля и заканчивающийся созданием одного из самых популярных в мире инструментов управления контентом.。

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

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

Во-первых, нам нужно создать функцию, которая будет реализовывать логику добавления текста об авторских правах. Назовём эту функцию…myplugin_add_footer_text。

function myplugin_add_footer_text($content) {
    // 确保只在网站前端的主文章循环中执行
    if (is_single() && in_the_loop() && is_main_query()) {
        $footer_text = '<p><em>Эта статья представлена вам моим первым плагином.</em></p>';
        $content .= $footer_text;
    }
    return $content;
}

Далее нам необходимо “присоединить” эту функцию к определенному моменту выполнения в WordPress; этот процесс называется “добавлением хука” (hook). Для этого мы используем…the_contentФильтр-хук. Добавьте следующий код в основной файл вашего плагина:

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

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

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

add_filter('the_content', 'myplugin_add_footer_text');

После сохранения файла обновите страницу статьи на вашем сайте, и вы увидите, что в конце текста появились тексты, относящиеся к авторским правам (которые вы сами определили). Благодаря этому простому примеру вы уже освоили основные принципы разработки плагинов: создание функций и их использование.add_actionилиadd_filterХаки (hooks) позволяют интегрировать функции в жизненный цикл WordPress.

В глубину сути: хаки (hooks) и API в WordPress

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

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

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

Создайте функцию-хендлер действия (action hook function):

function myplugin_log_post_published($ID, $post) {
    // 当文章发布时，在错误日志中记录一条信息（仅用于演示）
    error_log("文章 {$post->post_title} (ID: {$ID}) 已发布。");
}
// 将函数挂载到 `publish_post` 这个动作钩子上
add_action('publish_post', 'myplugin_log_post_published', 10, 2);

Создайте функцию-хук для фильтра:

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

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

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

function myplugin_excerpt_length($length) {
    // 将默认的摘要长度从55个词修改为20个词
    return 20;
}
// 将函数挂载到 `excerpt_length` 这个过滤器钩子上
add_filter('excerpt_length', 'myplugin_excerpt_length');

Когда используется…add_actionилиadd_filterПри использовании нескольких обратных вызовов (callback functions) третий и четвертый параметры соответственно определяют их приоритет и количество. Правильное настройство этих параметров позволяет точно контролировать порядок выполнения обратных вызовов.

Использование API в настройках WordPress

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

Создайте функцию для формирования страницы с опциями:

function myplugin_settings_page() {
    add_options_page(
        '我的插件设置', // 页面标题
        '我的插件',     // 菜单标题
        'manage_options', // 权限
        'myplugin-settings', // 菜单 Slug
        'myplugin_render_settings_page' // 用于输出页面内容的回调函数
    );
}
add_action('admin_menu', 'myplugin_settings_page');

Затем вам необходимо реализовать это.myplugin_render_settings_pageФункция предназначена для отображения формы и её использования.settings_fieldsиdo_settings_sectionsФункция предназначена для вывода полей формы, автоматически обрабатываемых через API WordPress.get_optionВ функциях вы можете легко получить значения пользовательских настроек, сохраненные пользователем, в любом месте кода плагина.

Продвинутые практики разработки плагинов и их публикация

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

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

Безопасность является основополагающим принципом при разработке плагинов. Все данные, получаемые от пользователей (например…$_GET， $_POST， $_COOKIEВсе элементы должны проходить проверку и дезинфекцию. WordPress предоставляет множество функций для этой цели.sanitize_text_field， wp_kses_post， intvalПри выводе любых данных в браузер или базу данных необходимо также выполнить их экранирование (эскапирование). Для этого используются специальные символы, которые позволяют предотвратить неправильное интерпретирование данных.esc_html， esc_attrилиwp_ksesДля работы с базой данных необходимо использовать функции, предоставляемые WordPress.$wpdbКлассы и их…prepareСпособы предотвращения взломов с использованием SQL-инъекций.

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

Чтобы ваш плагин мог использоваться пользователями по всему миру, интернационализация является неотъемлемым шагом. Этот процесс включает в себя два основных этапа:__()или_e()Функции, такие как `wait`, обертывают все строки, которые необходимо перевести, а также обеспечивают правильное загрузочное поведение текстовых полей.

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

function myplugin_load_textdomain() {
    load_plugin_textdomain('my-first-plugin', false, dirname(plugin_basename(__FILE__)) . '/languages/');
}
add_action('init', 'myplugin_load_textdomain');

После этого вы сможете использовать что-то похожее на…__('Hello World', 'my-first-plugin')Для обозначения строк используется определенный способ написания символов. Переводчики могут использовать такие инструменты, как Poedit, чтобы работать с генерируемыми данными..potСоздание шаблонных файлов.poи.moПереведите файл и разместите его в папке плагина./languages/Внутри каталога.

В конце концов, когда функционал плагина станет стабильным, вы сможете решить представить его в официальный каталог плагинов WordPress, чтобы его могли использовать больше пользователей. Для этого вам потребуется собрать код плагина в единый файл и написать подробное описание его работы.readme.txtФайл должен соответствовать установленным стандартам разработки сообщества.

резюме

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

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

Для разработки плагинов для WordPress необходимо владеть следующими языками программирования:
Для разработки плагинов для WordPress необходимо владеть языком PHP, поскольку сама основа WordPress написана на этом языке. Фронтенд-часть плагинов обычно включает в себя использование HTML, CSS и JavaScript. Для взаимодействия с базой данных также полезны базовые знания SQL-языка.$wpdbКласс обеспечивает инкапсуляцию большинства операций.

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

На этапе разработки рекомендуется включить режим отладки в WordPress.wp-config.phpВ документе будет указано, что...WP_DEBUGКонстанта установлена наtrueВы также можете использовать…error_log()Функция записывает информацию в ошибочный журнал сервера. Для более сложной отладки можно использовать такие профессиональные инструменты, как Xdebug или Query Monitor, которые позволяют отслеживать выполнение кода и операции с базой данных.

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

Плагины могут использовать HTTP-API WordPress для своей работы (например, для обмена данными с системой или выполнения определенных действий).wp_remote_get()， wp_remote_post()Обеспечивается безопасное и стабильное взаимодействие с внешними сервисами. HTTP-API WordPress включает в себя механизмы обработки истечения срока выполнения запросов, проверки подлинности данных по протоколу SSL и другие функции, что делает его более надежным по сравнению с прямым использованием функций PHP, таких как curl или file_get_contents. При обработке ответов необходимо обязательно проверять возникающие ошибки и применять соответствующие меры их устранения.

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

Хотя таблица настроек WordPress вполне подходит для хранения большинства конфигурационных данных, структурированные данные, вероятно, лучше всего сохранять в пользовательских таблицах. Вы можете использовать хук активации плагина для этой цели.register_activation_hookВ процессе регистрации функций выполняется SQL-запрос для создания таблицы. Это обязательно необходимо сделать.$wpdb->prefixУбедитесь, что префикс таблицы правильный, и используйте его.dbDeltaСуществуют функции, позволяющие безопасно создавать или обновлять структуру таблиц. Любые запросы к пользовательским таблицам должны выполняться через эти функции.$wpdbДействия выполняются над объектом.

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

Лучшие практики для обеспечения совместимости включают в себя: использование основного API WordPress и стандартных хуков; добавление уникальных префиксов (например, с использованием сокращений плагинов) к функциям, классам и именам опций; объединение функций в классы или пространства имён, чтобы избежать конфликтов с именами; избегание прямого изменения глобальных переменных; а также проверка наличия существующих элементов перед выполнением действий, которые могут повлиять на глобальное состояние (например, регистрация коротких кодов, настройка типов записей). Перед публикацией необходимо как можно больше тестировать в различных средах.