Начиная с нуля: инфраструктура разработки плагинов WordPress

Начиная с нуля: инфраструктура разработки плагинов WordPress

Чтобы разработать плагин для WordPress, сначала необходимо понять его основную структуру. Основным файлом плагина является главный файл, который обычно называется так же, как и сам плагин. Например…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
 */

Был создан этот файл, и он был помещён в нужное место./wp-content/plugins/После добавления плагина в каталог вы сможете увидеть его на странице “Плагины” в области управления WordPress и активировать или деактивировать его по своему усмотрению. Далее крайне важно понимать порядок загрузки и выполнения кода плагина. При загрузке плагинов WordPress выполняет это в алфавитном порядке./wp-content/plugins/Все основные файлы действующих плагинов, находящиеся в каталоге. Следовательно, если ваш плагин зависит от функций других плагинов, нельзя просто предполагать, что эти плагины уже загружены. В таком случае необходимо использовать специальные механизмы для обеспечения их корректной загрузки и работы.plugins_loadedЭтот хук действий обеспечивает выполнение кода в правильный момент.

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

Глубокое понимание хуков: механизмы действий и фильтров

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

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

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

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

Действия-хаки (action hooks) позволяют вам выполнять пользовательские функции при наступлении определенных событий. Например, когда статья публикуется…publish_post1) При загрузке ресурсов в верхней части веб-страницы (в заголовочном блоке страницы).wp_enqueue_scripts) или при инициализации из панели управления (admin_initЧтобы использовать хук действия (action hook), вам необходимо…add_action()Функция “монтирует” вашу обратную вызовную функцию (callback-функцию) на соответствующий хук (hook).

add_action( 'init', 'myplugin_custom_init' );
function myplugin_custom_init() {
    // 在WordPress初始化时执行
    // 例如，注册一个自定义文章类型
}

Фильтровые хаки (filter hooks) используются для изменения данных. Они позволяют перехватывать переменные, передаваемые системе, изменять их содержимое и затем возвращать их обновленную версию. Например, это может быть использовано для изменения текста статьи.the_contentИзменение длины выдержек;excerpt_length) или изменение результатов запроса (the_postsЧтобы использовать фильтры, необходимо выполнить соответствующий вызов.add_filter()Функция.

add_filter( 'the_title', 'myplugin_custom_title' );
function myplugin_custom_title( $title ) {
    // 修改文章标题
    return '前缀：' . $title;
}

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

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

// 在插件代码中定义一个自定义动作钩子
do_action( 'myplugin_after_something_happens', $some_data );

// 在插件代码中定义一个自定义过滤器钩子
$value = apply_filters( 'myplugin_filter_some_value', $default_value );

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

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

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

Проверка и эскапирование данных

Для ввода данных используйте…sanitize_text_field()、sanitize_email()、intval()Необходимо очистить такие функции. Для данных, выводимых на HTML-страницу, используйте…esc_html()、esc_attr()илиwp_kses_post()Необходимо выполнить эскапацию данных, чтобы предотвратить атаки типа XSS (Cross-Site Scripting).

$user_input = $_POST['some_field'];
$clean_input = sanitize_text_field( $user_input );

// 输出时
echo '<div class="' . esc_attr( $class_name ) . '">'`. esc_html($clean_input)`.'</div>';

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

WordPress предоставляет…$wpdbГлобальные объекты предназначены для прямого доступа к базе данных, однако в первую очередь следует использовать встроенные функции WordPress.get_post()、update_option()И т. д. Если использование SQL неизбежно, обязательно следуйте соответствующим правилам и стандартам.$wpdb->prepare()Методы предотвращения взломов с использованием SQL-инъекций.

global $wpdb;
$user_id = intval( $_GET['id'] );
$results = $wpdb->get_results(
    $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}my_table WHERE user_id = %d", $user_id )
);

Добавить меню и страницы для управления.

Создание страницы настройок для плагина является распространенным требованием. Для этого можно воспользоваться различными инструментами и методами, в зависимости от конкретных потребностей и условий разработки.add_menu_page()илиadd_options_page()Функции для добавления пунктов меню в бэкэнде должны быть реализованы следующим образом:admin_menuВызывается в хуке действия (action hook).

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

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

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

add_action( 'admin_menu', 'myplugin_add_admin_menu' );
function myplugin_add_admin_menu() {
    add_options_page(
        '我的插件设置', // 页面标题
        '我的插件',     // 菜单标题
        'manage_options', // 权限
        'myplugin-slug',  // 菜单别名
        'myplugin_settings_page' // 用于呈现页面的回调函数
    );
}
function myplugin_settings_page() {
    // 输出设置页面HTML
    echo '<div class="wrap"><h1>устанавливать</h1></div>';
}

Подготовка к публикации плагина: интернационализация и организация кода

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

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

Международная поддержка (i18n) позволяет переводить ваш плагин на другие языки. Для этого необходимо использовать функции по переводу, предоставляемые WordPress.__()、_e()、_x()Соберите все строки, видимые для пользователей, и объявьте их в начале плагина.Text Domain(Например,my-first-plugin）。

// 在代码中
$greeting = __( 'Hello, World!', 'my-first-plugin' );
_e( 'This text will be echoed and translatable.', 'my-first-plugin' );

// 然后，使用如Poedit等工具生成 .pot 翻译模板文件。

Модульная организация кода

Вам следует избегать слияния всего кода в один главный файл. Хорошей практикой является разделение кода, выполняющего различные функции, на отдельные файлы..phpФайлы находятся внутри основного файла, и основной файл включает их в свой состав. Например:
- includes/admin/ Каталог содержит код, связанный с работой бэкенда.
- includes/public/ Каталог содержит код, связанный с фронтенд-частью приложения.
- includes/class-*.php Здесь хранятся основные определения классов.
- assets/css/ и assets/js/ Здесь хранятся таблицы стилей (stylesheetы) и скрипты (scripts).

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

Использование объектно-ориентированного программирования позволяет лучше организовать код, избежать конфликтов в названиях функций и повысить уровень их повторного использования. Необходимо определить главный класс (main class) и в его конструкторе подключить (монтировать) все необходимые компоненты или методы («хаки», hooks).

class My_First_Plugin {
    public function __construct() {
        add_action( 'init', array( $this, 'init_method' ) );
        add_filter( 'the_content', array( $this, 'filter_content' ) );
    }
    public function init_method() {
        // 初始化
    }
    public function filter_content( $content ) {
        return $content . '<p>Дополнительный контент для плагина</p>';
    }
}
new My_First_Plugin();

резюме

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

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

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

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

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

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

Вам необходимо овладеть основами языка PHP, поскольку WordPress и его плагины написаны на этом языке. Кроме того, вам потребуется базовое знание HTML, CSS и JavaScript для работы с пользовательским интерфейсом и взаимодействия с пользователем. Самое важное — понимание основного принципа работы WordPress и его системы хуков (Hooks), которая является ключевым механизмом разработки плагинов.

Как предотвратить конфликты между именами функций моего плагина и именами функций других плагинов?

Лучшей практикой является использование объектно-ориентированного программирования (OOP), при котором функции объединяются в классы, а имена методов внутри классов остаются уникальными. Если же используется процедурное программирование, необходимо присваивать всем функциям, классам и константам уникальное префикс. Это префикс может быть сокращением названия вашего плагина или названия вашей компании.myplugin_илиacme_И обеспечьте соблюдение этого правила на протяжении всего кода.

Где мне следует загружать JavaScript- и CSS-файлы плагина?

Для обеспечения корректности и высокой производительности никогда не следует напрямую вставлять ссылки на файлы ресурсов в HTML-шаблоны. Для этого следует использовать функции культивирования (enqueue) из библиотеки WordPress. Что касается фронтенд-ресурсов, то рекомендуется применять соответствующие механизмы управления их загрузкой, предусмотренные системой WordPress.wp_enqueue_script()иwp_enqueue_style()И подключите его к… (или: и монтируйте его на…)wp_enqueue_scriptsДанные ресурсы монтируются на специальные “действия-хватки” (action hooks), предназначенные исключительно для использования в интерфейсах административного управления.admin_enqueue_scriptsНа крючке.

Как плагины хранят свои настройки и данные?

Для настройки простых параметров с единственным значением можно воспользоваться API параметров WordPress.add_option()、get_option()иupdate_option()Для работы с более сложными и структурированными данными (например, списками элементов форм) следует создавать пользовательские таблицы в базе данных. Для этого можно использовать соответствующие инструменты и методы программирования.dbDelta()Функция активируется при включении плагина (через…)register_activation_hookБезопасно создавать или обновлять структуру таблиц.