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

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

Далее вам необходимо создать основной файл плагина в этой папке. Этот файл обычно называется в соответствии с названием плагина, например: my-first-plugin.phpЭтот файл является входным пунктом для плагина, и в его верхней части обязательно должно быть присутствовать описание плагина в соответствии со стандартами WordPress. Это описание предназначено для предоставления системе 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
 * Domain Path:       /languages
 */

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

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

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

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

Понимание основной структуры плагина

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

Способ организации основных файлов и каталогов

Помимо основного файла плагина, полнофункциональный плагин обычно включает в себя несколько каталогов и файлов. Например,includes/ Каталог предназначен для хранения основных файлов с PHP-классами или функциями.admin/ Каталог содержит код, связанный с интерфейсом администрирования веб-сайта.public/ или frontend/ Каталог содержит код, предназначенный для пользователей веб-сайта.assets/ Каталог предназначен для хранения статических ресурсов, таких как JavaScript-файлы, CSS-шаблоны и изображения.

Кроме того, могут понадобиться и другие действия (ресурсы, услуги и т. д.). languages/ Каталог содержит файлы с международными переводами (.po/.mo), а также ещё один файл… uninstall.php Плагины предназначены для обработки файлов и выполнения задач по очистке системы при их удалении. Рациональная структура каталогов является основой для создания удобных в обслуживании и расширяемых плагинов.

Жизненный цикл плагинов и стандартные хаки (hooks)

Плагины WordPress взаимодействуют с основной системой с помощью ряда так называемых “хуков” (hooks). Для понимания жизненного цикла плагина важно знать порядок их выполнения. Когда WordPress обрабатывает запрос, он последовательно загружает основные файлы системы, тему (theme) и активированные плагины.

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

Разработчики плагинов могут воспользоваться этими возможностями. register_activation_hook Выполнять однократные задачи при активации плагина, например, создание таблиц в базе данных. То же самое касается и других случаев.register_deactivation_hook Данный механизм предназначен для выполнения действий при отключении плагинов (имейте в виду, что это не их удаление). register_uninstall_hook Или независимый… uninstall.php Файлы используются для очистки данных при удалении плагина из системы WordPress.

В повседневной эксплуатации наиболее часто используемыми типами «хуков» (hooks) являются действия (Actions) и фильтры (Filters). Действия позволяют вам выполнять определенные операции в определенные моменты времени (например, при срабатывании определенного события). initДля выполнения определенных функций необходимо вставить соответствующий код; фильтры, напротив, позволяют изменять данные, передаваемые другим функциям. the_content）。

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

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

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

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

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

Создайте короткий код для вывода контента.

Шорткоды (Shortcodes) – это мощный инструмент, позволяющий пользователям вставлять динамический контент в статьи или страницы с помощью простого тега. Вы можете использовать их для различных целей: добавления изображений, видео, форм, разметки и многого другого. add_shortcode Функция позволяет зарегистрировать собственный короткий код.

Например, следующий код зарегистрирует объект с именем… greet Это короткий код, который принимает один параметр. name “Привет, пользователь! Мы хотим познакомить вас с некоторыми свойствами нашего продукта…”

function myplugin_greet_shortcode( $atts ) {
    // 使用 shortcode_atts 函数设置默认值并合并用户属性，确保安全性
    $atts = shortcode_atts( array(
        'name' => '访客',
    ), $atts, 'greet' );

// 在输出前对用户输入进行转义
    $name = esc_html( $atts['name'] );
    return '<p>Здравствуйте, '.$name.'! Добро пожаловать на наш сайт.</p>'add_shortcode( 'greet', 'myplugin_greet_shortcode' );

Пользователи могут вводить текст в редакторе статей. [greet name=“小明”]На переднем энде будет отображаться сообщение: “Здравствуй, Сяомин! Добро пожаловать на наш сайт”. Помните, что все данные, полученные от пользователей, должны быть соответствующим образом обработаны (эскапированы или проверены) перед их выводом, как это было сделано в приведённом примере. esc_html。

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

Добавьте страницу настроек для плагина.

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

Во-первых, используйте add_options_page или add_menu_page Добавьте пункт меню и страницу в административную панель с помощью соответствующих функций. После этого используйте их. register_setting、add_settings_section и add_settings_field Используйте такие функции, как `define`, чтобы определить параметры настроек.

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

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

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

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

function myplugin_add_admin_menu() {
    add_options_page(
        '我的插件设置',          // 页面标题
        '我的插件',              // 菜单标题
        'manage_options',        // 所需权限
        'myplugin-settings',     // 菜单 Slug
        'myplugin_settings_page' // 用于渲染页面的回调函数
    );
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );

function myplugin_settings_init() {
    register_setting( 'myplugin_settings_page', 'myplugin_settings' );
    add_settings_section( 'myplugin_section', '基础设置', null, 'myplugin_settings_page' );
    add_settings_field(
        'api_key',
        'API 密钥',
        'myplugin_api_key_field_render', // 渲染输入字段的函数
        'myplugin_settings_page',
        'myplugin_section'
    );
}
add_action( 'admin_init', 'myplugin_settings_init' );

function myplugin_api_key_field_render() {
    $options = get_option( 'myplugin_settings' );
    $value = isset( $options['api_key'] ) ? esc_attr( $options['api_key'] ) : '';
    echo '<input type="text" name="myplugin_settings[api_key]" value="' . $value . '" />';
}

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

Использование API настроек позволяет гарантировать безопасное сохранение параметров вашего плагина. wp_options Данные хранятся в таблице, а интерфейс управления соответствует стилю WordPress.

Соблюдение лучших практик разработки (Best Practices in Development)

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

Обеспечение безопасности кода

Безопасность является одним из главных приоритетов при разработке плагинов. Все данные, вводимые пользователями (включая данные из URL-адресов, форм, cookies и базы данных), необходимо проверять, очищать и обрабатывать (например, с использованием специальных механизмов экранирования угроз). Для этого можно воспользоваться рядом функций, предоставляемых системой WordPress. esc_html、esc_url、sanitize_text_field Обработайте результаты; используйте их. wp_verify_nonce и check_admin_referer Для проверки законности запроса и предотвращения атак типа CSRF (Cross-Site Request Forgery).

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

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

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

Определите это в комментариях, расположенных в начале вашего плагина. Text Domain(Например, my-first-pluginи Domain PathВ коде используйте < для всех строк, которые необходимо перевести. __() Провести перевод. _e() Выполните перевод и выведите результат напрямую, используя _n() Обработка форм числа единственного и множественного.

Пример:$text = __(‘Hello World’， ‘my-first-plugin’);Затем вы можете использовать такие инструменты, как Poedit, для создания нужного контента. .pot Шаблонный файл, предназначенный для создания переводчиками. .po и .mo Файлы. Поместите переведенные файлы в корневой каталог плагина. /languages После создания папки WordPress автоматически загрузит соответствующие переводы в зависимости от языка сайта.

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

Плагины с плохой производительностью могут замедлять работу всего веб-сайта. Следует избегать запуска большого количества ненужного кода при каждом загрузке страницы. Скрипты и стили, используемые только в фоновом режиме, следует включать только при наличии соответствующих условий (например, на основе пользовательских настроек is_admin()Ресурсы фронтенда загружаются только в фоновом режиме; основные данные передаются через… wp_enqueue_script() и wp_enqueue_style() В соответствующих моментах (например, во время выполнения определённых операций или при срабатывании определённых условий)… wp_enqueue_scriptsЗагрузка происходит в очереди.

Для длительных операций или вызовов внешних API рассмотрите возможность использования API Transients в WordPress.set_transient， get_transientВыполняется кэширование данных. Кроме того, обеспечивается возможность корректного удаления или отключения плагина. uninstall.php Необходимо очистить созданные вами таблицы базы данных и параметры, однако делать это следует осторожно, предоставив пользователям возможность выбора: удалить данные или нет.

Отладка, тестирование и публикация

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

Использование инструментов отладки в WordPress

На этапе разработки настоятельно рекомендуется включить режим отладки в WordPress. wp-config.php Настройки, заданные в файле define(‘WP_DEBUG’， true);Это позволит отображать все ошибки, предупреждения и сообщения PHP, что поможет вам быстро выявить проблему. Вы также можете включить это функциональность одновременно. WP_DEBUG_LOG Записывайте ошибки в файлы журнала или включите эту функцию. SCRIPT_DEBUG Для удобства отладки используются несжатые файлы JavaScript и CSS.

Подготовка информации для публикации плагина

Если вы планируете отправить плагин в официальный каталог плагинов WordPress.org, вам потребуется подготовить ряд документов. К ним относится подробное описание плагина, его функций и способа использования, а также другие необходимые материалы. readme.txt Файл должен соответствовать формату, предусмотренному для плагинов WordPress, и включать описание плагина, инструкции по установке, ответы на часто задаваемые вопросы, логи обновлений и другую полезную информацию. Также необходимо предоставить качественные изображения баннеров и иконок, а также заполнить описание SVN-репозитория плагина.

На уровне кода убедитесь, что все необходимые меры по поддержке международной локализации (и-нтернационализации) выполнены, и тщательно проверьте, соответствует ли ваш код стандартам кодирования WordPress. Для проверки можно использовать инструмент PHP_CodeSniffer вместе с правилами кодирования WordPress.

Проведение тестов на совместимость между различными средами (cross-environment compatibility testing)

Перед публикацией необходимо тестировать ваш плагин в различных условиях. Это включает проверку его совместимости с разными версиями WordPress (особенно с текущей и предыдущей основной версией), различными версиями PHP (например, PHP 7.4, 8.0, 8.1), различными версиями баз данных (MySQL/MariaDB), а также с популярными темами и другими плагинами. Убедитесь, что ваш плагин не выдает ошибок или предупреждений на этапах активации, деактивации, настройки и использования.

резюме

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

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

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

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

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

Добавление уникальных префиксов к названиям всех ваших функций, классов, констант, меток действий/фильтров, а также имен параметров является наиболее эффективным способом предотвращения конфликтов. Не используйте общие названия. add_user() или $countВместо этого следует использовать префикс, соответствующий вашему плагину. Например: myplugin_add_user() или $myplugin_countКонсервативной практикой также является инкапсулирование вашего кода в классы или пространства имен. Кроме того, при использовании скриптов для обработки очередей и стилей рекомендуется применять уникальные идентификаторы (хендлеры), а также учитывать возможность загрузки ресурсов по мере необходимости.

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

Для простых настроек можно воспользоваться API параметров (Options API) WordPress.add_option, get_option, update_optionСохранить данные в… wp_options В таблицах представлен самый простой и стандартный способ хранения данных. Однако если вам необходимо сохранять большие объемы структурированных пользовательских данных (например, информацию о продуктах, заказах и т. д.), следует создать собственные таблицы в базе данных. $wpdb Объект, и он активируется при запуске плагина. dbDelta() Существуют функции для создания и обновления структуры таблиц, что обеспечивает совместимость между различными версиями баз данных.

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

WordPress предлагает два основных способа реализации данной функции. Первый из них заключается в использовании… register_uninstall_hook() Функция регистрирует хук для деинсталляции. Второй, и более рекомендуемый способ – это создание отдельного файла в корневой директории плагина. uninstall.php Файл. В этом файле необходимо проверить, был ли вызов изнутри системы WordPress. WP_UNINSTALL_PLUGIN Сначала устанавливается константа, затем выполняется действие по удалению пользовательских настроек (с использованием соответствующего инструмента или скрипта). delete_optionКроме того, выполняются операции по очистке, такие как удаление пользовательских настроек и данных из пользовательских таблиц базы данных. Обязательно укажите в описании плагина, какие данные будут удалены в результате этих действий.