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

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

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

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

Эффективная среда локального развития крайне важна. Рекомендуется использовать такие инструменты, как XAMPP, MAMP или Local by Flywheel, для быстрого создания локального сервера с поддержкой PHP, MySQL, Apache и Nginx. Эти инструменты позволяют имитировать условия работы онлайн-сервера, что облегчает процесс разработки и отладки без влияния на рабочий веб-сайт. Кроме того, важно выбрать мощный кодовый редактор, например Visual Studio Code или PhpStorm – они обеспечивают отличную поддержку синтаксиса, предложения по написанию кода и возможности отладки для языков PHP, HTML, JavaScript и CSS.

Понять базовую структуру плагина.

В сущности, WordPress-плагин представляет собой один или несколько модулей, расположенных в определенных частях кода движка WordPress. /wp-content/plugins/ PHP-файлы, находящиеся в каталоге. Каждому плагину необходим по меньшей мере один главный файл, имя которого обычно является уникальным. Например: my-first-plugin.phpВ заголовке этого основного файла содержится специальная комментария, называемая “информацией о головной части плагина”. WordPress использует эту информацию для идентификации и отображения вашего плагина в интерфейсе администрирования. Хорошая структура плагина предполагает размещение кода, выполняющего различные функции, в отдельных подкаталогах. /includes/ Предназначено для хранения файлов с основными классами./js/ и /css/ Предназначено для хранения ресурсов фронтенда./languages/ Используется для интернационализации файлов.

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

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

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

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

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

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

Напишите заголовок плагина.

В начале основного файла плагина обязательно должны быть стандартные заголовочные комментарии. Эти комментарии предоставляют WordPress метаданные о плагине, такие как его название, описание, версия, автор и т. д. Ниже приведен простейший пример:

<?php
/**
 * Plugin Name: 我的第一个插件
 * Plugin URI:  https://yourwebsite.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/my-first-plugin.php После входа в панель управления WordPress на странице “Плагины” вы увидите новый плагин под названием “Мой первый плагин” и сможете его активировать. В настоящее время у него нет никаких функций.

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

После активации плагина мы реализуем классическую функцию: автоматическое добавление пользовательского текста в конец каждой статьи. Для этого мы будем использовать… the_content Фильтры. Измените ваш основной файл и добавьте следующий код под информацией в заголовке:

/**
 * 在文章内容末尾添加自定义文本
 *
 * @param string $content 文章原始内容。
 * @return string 修改后的内容。
 */
function mfp_add_footer_text( $content ) {
    // 仅在主查询的单篇文章页面显示
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $custom_text = '<p><em>Спасибо за прочтение! Эту статью для вас подготовил [мой первый плагин].</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
// 将自定义函数挂载到 ‘the_content’ 过滤器
add_filter( 'the_content', 'mfp_add_footer_text' );

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

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

Разработка основных функций плагина

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

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

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

/**
 * 在后台管理菜单中添加一个顶级菜单项
 */
function mfp_add_admin_menu() {
    add_menu_page(
        '我的插件设置', // 页面标题
        '我的插件',     // 菜单标题
        'manage_options', // 权限要求
        'mfp-settings-page', // 菜单 slug
        'mfp_render_settings_page', // 用于渲染页面的回调函数
        'dashicons-admin-generic', // 图标（可选）
        80 // 菜单位置（可选）
    );
}
add_action( 'admin_menu', 'mfp_add_admin_menu' );

/**
 * 渲染设置页面的回调函数
 */
function mfp_render_settings_page() {
    ?>
    <div class="wrap">
        <h1></h1>
        <form action="/ru/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            // 输出安全隐藏字段
            settings_fields( 'mfp_settings_group' );
            // 输出设置区块
            do_settings_sections( 'mfp-settings-page' );
            // 输出保存按钮
            submit_button( '保存设置' );
            ?>
        <input type="hidden" name="trp-form-language" value="ru"/></form>
    </div>
    &lt;?php
}

Этот код используется… add_menu_page Функция добавила новый пункт меню и указала его параметры. mfp_render_settings_page Функция предназначена для генерации HTML-кода страницы. Для добавления на страницу формы с элементами, данные из которых можно сохранить, необходимо также использовать соответствующие инструменты или методы. register_setting, add_settings_section и add_settings_field Для регистрации и определения параметров настройки используются такие функции, как…

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

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

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

Организация кода с использованием объектно-ориентированного программирования

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

class MyFirstPlugin {
    /**
     * 构造方法，用于初始化钩子
     */
    public function __construct() {
        add_action( 'init', array( $this, 'init' ) );
        add_filter( 'the_content', array( $this, 'modify_content' ) );
    }

/**
     * ‘init’ 钩子的回调函数
     */
    public function init() {
        // 插件初始化代码，例如注册短代码、自定义文章类型等
        load_plugin_textdomain( 'my-first-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
    }

/**
     * 修改文章内容的回调函数
     */
    public function modify_content( $content ) {
        // 类内部实现功能逻辑
        if ( is_single() ) {
            $content .= '<p>Это содержимое было добавлено с помощью класс-метода.</p>';
        }
        return $content;
    }
}
// 实例化插件类
new MyFirstPlugin();

Путем инкапсулирования функций… MyFirstPlugin В классе все связанные атрибуты и методы находятся в одном и том же области видимости (сфере действия). array( $this, ‘method_name’ ) С помощью соответствующей синтаксиса класс-методы могут быть привязаны («монтированы») к определенным «хукам» (hook-функциям) в WordPress. Такой подход рекомендуется для создания средних и крупных плагинов.

Публикация и обслуживание плагинов

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

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

Безопасность и проверка данных.

Безопасность плагинов имеет первостепенное значение. Никогда не доверяйте данным, введенным пользователями, или данным, полученным непосредственно из базы данных. Перед обработкой любых данных необходимо их проверить, очистить и обработать специальными методами (например, с использованием символов эскапирования).
* 验证 (Validation)：检查数据是否符合预期格式（如是否为邮箱、数字）。可以使用 filter_var или WordPress sanitize_* Серия функций.
* 清理 (Sanitization)：在将数据存入数据库或用于输出前，移除其中不安全的字符。例如，使用 sanitize_text_field Обработка вводимого текста.
* 转义 (Escaping)：在将数据输出到 HTML、JavaScript 或 URL 时，必须根据上下文进行转义，以防止跨站脚本攻击。WordPress 提供了 esc_html, esc_js, esc_url и esc_attr Такие функции…

Например, при выводе переменной, полученной из базы данных:

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

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

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

// 假设 $user_input 是从数据库获取的文本
echo '<div class="message">'`. esc_html($user_input).`'</div>';
// 或者用于 HTML 属性
echo '<input type="text" value="' . esc_attr( $user_input ) . '">';

Оптимизация производительности и лучшие практики

Отличный плагин должен оказывать минимальное влияние на производительность веб-сайта. Следуйте следующим рекомендациям (бестпрактикам):
* 按需加载资源：使用 wp_enqueue_script и wp_enqueue_style Используйте функции для загрузки CSS- и JavaScript-файлов только на тех страницах, где они действительно необходимы. Так вы сможете сэкономить ресурсы и улучшить производительность сайта. wp_enqueue_scripts Хаки (фронтенд) и… admin_enqueue_scripts Хук (в бэкенде) используется для монтирования.
* 合理使用钩子：避免在每次页面加载时都执行大量不必要的代码。将你的函数挂载到最合适的钩子上，并利用条件标签（如 is_admin(), is_single()Используются специальные механизмы для ограничения области выполнения кода.
* 数据库查询优化：尽量减少直接 SQL 查询，优先使用 WordPress 的 API（如 WP_Query, get_postsЕсли необходимо выполнить пользовательский запрос, убедитесь, что используются соответствующие инструменты или методы для его формирования. $wpdb Класс должен обеспечивать эффективное кэширование результатов выполнения запросов.
* 提供卸载清理选项：考虑在用户删除插件时，是否需要清理插件创建的数据（如数据库表、选项等）。可以通过注册一个卸载钩子（在单独的文件中）来实现。

резюме

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

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

Для разработки плагинов WordPress необходимо хорошо владеть PHP?

Хотя не обязательно достигать уровня эксперта, прочные знания основ PHP являются крайне важными. Вам необходимо понимать синтаксис PHP, функции, массивы, концепции объектно-ориентированного программирования и т. д., поскольку ядро WordPress, а также его плагины и темы написаны на PHP. Знакомство с HTML, CSS и JavaScript также крайне важно для разработки плагинов, обладающих интерактивным пользовательским интерфейсом.

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

Во-первых, убедитесь, что у вас… wp-config.php В файле включен режим отладки WordPress. WP_DEBUG Константа установлена в значение `true`. Это обеспечивает отображение ошибок, предупреждений и уведомлений PHP на экране или их запись в файлы журнала (логов). Далее используйте… error_log Для отслеживания значений переменных и хода выполнения кода могут использоваться такие инструменты, как плагины типа Query Monitor. Развивающие инструменты браузера (вкладки Console и Network) также играют важную роль при отладке JavaScript-кода и AJAX-запросов.

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

Во время разработки необходимо регулярно ознакомляться с официальной документацией, чтобы быть в курсе того, какие функции были устаревшие или изменены в различных версиях программного обеспечения. Для обеспечения обратной совместимости следует использовать условную логику и проверки версий. Например, вы можете воспользоваться такими подходами: function_exists() Необходимо проверить, доступна ли определённая функция; если она недоступна, предложить альтернативное решение. Кроме того, в файле readme.txt плагина следует чётко указать диапазон версий WordPress, для которых были проведены тесты.

Как реализовать интернационализацию для моего плагина?

WordPress использует технологический стек GNU gettext для реализации функций интернационализации. Вам необходимо… __() или _e() Функции типа `str_replace` или подобные обрабатывают все строки, которые необходимо перевести. Затем с помощью инструментов для работы с файлами типа POT (например, Poedit) создается шаблон перевода, который позволяет переводчикам генерировать файлы с расширениями `.mo` и `.po` для нужного языка. В конце используются эти генерированные файлы для проведения самого процесса перевода. load_plugin_textdomain() Функция загружает языковые файлы при инициализации плагина.