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

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

Перед началом написания кода крайне важно создать стабильную и эффективную локальную среду разработки. Это позволит вам безопасно проводить тестирование и воссоздавать реальные условия работы сервера. Для разработки плагинов для WordPress мы настоятельно рекомендуем использовать программное обеспечение для локальных серверов, такое как XAMPP, MAMP или Local by Flywheel. Эти инструменты позволяют легко настроить на вашем компьютере среду, включающую в себя сервер Apache, PHP и базу данных MySQL.

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

Кроме того, рекомендуется инициализировать систему управления версиями (например, Git) в корневом каталоге вашего плагинного проекта.git initКоманда создает новый репозиторий, что облегчает отслеживание изменений в коде, восстановление ошибок и будущее сотрудничество в команде. Также рекомендуется включить режим отладки в WordPress.wp-config.phpВ документе будет указано, что...WP_DEBUGКонстанта установлена наtrueЭто позволит отображать ошибки и предупреждения PHP в процессе разработки, что поможет вам быстро выявить проблемы.

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

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

Стандартный плагин для WordPress имеет определенную структуру каталогов и файлов. Для начала перейдите в каталог, в котором установлен WordPress.wp-content/pluginsПапка. Создайте здесь новую папку для плагина, который вы собираетесь разработать. Название папки должно быть кратким, уникальным и отражать функции плагина. Например:my-first-plugin。

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

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

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

Подготовка основного файла плагина

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

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

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

Разработка функций плагинов и механизмов их инкапсуляции (классов)

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

if ( ! class_exists( 'My_First_Plugin' ) ) {
    class My_First_Plugin {
        public function __construct() {
            // 构造函数，用于初始化动作和过滤器
            add_action( 'init', array( $this, 'init' ) );
        }

public function init() {
            // 插件初始化时执行的操作
            // 例如：注册短代码、自定义文章类型等
        }
    }

// 实例化插件类
    new My_First_Plugin();
}

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

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

Реализация основных функций: действия и фильтры

Сила плагинов для WordPress заключается в их системе хуков (Hooks), включающей действия (Actions) и фильтры (Filters). Понимание и правильное использование этих механизмов является основой разработки плагинов.

Использование действий-хуков (action hooks) для добавления новых функций

Акционные хаки (action hooks) позволяют вставлять собственный код в определенные моменты выполнения WordPress. Например, если вы хотите автоматически добавлять текст после содержимого статьи, вы можете воспользоваться этими хаками.the_contentФильтр – это особый вид “действия”. Более типичными примерами действий могут служить:wp_footerИспользуется для добавления контента в нижней части страницы.

public function __construct() {
    add_action( 'wp_footer', array( $this, 'add_custom_footer_text' ) );
}

public function add_custom_footer_text() {
    echo '<p style="text-align: center;">Спасибо за прочтение! Этот текст был сгенерирован моим первым плагином.</p>';
}

В этом примере…add_custom_footer_textМетод будет вызываться в футере каждой страницы для отображения пользовательски определённого текста.

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

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

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

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

Фильтровые хаки (filter hooks) предназначены для изменения данных перед их отправкой в базу данных или браузер. Частым примером использования является изменение заголовка статьи. Мы можем воспользоваться этими хаками для выполнения необходимых операций с данными.the_titleФильтр.

public function __construct() {
    add_filter( 'the_title', array( $this, 'customize_title' ) );
}

public function customize_title( $title ) {
    // 只在主循环中且不是后台管理界面时修改
    if ( ! is_admin() && in_the_loop() ) {
        return '📖 ' . $title;
    }
    return $title;
}

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

Интернационализация плагинов и настройки

Для того чтобы плагин мог использоваться пользователями по всему миру, интернационализация (i18n) является неотъемлемым шагом. Кроме того, предоставление пользователю страницы настройок в бэкенде, позволяющей настроить поведение плагина, значительно повышает его профессиональный уровень.

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

Поддержка перевода текста

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

Во-первых, в заголовочном файле плагина основного файла мы уже все необходимое определили.Text DomainиDomain PathЗатем, в функции инициализации, загружается текстовое поле.

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

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

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

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

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

echo '<p style="text-align: center;">' . esc_html__( '感谢阅读！本内容由我的第一个插件生成。', 'my-first-plugin' ) . '</p>';

esc_html__()Функция переводит текст и выполняет HTML-эскапирование символов, обеспечивая тем самым его безопасность. Переводчики могут использовать эту функцию по своему усмотрению..poи.moФайлы необходимы для предоставления различных языковых версий вашего плагина.

Создать страницу настроек для бэкенда

Использование API настроек WordPress позволяет создать стандартную и безопасную страницу настроек для вашего плагина. Обычно это включает в себя несколько шагов: регистрацию настроек, добавление областей и полей настроек, а также создание страницы меню.

public function __construct() {
    add_action( 'admin_menu', array( $this, 'add_admin_menu' ) );
    add_action( 'admin_init', array( $this, 'settings_init' ) );
}

public function add_admin_menu() {
    add_options_page(
        '我的第一个插件设置', // 页面标题
        '我的插件', // 菜单标题
        'manage_options', // 权限
        'my-first-plugin', // 菜单slug
        array( $this, 'settings_page_html' ) // 回调函数，用于输出页面HTML
    );
}

public function settings_init() {
    register_setting( 'my_first_plugin_settings', 'my_first_plugin_options' ); // 注册一组设置

add_settings_section(
        'my_first_plugin_section',
        __( '基本设置', 'my-first-plugin' ),
        null,
        'my-first-plugin'
    );

add_settings_field(
        'footer_text',
        __( '自定义页脚文本', 'my-first-plugin' ),
        array( $this, 'footer_text_field_html' ),
        'my-first-plugin',
        'my_first_plugin_section'
    );
}

public function footer_text_field_html() {
    $options = get_option( 'my_first_plugin_options' );
    ?>
    <input type='text' name='my_first_plugin_options[footer_text]' value='<?php echo esc_attr( $options['footer_text'] ?? '' ); ?>'>
    <?php
}

public function settings_page_html() {
    if ( ! current_user_can( 'manage_options' ) ) {
        return;
    }
    ?>
    <div class="wrap">
        <h1></h1>
        <form action="/ru/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            settings_fields( 'my_first_plugin_settings' );
            do_settings_sections( 'my-first-plugin' );
            submit_button();
            ?>
        <input type="hidden" name="trp-form-language" value="ru"/></form>
    </div>
    &lt;?php
}

Теперь пользователи могут настроить текст в футере на странице “Настройки” -> “Мои плагины”.add_custom_footer_textМетод можно изменить таким образом, чтобы он получал значения из этого списка, что сделает плагин конфигурируемым.

резюме

С помощью этого руководства мы прошли основные этапы разработки плагинов для WordPress: от создания локальной среды и организации базовой структуры файлов до использования объектно-ориентированных подходов к написанию кода. Мы подробно изучили ключевые механизмы расширений WordPress — действия (actions) и фильтры (filters) — и реализовали практические функции для добавления контента в футер и изменения заголовков статей. В конце мы повысили профессиональный уровень нашего плагина и улучшили его удобство использования: добавили поддержку международной локализации (internationalization) для пользователей со всего мира, а также создали безопасный интерфейс настройок с использованием API Settings. Разработка плагинов — это процесс постоянного обучения и совершенствования. Овладев этими основами, вы сможете изучить более сложные темы, такие как настройка пользовательских типов статей, взаимодействие с AJAX, интеграция с REST API и т. д., и создавать мощные, качественно написанные плагины для WordPress.

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

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

Это не обязательно, но настоятельно рекомендуется. Использование процедурного программирования (набора функций) позволяет быстро реализовать нужные функции, однако по мере увеличения количества плагинов код становится сложным для управления и обслуживания, а также может приводить к конфликтам имен функций с другими плагинами. Объектно-ориентированное программирование позволяет заключить код в классы, что облегчает его структурирование и управление.$thisИспользование переменных и пространств имен (в более новых версиях PHP) позволяет лучше организовать код и является общепринятой практикой в создании крупных и средних плагинов.

Как безопасно обрабатывать данные, вводимые пользователями, или данные, полученные из базы данных?

В любой момент, когда переменные отображаются на странице, их необходимо экранировать (то есть обрабатывать специальными символами для предотвращения неправильного отображения кода). WordPress предоставляет ряд вспомогательных функций для этой цели. Для разных ситуаций следует использовать разные функции: при отображении переменных внутри HTML-тегов или в их атрибутах необходимо применять соответствующие методы экранирования.esc_html()илиesc_attr()Выведите результат в переменной JavaScript, используя следующий код:wp_json_encode()илиesc_js()Отобразить в URL с использованием:esc_url()Никогда не верьте вводимым пользователями данным или необработанным данным; использование механизмов эскапации (энкодирования) является ключевым средством предотвращения атак типа XSS (Cross-Site Scripting).

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

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

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

Во-первых, убедитесь, что в разработочной среде данная функция (или опция) активирована.WP_DEBUGДля более сложной отладки можно использовать…error_log()Функция записывает информацию в ошибочный журнал сервера, либо использует другие способы для передачи данных на сервер.var_dump()иwp_die()Для проверки значений переменных используйте только разработочную среду. Более эффективным способом является использование инструмента Xdebug, встроенного в интегрированные среды разработки (например, PhpStorm), для выполнения пошаговой отладки кода. Кроме того, в WordPress…WP_DEBUG_LOGиWP_DEBUG_DISPLAYКонстанты позволяют управлять тем, должны ли ошибки записываться в файлы журнала или отображаться на экране.