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

Подготовка и настройка окружения

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

Настройка локальной среды разработки.

Мы рекомендуем использовать локальную серверную среду, такую как Local by Flywheel, XAMPP или MAMP. Эти инструменты позволяют быстро настроить на вашем компьютере среду для работы WordPress с использованием серверов Apache/Nginx, базы данных MySQL и языка программирования PHP. Убедитесь, что версия PHP, установленная у вас, совместима с версией, предусмотренной для вашего целевого сервера, и включите функцию отчетов об ошибках — это поможет быстро выявлять проблемы на этапе разработки.

Выбор кодовых редакторов и инструментов

Первым шагом является выбор мощного кодового редактора — например, Visual Studio Code, PhpStorm или Sublime Text. Эти редакторы обычно поддерживают выделение синтаксиса кода, предложения по его написанию и интеграцию с системами управления версиями. Кроме того, установка инструментов для оптимизации кода (например, PHP_CodeSniffer) и отладки (например, Xdebug) значительно улучшит ваше рабочее процессе и качество написанного кода.

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

Создайте свой первый плагин.

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

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

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

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

Основной файл плагина и базовая информация о заголовках (headers)

Каждый плагин для WordPress должен иметь основной PHP-файл, который должен содержать стандартную информацию заголовка плагина, чтобы WordPress мог его распознать. Мы создаем файл с названием… my-first-plugin.php Файл.

Вставьте этот код в указанный файл, затем загрузите его в каталог, где расположена установленная версия WordPress. /wp-content/plugins/my-first-plugin/ Внутри папки.

<?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 и активировать его, нажав кнопку “Включить”. В настоящее время у плагина нет никаких функций, но вы успешно создали плагин, признанный системой WordPress.

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

Одной из распространённых задач является создание страницы для управления плагинами в режиме администрирования. Для этого можно воспользоваться инструментами, предоставляемыми системой WordPress. add_menu_page() или add_options_page() Реализовать с помощью функции.

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

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

// 钩子：在管理员菜单中添加一个新的页面
add_action('admin_menu', 'mfp_add_admin_menu');

function mfp_add_admin_menu() {
    add_options_page(
        '我的插件设置',          // 页面标题
        '我的插件',             // 菜单标题
        'manage_options',       // 所需权限
        'my-first-plugin',      // 菜单slug
        'mfp_settings_page_html' // 用于显示页面内容的回调函数
    );
}

// 设置页面的HTML内容
function mfp_settings_page_html() {
    // 检查用户权限
    if (!current_user_can('manage_options')) {
        return;
    }
    ?>
    <div class="wrap">
        <h1><?php echo esc_html(get_admin_page_title()); ?></h1>
        <p>Добро пожаловать на страницу настроек моего первого плагина!</p>
        <form action="/ru/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            // 输出设置字段（后续可在此添加）
            settings_fields('mfp_options_group');
            do_settings_sections('my-first-plugin');
            submit_button('保存设置');
            ?>
        <input type="hidden" name="trp-form-language" value="ru"/></form>
    </div>
    &lt;?php
}

Этот код используется… add_action() Хук (hook) используется для вызова функции в определенный момент выполнения программы. mfp_add_admin_menu Подключённый к WordPress admin_menu Что касается действий: при создании меню администратора наша функция будет вызвана, в результате чего будет добавлено новое подменю под главным меню “Настройки”. При нажатии на это подменю будет выполнено соответствующее действие. mfp_settings_page_html Функция используется для отображения содержимого страницы.

Понимание хуков (hooks) и фильтров в WordPress

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

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

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

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

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

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

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

add_action('wp_footer', 'mfp_add_footer_note');

function mfp_add_footer_note() {
    if (is_single()) { // 仅在文章页面显示
        echo '<p style="text-align:center; color:#666;">Этот текст представлен вам благодаря моему плагину.</p>';
    }
}

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

Фильтрующие хаки (filter hooks) предназначены для изменения данных перед их использованием или сохранением в базе данных. Они предполагают, что вы получите определенное значение, выполните необходимые изменения и затем вернете измененное значение. Мы используем их в нашем коде. add_filter() Функция предназначена для монтирования (присоединения) обратных вызовов (callback functions).

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

Классическим примером является изменение длины резюме статьи. По умолчанию в WordPress длина резюме составляет 55 слов, и мы можем это изменить. excerpt_length Используйте фильтры для его изменения.

add_filter('excerpt_length', 'mfp_custom_excerpt_length');

function mfp_custom_excerpt_length($length) {
    // 将摘要长度修改为 20 个单词
    return 20;
}

В этом примере функция… mfp_custom_excerpt_length Получено значение по умолчанию для длины. $lengthЗатем возвращается наша пользовательский заданный новый значение длины — 20. WordPress использует это значение для генерации резюме.

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

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

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

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

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

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

Никогда не доверяйте данным, введенным пользователем, или данным, полученным из базы данных. Перед обработкой любых данных необходимо их проверить, очистить и обработать (например, с помощью специальных механизмов экранирования).
* 验证（Validation）：检查数据是否符合预期的格式或类型（如是否是邮箱、数字等）。可以使用 filter_var() Функция или связанная с WordPress… sanitize_*() Серия функций.
* 清理（Sanitization）：清除数据中的非法或危险字符，使其变得安全。对于表单输入，常用 sanitize_text_field()。
* 转义（Escaping）：在将数据输出到 HTML、JavaScript 或 URL 时，根据上下文进行转义，以防止跨站脚本（XSS）攻击。WordPress 提供了丰富的转义函数，如 esc_html()、esc_attr()、esc_url() и wp_kses_post()。

Например, безопасный способ вывода переменной, полученной из базы данных:

// 假设 $user_input 是从数据库或表单获取的数据
echo '<div class="info">'`.esc_html($user_input)`.'</div>';
// 或者，如果允许一些安全的HTML标签
echo '<div class="info">'. wp_kses_post($user_input)'.'</div>';

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

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

Во-первых, во всех строках, которые необходимо перевести, используйте соответствующие функции для их обработки. Наиболее распространенными из таких функций являются… __()(Используется для возвращения значения) и _e()(Используется для прямого отображения результата выполнения команды/процесса.)

Измените заголовок управленческой страницы, которую мы создали ранее:

function mfp_settings_page_html() {
    if (!current_user_can('manage_options')) {
        return;
    }
    ?>
    <div class="wrap">
        <h1><?php echo esc_html(get_admin_page_title()); ?></h1>
        <p><?php _e('欢迎来到我的第一个插件的设置页面！', 'my-first-plugin'); ?></p>
        ...
    </div>
    &lt;?php
}

Обратите внимание: каждая функция перевода содержит параметр текстового поля (`my-first-plugin`), который должен соответствовать информации, определенной в заголовочном файле плагина. Text Domain Полностью согласен. Затем вы можете использовать такие инструменты, как Poedit, чтобы сканировать тексты, подлежащие переводу, в коде плагинов и сгенерировать необходимые файлы для перевода. .pot Шаблонные файлы, а также файлы, предназначенные для перевода на разные языки. .po и .mo Переведите файл и поместите его в каталог плагинов. /languages/ Внутри папки.

резюме

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

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

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

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

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

Во-первых, в файле wp-config.php включите режим отладки WordPress. Для этого выполните следующие действия: define('WP_DEBUG', true); и define('WP_DEBUG_LOG', true); Установите значение на `true`. В этом случае сообщения об ошибках будут записываться в файл `/wp-content/debug.log`, что предотвратит их отображение пользователям. Кроме того, интеграция профессиональных инструментов отладки, таких как Xdebug, с вашим кодовым редактором (например, VS Code), позволит использовать такие функции, как установка точек остановки и одношаговая отладка. Кроме того, с помощью панелей сети и консоли в разработческих инструментах браузера можно проверять AJAX-запросы и ошибки в JavaScript-коде на стороне клиента.

Как можно отправить плагин, разработанный мной, в официальный каталог плагинов WordPress?

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

Как добавить опцию настроек для моего плагина в пользовательский интерфейс WordPress (WordPress Customizer)?

Предварительный просмотр настроек в WordPress через инструмент Customizer позволяет вам видеть, как изменения будут выглядеть в реальном времени. Вы можете использовать этот инструмент для легкой настройки внешнего вида вашего сайта без необходимости предварительного сохранения изменений. add_action('customize_register', 'your_function'); Хук (hook) – это механизм, позволяющий вызывать функцию в определённый момент выполнения программы. Обычно используется в контексте обратных вызовов (callbacks). your_function В $wp_customize К объекту были добавлены раздел (Section), параметр настройки (Setting) и элемент управления (Control). Это позволяет пользователям изменять параметры в интерфейсе настраивания и немедленно видеть результаты изменений на переднем плане (в пользовательском интерфейсе сайта), что особенно удобно для управления внешним видом тем и плагинов.