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

Основная структура плагинов для WordPress

Стандартный плагин для WordPress, основой которого является элемент, расположенный… /wp-content/plugins/ Это отдельная папка, находящаяся в каталоге. В этой папке должен быть хотя бы один основной PHP-файл, в заголовочных комментариях которого содержатся метаданные плагина – именно на основе этих данных WordPress идентифицирует плагин.

Аннотации в начале плагина играют крайне важную роль. Они используют специфический формат для сообщения системе 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
 */

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

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

Помимо основного файла, полнофункциональный плагин обычно включает в себя и другие файлы и каталоги, например, для хранения ресурсов JavaScript и CSS. assets Папки, предназначенные для перевода… languages Папка, предназначенная для хранения файлов с классами. includes Папки, а также шаблонные файлы, используемые для отображения на пользовательском интерфейсе (фронтенде). Хорошая структура каталогов является основой для обеспечения сопровождаемости (мантинемента) и расширяемости плагинов.

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

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

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

Понимание основных механизмов работы WordPress: хаки (hooks)

Основная философия разработки плагинов для WordPress заключается в использовании так называемых “хуков” (hooks) и “коллбэков” (callbacks). Хуки позволяют разработчикам вставлять свой собственный код в определенные моменты выполнения основного кода WordPress, тем самым изменяя или дополняя стандартные функции без необходимости напрямого изменения исходных файлов системы. Это обеспечивает сохранность стабильности основной части программы и безопасность при обновлениях плагинов.

Крючки в основном делятся на два типа: крючки действий (action hooks) и крючки фильтров (filter hooks).

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

Акционные хуксы выполняются при наступлении определенных событий, таких как публикация статей, загрузка страницы управления или вход пользователя в систему. Они не предназначены для возврата каких-либо значений и в основном используются для выполнения определенных действий. Разработчики часто применяют их в своем коде. add_action() Функция монтирует пользовательскую функцию (функцию-обратный вызов) на указанный хук действия.

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

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

function myplugin_setup() {
    // 初始化插件，例如创建数据库表
}
add_action( 'init', 'myplugin_setup' );

Вышеуказанный код означает, что когда система WordPress выполняет определенные действия… init При выполнении этой операции будут одновременно запущены все функции, которые мы заранее определили. myplugin_setup Функция.

Использование фильтров-хуков (filter hooks)

Фильтровые хаки (filter hooks) используются для изменения данных. Они принимают переменную в качестве входного параметра и возвращают измененную версию этой переменной. Разработчики часто применяют их в своих программах для выполнения различных операций с данными. add_filter() Функция предназначена для монтирования пользовательских фильтрующих модулей. Это наиболее распространенный способ изменения содержимого статей, их заголовков, ссылок и других данных.

Исходя из приведённого примера, более корректным способом добавления информации об авторских правах в содержимое статьи является использование следующего формата: the_content Фильтр:

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

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

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

function myplugin_add_copyright( $content ) {
    if ( is_single() ) {
        $content .= '<p>Авторские права на этот текст принадлежат данному сайту. При перепечатке обязательно укажите источник.</p>';
    }
    return $content;
}
add_filter( 'the_content', 'myplugin_add_copyright' );

В этом примере функция… myplugin_add_copyright Принять исходный материал. $content Переменная содержит HTML-текст, который добавляется в конец её значения, после чего изменённый результат возвращается. WordPress использует этот возвращённый значений вместо исходного содержимого для отображения.

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

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

Добавить элементы верхнего меню

пользоваться add_menu_page() Функция позволяет создать отдельное верхнее меню для плагина в бэкенде. Для её использования необходимо предоставить несколько параметров, включая заголовок страницы, заголовок меню, права доступа, псевдоним меню и функцию обратного вызова.

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

Ниже приведен пример кода для создания простой верхней управляющей страницы:

function myplugin_add_admin_menu() {
    add_menu_page(
        '我的插件设置',          // 页面标题
        '我的插件',              // 菜单标题
        'manage_options',       // 所需权限（管理员）
        'myplugin-settings',    // 菜单别名（URL中的slug）
        'myplugin_settings_page', // 用于输出页面内容的回调函数
        'dashicons-admin-generic', // 图标（使用Dashicons）
        80                      // 菜单位置
    );
}
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
}

Этот код сначала… add_action Прикрепите функцию для добавления меню к уже существующему объекту или процессу. admin_menu Хук. Он выполняется при загрузке меню в фоновом режиме. myplugin_add_admin_menuДля регистрации нового верхнего меню под названием “Мои плагины” выполните следующие действия: после нажатия на это меню WordPress автоматически запустит необходимые процедуры. myplugin_settings_page Функция используется для отображения содержимого страницы.

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

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

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

Настройка хранения полей и параметров

Одного лишь внешнего оформления страницы недостаточно; нам также необходимо создать формы на страницах и безопасно хранить введенные пользователем данные. Для этого предназначен API настроек (Settings API) WordPress, который позволяет автоматизировать проверку данных, их хранение, а также генерацию сеансовых токенов (nonce).

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

function myplugin_settings_init() {
    // 1. 注册一个设置选项到数据库
    register_setting( 'myplugin_settings_group', 'myplugin_options' );

// 2. 在页面内添加一个设置区块
    add_settings_section(
        'myplugin_section_main',
        '主要设置',
        null,
        'myplugin-settings'
    );

// 3. 在区块内添加一个具体的字段
    add_settings_field(
        'myplugin_field_text',
        '示例文本输入',
        'myplugin_field_text_render', // 渲染字段HTML的回调函数
        'myplugin-settings',
        'myplugin_section_main'
    );
}
add_action( 'admin_init', 'myplugin_settings_init' );

// 定义字段的HTML输出
function myplugin_field_text_render() {
    $options = get_option( 'myplugin_options' );
    $value = $options['text_field'] ?? '';
    ?>
    <input type='text' name='myplugin_options[text_field]' value='<?php echo esc_attr( $value ); ?>'>
    <?php
}

С помощью этого API после отправки формы данные автоматически сохраняются в… wp_options В таблице элемент с именем… myplugin_options В записях (сериализованном массиве) разработчики могут использовать эти данные. get_option( ‘myplugin_options’ ) Необходимо получить эти значения в безопасном способе — как на стороне клиента (фронтенде), так и на стороне сервера (бэкенде).

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

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

Проверка данных, их кодирование (эскапирование) и очистка

Все данные, поступающие от пользователей или из внешних источников, считаются ненадежными. Перед выводом данных в браузер (фронтенд) необходимо выполнить их обработку (эскапирование) для предотвращения атак типа XSS. При записи данных в базу данных (бекенд) данные также должны быть очищены и проверены на достоверность.

WordPress предоставляет множество вспомогательных функций. Для контента, который выводится в HTML, можно использовать… esc_html(), esc_attr(), esc_url() Функции типа “wait” и подобные. Для вывода данных в переменные JavaScript используйте соответствующие методы. wp_json_encode()При работе с базами данных следует всегда использовать… $wpdb->prepare() Выполняйте параметризованные запросы или используйте такие инструменты, как… sanitize_text_field(), intval() Функции предназначены для очистки входных данных.

// 不安全的做法
echo $_GET['user_input'];

// 安全的做法：输出到HTML内容
echo esc_html( $_GET['user_input'] );

// 安全的做法：用于HTML属性
$url = esc_url( $_GET['url'] );
echo "<a href='/ru/$url/'>ссылка</a>";

// 安全的做法：清理后存入数据库
$clean_title = sanitize_text_field( $_POST['title'] );
update_post_meta( $post_id, ‘title’, $clean_title );

Подготовка к интернационализации и локализации

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

WordPress использует фреймворк GNU gettext для обработки текстов. В коде WordPress этот фреймворк применяется для работы с локализованными версиями программы, а также для управления переводами текстов. __() Переведите и верните строку, используя _e() Переведите и выведите строку напрямую. Кроме того, её необходимо определить в комментарии в заголовке плагина. Text DomainИ использовать его при загрузке плагина. load_plugin_textdomain() Функция для загрузки файлов с переводами.

// 定义可翻译的字符串
$greeting = __( ‘Hello, World!', ‘my-first-plugin’ );
_e( ‘Settings saved successfully!', ‘my-first-plugin’ );

// 在插件初始化时加载翻译
function myplugin_load_textdomain() {
    load_plugin_textdomain( ‘my-first-plugin’, false, dirname( plugin_basename( __FILE__ ) ) . ‘/languages/’ );
}
add_action( ‘init’, ‘myplugin_load_textdomain’ );

Разработчикам необходимо использовать такие инструменты, как Poedit, для генерации нужных файлов. .pot Шаблонный файл, предназначенный для создания переводов на разные языки переводчиками. .po И после компиляции .mo Файлы. Подготовленные языковые файлы должны быть размещены в папке плагина. /languages/ Это ключевой шаг на пути к выходу плагина на международный рынок.

резюме

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

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

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

Для создания плагина достаточно всего одного PHP-файла. Главное, чтобы этот файл содержал необходимые заголовочные комментарии, характерные для плагинов WordPress, и чтобы он был размещен в соответствующем месте в структуре проекта. /wp-content/plugins/ Файл можно разместить непосредственно в каталоге или в подкаталоге; WordPress автоматически его обнаружит и активирует.

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

Рекомендуется использовать этот подход в среде разработки. wp-config.php В файле включен режим отладки WordPress. WP_DEBUG Константа установлена на trueКроме того, можно настроить (или задать определенные параметры) соответствующим образом. WP_DEBUG_LOG Для… trueЗаписать информацию об ошибке в… /wp-content/debug.log Файлы не следует отображать непосредственно на странице. Кроме того, очень важно использовать инструменты разработчика браузера для просмотра консоли и сетевых запросов.

Где должны находиться параметры плагина?

Для настройки простых пар ключ-значение настоятельно рекомендуется использовать API Options в WordPress. add_option(), update_option(), get_option() Функция выполняет необходимые операции, и данные безопасно хранятся. wp_options В таблицах базы данных. Для обработки больших объемов структурированных данных можно рассмотреть возможность создания пользовательских таблиц, однако это требует более сложного управления их жизненным циклом (создание при установке, удаление при деинсталляции).

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

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