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

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

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

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

Подготовка среды разработки

Эффективная среда локального разработчика является неотъемлемой частью процесса создания программного обеспечения. Рекомендуется использовать такие инструменты, как Local by Flywheel, XAMPP или MAMP, для быстрого настройства интегрированной среды, включающей в себя PHP, MySQL, Apache и Nginx. Убедитесь, что версия PHP совместима с требованиями последней версии WordPress. Кроме того, необходимы удобный кодовый редактор (например, VS Code или PhpStorm) и инструменты для отладки в браузере.

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

Основная структура плагина и главный файл

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

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

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

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

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

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

Организация каталога плагинов

Четко структурированный каталог плагинов облегчает их долгосрочное обслуживание. Типичная структура каталога может включать в себя следующие элементы:
Основной файл. my-awesome-plugin.php (Расположено в корневой директории плагина)
- includes/ Каталог: содержит файлы с классами или функциями, реализующими основные функциональные возможности программы.
- admin/ Каталог: содержит код, связанный с интерфейсом административного управления.
- public/ Каталог: содержит код, связанный с визуальным отображением пользовательского интерфейса (фронтенд-разработкой).
- assets/ Каталог: содержит таблицы стилей CSS, скрипты JavaScript и изображения.
- languages/ Каталог: размещение файлов с международными переводами (.po/.mo).

Основные концепции разработки и механизмы Hook’ов

Основная философия разработки плагинов для WordPress заключается в использовании так называемых “хуков (Hooks)” и “обратных вызовов (Callbacks)”. С помощью хуков ваш код может быть встроен в основной процесс выполнения WordPress в определенные моменты времени.

Хокки действий и хокки фильтров

Крючки (hooks) в основном делятся на два типа: действия (Actions) и фильтры (Filters).
Действия-хаки (action hooks) позволяют выполнять пользовательский код при наступлении определенных событий, например, после публикации статьи или при загрузке страницы управления. Используйте их для автоматизации различных процессов. add_action() Функция предназначена для монтирования (подключения) ресурсов.

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

function myplugin_send_notification( $post_id ) {
    // 当文章发布时，执行发送通知的代码
    wp_mail( '[email protected]', '新文章发布', "文章ID: $post_id 已发布。" );
}
add_action( 'publish_post', 'myplugin_send_notification' );

Фильтровые хаки позволяют вам изменять данные. Вы можете вносить изменения в данные перед тем, как они будут использованы (например, сохранены в базе данных или отображены в браузере). add_filter() Функция.

function myplugin_modify_title( $title ) {
    // 在所有文章标题前添加文本
    return '【精选】' . $title;
}
add_filter( 'the_title', 'myplugin_modify_title' );

Создание пользовательских хуков (custom hooks)

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

// 在插件代码的某个位置定义一个动作钩子
do_action( 'myplugin_after_processing', $data );

// 定义一个过滤器钩子，允许其他代码修改 $output
$output = apply_filters( 'myplugin_output_filter', $default_output, $param1, $param2 );

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

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

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

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

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

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

Для создания безопасных и стандартизированных страниц управления в WordPress используется API настроек (Settings API). К этому процессу относятся регистрация новых настроек, добавление полей и разделов для хранения данных.

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

// 注册设置、字段和章节的代码...
function myplugin_settings_page() {
    ?>
    <div class="wrap">
        <h1>Настройки моего плагина.</h1>
        <form action="/ru/options.php/" method="post" 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
}

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

Короткие коды позволяют пользователям легко вставлять функции плагинов в статьи или страницы. add_shortcode() Функция проходит процедуру регистрации.

add_shortcode( 'myplugin_show_message', 'myplugin_shortcode_callback' );
function myplugin_shortcode_callback( $atts ) {
    // 解析短代码属性
    $attributes = shortcode_atts( array(
        'text' => '默认消息',
    ), $atts );

// 返回要显示的内容
    return '<div class="myplugin-message">'`.esc_html($attributes['text'])`.'</div>';
}

Пользователь может вводить текст в редакторе [myplugin_show_message text="你好，世界！"] Используйте его.

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

Взаимодействие с базой данных

Для плагинов, которые требуют хранения данных, рекомендуется использовать классы для работы с базой данных, предоставляемые WordPress. $wpdbПри создании пользовательских таблиц это действие необходимо выполнить в ходе активации соответствующего хака (hook) плагина.

register_activation_hook( __FILE__, 'myplugin_create_table' );
function myplugin_create_table() {
    global $wpdb;
    $table_name = $wpdb->prefix . 'myplugin_data'; // 加上前缀
    $charset_collate = $wpdb->get_charset_collate();

$sql = "CREATE TABLE IF NOT EXISTS $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        name varchar(100) NOT NULL,
        value text,
        created_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
        PRIMARY KEY (id)
    ) $charset_collate;";

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

При запросе данных следует использовать… $wpdb->prepare() Это сделано для предотвращения атак типа SQL-инъекций.

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

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

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

Безопасность, производительность и готовность к публикации плагинов.

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

Лучшие практики обеспечения безопасности

Безопасность является главным приоритетом. Все данные, полученные от пользователей (например, $_GET， $_POST， $_COOKIEВсе полученные данные необходимо проверить, очистить и обработать (включая применение специальных механизмов для предотвращения ошибок при их использовании).
Проверка (Validation): проверяем, соответствуют ли данные ожидаемому формату (например, является ли это адресом электронной почты или числом).
Очистка (Sanitization): очистка данных и удаление небезопасных символов. Используйте такие функции, как sanitize_text_field()， sanitize_email()。
Эскапирование (Escaping): перед выводом данных в HTML, JavaScript или URL их необходимо эскапировать. Для этого используются такие функции, как esc_html()， esc_js()， esc_url()。

Кроме того, используется встроенный в WordPress механизм проверки подлинности (NonCE – Non-Cryptographic Signature).wp_nonceМеханизмы проверки законности запросов предназначены для предотвращения атак типа CSRF (Cross-Site Request Forgery).

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

Избегайте выполнения ненужных запросов к базе данных или других затратных операций в плагинах. Для результатов повторяющихся запросов рассмотрите возможность использования API для хранения временных данных (Transients) в WordPress с целью их кэширования.

// 尝试从缓存中获取数据
$data = get_transient( 'myplugin_expensive_data' );
if ( false === $data ) {
    // 缓存中没有，执行耗时操作获取数据
    $data = myplugin_expensive_query_function();
    // 将数据缓存12小时
    set_transient( 'myplugin_expensive_data', $data, 12 * HOUR_IN_SECONDS );
}

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

Интернационализация и финальная публикация продукта

пользоваться ()， _e() Функции, такие как `wrap_text`, обертывают весь текст, видимый пользователем, чтобы обеспечить поддержку нескольких языков. Например:echo esc_html( ‘Hello World’， ‘my-awesome-plugin’ );Затем используйте такой инструмент, как Poedit, для создания нужного результата. .pot Шаблонные файлы и файлы с переводами.

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

резюме

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

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

Какие знания необходимы для разработки плагинов для WordPress?

Вам потребуются базовые знания языка программирования PHP, поскольку WordPress и его плагины в основном написаны на этом языке. Также важно иметь представление об HTML, CSS и JavaScript для работы с пользовательским интерфейсом и взаимодействия с пользователем. Знание основ концепций базы данных MySQL (выполнение операций добавления, удаления, изменения и поиска данных) также окажется полезным при работе с WordPress. $wpdb Классы упрощают выполнение большинства операций.

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

Прежде всего, убедитесь, что в wp-config.php Файл открыт в приложении WP_DEBUG и WP_DEBUG_LOG Константа; это позволит записывать сообщения об ошибках в соответствующий файл. /wp-content/debug.log В файле. Кроме того, можно использовать… error_log() Функция выводит пользовательские сведения для отладки. Кроме того, для отладки AJAX-запросов и ошибок JavaScript можно использовать панели сети (Network) и консоли (Console) в разработческих инструментах браузера. Профессиональные интегрированные среды разработки (IDE), такие как PhpStorm, также предоставляют мощные возможности отладки с использованием точек остановки.

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

Это зависит от конкретных требований. Если ваши данные имеют сложную, специализированную структуру и невозможно эффективно сохранить их с помощью встроенных типов статей (Custom Post Types) или API для настройки параметров (Options API) WordPress, то создание пользовательских таблиц может оказаться разумным решением — например, для хранения сложных логовых записей или реляционных данных. Однако, если данные могут быть легко представлены в виде статей с пользовательскими метаданными, использование пользовательских типов статей, как правило, является более предпочтительным вариантом, поскольку это обеспечивает автоматическую совместимость с экосистемой WordPress (включая возможности поиска, управления правами и т. д.).

Как сделать так, чтобы мой плагин был совместим с большим количеством версий WordPress?

Избегайте использования слишком новых или устаревших функций. Во время разработки обращайтесь к официальному справочнику WordPress (Codex) или руководству для разработчиков (Developer Handbook), чтобы узнать, в каких версиях функции были введены и в каких версиях они были устаревшие. Для этого можно использовать условные операторы в коде. function_exists() Необходимо предложить план действий на случай отступления от первоначального решения. Например:if ( function_exists( ‘wp_is_block_theme’ ) ) { ... }Кроме того, в примечаниях в начале основного файла плагина необходимо четко указать диапазон версий WordPress, для которых тесты были прошены.