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

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

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

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

Создание вашего первого плагина

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

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

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

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

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

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

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

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

<?php
/**
 * Plugin Name:       我的第一个插件
 * Plugin URI:        https://example.com/my-first-plugin
 * Description:       这是一个用于演示的简单插件，它将在文章内容顶部添加一行文字。
 * Version:           1.0.0
 * Author:            你的名字
 * License:           GPL v2 or later
 * Text Domain:       my-first-plugin
 */

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

Реализовать простую функцию.

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

function myplugin_add_text_to_content( $content ) {
    $custom_text = '<p>Этот текст был добавлен с помощью моего первого плагина – плагина для вывода приветствий.</p>';
    return $custom_text . $content;
}
add_filter( 'the_content', 'myplugin_add_text_to_content' );

Добавьте этот код в ваш основной плагин.my-first-plugin.phpСохраните и активируйте плагин. Теперь, когда вы просматриваете любую статью или страницу на сайте, указанный текст будет отображаться в начале содержимого. Вот так работает самая базовая функция плагина.

Основные концепции разработки плагинов и API

Понимание механизма хуков (hooks)

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

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

Данный механизм предназначен для выполнения вашего пользовательского кода в определенный момент времени. Например,wp_footerЭта функция позволяет вам отображать HTML-код или скрипты в нижней части страницы. Вы можете воспользоваться ею для добавления дополнительных элементов интерфейса или выполнения каких-либо операций.add_action()Функция предназначена для монтирования (присоединения) определенного действия (акции) к системе.

Фильтры используются для изменения данных перед их передачей в базу данных или браузер. Например, именно фильтры были применены в приведённом выше примере.the_contentФильтры позволяют вам изменять содержимое статей. Вам необходимо их использовать.add_filter()Функция предназначена для добавления фильтров, при этом ваша обратная вызовная функция (callback function) должна возвращать измененное значение.

Использование основных классов базы данных

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

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

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

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

Например, если вы хотите получить информацию из базы данных, вы можете поступить следующим образом:

global $wpdb;
$results = $wpdb->get_results( "SELECT id, name FROM {$wpdb->prefix}my_custom_table" );

Обратите внимание на правильное использование.$wpdb->prefixНеобходимо убедиться в корректности префиксов таблиц. При выполнении операций вставки, обновления или удаления обязательно используйте соответствующие префиксы.wpdbПредоставленный материал…insert()、update()Методы такого рода автоматически обрабатывают данные с целью предотвращения необходимости их экранирования (эскапирования), тем самым защищая систему от атак типа SQL-инъекции.

Создать страницу для настройки управления

Создание страницы для настройки плагина в режиме администрирования является основным требованием для профессиональных плагинов. WordPress предоставляет множество API-функций для добавления элементов меню и страниц различного уровня сложности; наиболее часто используемыми из них являются…add_menu_page() и add_options_page()。

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

Вот пример добавления верхнего меню и страницы с простыми настройками:

function myplugin_add_admin_menu() {
    add_menu_page(
        '我的插件设置',        // 页面标题
        '我的插件',            // 菜单标题
        'manage_options',      // 所需权限
        'myplugin-settings',   // 菜单Slug
        'myplugin_settings_page', // 回调函数，用于输出页面HTML
        'dashicons-admin-generic', // 图标
        6                      // 菜单位置
    );
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );

function myplugin_settings_page() {
    ?>
    <div class="wrap">
        <h1>Настройки моего плагина.</h1>
        <form method="post" action="/ru/options.php/" data-trp-original-action="options.php">
            <?php
                settings_fields( 'myplugin_settings_group' );
                do_settings_sections( 'myplugin-settings' );
                submit_button();
            ?>
        <input type="hidden" name="trp-form-language" value="ru"/></form>
    </div>
    &lt;?php
}

В этом примере создается верхний меню с названием “Мой плагин”. После его нажатия открывается страница, содержащая информацию о данном плагине.myplugin_settings_pageСтраница, отображаемая с помощью функций. Обычно для её создания используется API настроек (Settings API) WordPress.register_setting, add_settings_section, add_settings_fieldЭто позволяет безопасно обрабатывать и сохранять параметры настроек.

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

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

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

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

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

Создание пользовательских таблиц в базе данных

Во-первых, при активации плагина необходимо создать новую таблицу в базе данных для хранения заметок. Это можно сделать, регистрировав соответствующий хук (активационный хук – activation hook).register_activation_hookЧтобы это реализовать…

function my_note_plugin_activate() {
    global $wpdb;
    $table_name = $wpdb->prefix . 'post_notes';
    $charset_collate = $wpdb->get_charset_collate();

$sql = "CREATE TABLE $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        post_id bigint(20) NOT NULL,
        note_content text NOT NULL,
        created_by bigint(20) NOT NULL,
        created_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
        PRIMARY KEY  (id)
    ) $charset_collate;";

require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
    dbDelta( $sql );
}
register_activation_hook( __FILE__, 'my_note_plugin_activate' );

Здесь мы используем…dbDelta()Функция предназначена для создания или обновления структуры таблицы. Это безопасный и совместимый с различными системами способ работы с базами данных.

Добавить мета-окно в интерфейс редактирования статьи

Далее нам необходимо добавить на страницу редактирования статей мета-окно для отображения и сохранения заметок. Для этого потребуется использовать соответствующие функции разработческого инструментария.add_meta_boxФункция, и затем её монтируют…add_meta_boxesВ плане действий.

function my_note_add_meta_box() {
    add_meta_box(
        'my_note_meta_box',         // 元框的唯一ID
        '文章内部便签',             // 显示的标题
        'my_note_meta_box_callback', // 渲染元框内容的回调函数
        'post',                     // 要显示的帖子类型
        'side',                     // 位置
        'default'                   // 优先级
    );
}
add_action( 'add_meta_boxes', 'my_note_add_meta_box' );

function my_note_meta_box_callback( $post ) {
    // 从数据库获取当前文章的已有便签
    global $wpdb;
    $table_name = $wpdb->prefix . 'post_notes';
    $notes = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $table_name WHERE post_id = %d ORDER BY created_at DESC", $post->ID ) );

wp_nonce_field( 'my_note_save_action', 'my_note_nonce_field' );
    echo '<textarea name="my_new_note" rows="5" style="width:100%;" placeholder="Введите ваши внутренние примечания…."></textarea>'echo '<p class="description">Эта примечание видна только для редакторов и администраторов сайта.</p>';

if ( $notes ) {
        echo '<hr><h4>Исторические заметки:</h4>';
        foreach ( $notes as $note ) {
            $user = get_user_by( 'id', $note-&gt;created_by );
            $username = $user ? $user-&gt;display_name : '未知用户';
            echo '<p><strong>' . esc_html( $username ) . ' (' . $note-&gt;created_at . '):</strong><br>';
            echo nl2br( esc_html( $note-&gt;note_content ) ) . '</p>';
        }
    }
}

Сохранение и очистка данных

Когда статья сохраняется или обновляется, нам необходимо записать новые заметки в базу данных. Это можно сделать следующим образом:save_postДействия должны быть реализованы соответствующим образом. Кроме того, при удалении плагина (по желанию), необходимо предоставить механизм для его деинсталляции.register_uninstall_hookПришло время очистить созданные таблицы данных.

function my_note_save_post_data( $post_id ) {
    // 检查非ce、权限、自动保存等
    if ( ! isset( $_POST['my_note_nonce_field'] ) || ! wp_verify_nonce( $_POST['my_note_nonce_field'], 'my_note_save_action' ) ) {
        return;
    }
    if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
        return;
    }
    if ( ! current_user_can( 'edit_post', $post_id ) ) {
        return;
    }

if ( ! empty( $_POST['my_new_note'] ) ) {
        global $wpdb;
        $table_name = $wpdb->prefix . 'post_notes';

$wpdb->insert(
            $table_name,
            array(
                'post_id' => $post_id,
                'note_content' => sanitize_textarea_field( $_POST['my_new_note'] ),
                'created_by' => get_current_user_id(),
            ),
            array( '%d', '%s', '%d' )
        );
    }
}
add_action( 'save_post', 'my_note_save_post_data' );

// 可选：卸载插件时删除数据表
function my_note_plugin_uninstall() {
    global $wpdb;
    $table_name = $wpdb->prefix . 'post_notes';
    $wpdb->query( "DROP TABLE IF EXISTS $table_name" );
}
register_uninstall_hook( __FILE__, 'my_note_plugin_uninstall' );

Лучшие практики и подготовка к публикации

Соблюдение стандартов кодирования WordPress

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

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

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

WordPress предоставляет…__()、_e()、_n()Ряд функций… Прежде всего, вам необходимо правильно настроить информацию, содержащуюся в заголовочной части плагина.Text Domain(Например: `my-first-plugin`), а затем каждый раз при выводе или использовании этого строкового значения необходимо выполнить соответствующую обработку (обертку).

Пример:

echo '<p>' . esc_html__( '这是一个演示文本。', 'my-first-plugin' ) . '</p>';

Затем вы можете использовать такой инструмент, как Poedit, чтобы извлечь весь текст и использовать его для дальнейших целей..potФайл, предназначенный для перевода на разные языки..moи.poДокумент.

Безопасность и оптимизация производительности

Безопасность является одним из главных приоритетов при разработке плагинов. Всегда необходимо проверять и обрабатывать входные данные пользователей (санитизация), а также обрабатывать выводимые данные с использованием соответствующих механизмов (эскапирование). При выполнении SQL-запросов обязательно следует соблюдать все правила безопасности.prepare()Используйте соответствующие меры предосторожности для предотвращения вставки вредоносного кода. Перед выполнением операций проверяйте права пользователя.current_user_can()Для случаев, когда используется не механизм проверки подлинности пользователей (nonce) от WordPress, применяется собственный механизм проверки подлинности.wp_nonce_field(), wp_verify_nonce()）。

Что касается производительности, необходимо оптимизировать выполнение запросов к базе данных и избегать их выполнения в циклах. Рационально используйте API для работы с временными данными (Transients) в WordPress для целей кэширования. Кроме того, при отсутствии необходимости в использовании хуков (hooks), следует своевременно их удалить.remove_action(), remove_filter()В конце концов, в каталоге плагинов должны находиться только необходимые файлы. Перед публикацией код следует сжать и очистить от лишних элементов.

Готов к публикации в репозитории WordPress.

Если вы планируете выпустить плагин в официальный каталог плагинов WordPress, вам потребуется выполнить ряд подготовительных шагов. Убедитесь, что у плагина есть четко сформулированное описание его функций и принципа работы.readme.txtФайл соответствует стандартам форматирования WordPress. В нем должны быть представлены описание плагина, инструкции по установке, ответы на частые вопросы (FAQ), логи обновлений версий и другая важная информация. Также убедитесь, что информация в заголовочной части основного файла плагина полная и точная. Тщательно протестируйте совместимость вашего плагина в различных средах и на разных версиях WordPress.

резюме

Разработка плагинов для WordPress – это творческий процесс, позволяющий превращать идеи в мощные функции. Понимая основную структуру плагинов, освоивая ключевые механизмы использования хуков (Actions и Filters), а также умело применяя такие инструменты, как API настроек (Settings API) и операции с базой данных, вы сможете создавать плагины самых разных уровней сложности – от простых инструментов до сложных решений. На протяжении всего процесса разработки всегда ставьте во главу безопасность, производительность, стандарты кода и интернационализацию. Начните с создания своего первого плагина в стиле “Hello World”, постепенно накапливайте опыт, и в конце концов вы сможете с уверенностью создавать профессиональные плагины, готовые к публикации.

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

Для разработки плагинов необходимо овладеть следующими технологиями:

Вам необходимы прочные знания PHP, а также освоение основ HTML, CSS и JavaScript. Также важно иметь базовое понимание базы данных MySQL. Самое важное – это понимание архитектуры WordPress, в частности механизма хуков (hooks) и иерархии шаблонов (Template Hierarchy). Знания объектно-ориентированного программирования (OOP) будут очень полезны при создании сложных плагинов.

В чем разница между функциями плагинов и функциями тем (тематических настроек)?

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

Как обрабатывать обновления плагинов и вопросы их совместимости?

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

Как должны плагины загружать файлы CSS и JavaScript?

Никогда не следует вставлять CSS или JS-код непосредственно в PHP-файлы плагинов. Для обеспечения совместимости и производительности необходимо использовать функцию `wp_enqueue()` WordPress для правильной загрузки скриптов и таблиц стилей. Это делается в режиме администрирования (в бэкенде).admin_enqueue_scriptsХук (hook) используется на фронтенде (в пользовательском интерфейсе программы).wp_enqueue_scriptsКрючок. Используйте его.wp_enqueue_style()иwp_enqueue_script()Функции, а также учитывайте вопросы зависимостей и версий программного обеспечения.

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

Добавление пользовательских типов статей (Custom Post Types, CPT)register_post_type()Функция для добавления пользовательской системы классификацииregister_taxonomy()Функции. Лучшей практикой является совершение всех операций регистрации в одном месте.initДействие выполняется в хуке (action hook). Вам необходимо тщательно настроить массив параметров регистрации, включая такие параметры, как метка (tag), уровень доступности (publicity), поддерживаемые функции, наличие страницы архивации и т. д. Эти параметры определяют поведение данного хука как на серверной, так и на клиентской стороне.