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

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

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

Вам понадобится кодовый редактор, такой как Visual Studio Code или PHPStorm. Visual Studio Code пользуется популярностью среди многих разработчиков благодаря своей легкости в использовании и мощной экосистеме плагинов (например, PHP Intelephense, WordPress Snippet). Кроме того, использование системы управления версиями (например, Git) для работы с кодом плагинов является хорошей практикой: это позволяет отслеживать изменения, создавать новые ветки и при необходимости возвращаться к предыдущим стабильным версиям плагинов.

Планирование структуры основных файлов

Плагин с четкой структурой не только облегчает его собственное обслуживание, но и понимание другими разработчиками. Стандартный плагин для WordPress содержит по меньшей мере один основной PHP-файл, имя которого обычно совпадает с названием плагина. Рекомендуется с самого начала проекта спланировать структуру каталогов. Например:

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

your-plugin/
│
├── your-plugin.php      // 主文件，包含插件头部信息
├── uninstall.php        // 可选，插件卸载时执行的清理脚本
├── includes/            // 存放核心功能类或函数文件
│   ├── class-core.php
│   └── functions.php
├── admin/               // 后台相关文件
│   ├── css/
│   ├── js/
│   └── class-admin.php
├── public/              // 前端相关文件
│   ├── css/
│   ├── js/
│   └── class-public.php
├── assets/              // 静态资源（图片、字体等）
└── languages/           // 国际化翻译文件（.po, .mo）

Такая модульная структура позволяет разделить логику бэкенда и фронтенда, что упрощает управление кодом и его расширение.

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

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

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

Создание первого основного файла плагина

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

Вот пример самого базового файла плагина. Создайте файл с названием… my-first-plugin.php Файл должен быть загружен и размещен в WordPress. wp-content/plugins Каталог.

<?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
 */

// 防止直接访问文件
if ( ! defined( 'ABSPATH' ) ) {
    exit;
}

// 定义一个插件常量，便于引用插件目录路径
if ( ! defined( 'MFP_PLUGIN_DIR' ) ) {
    define( 'MFP_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
}

// 包含其他必要文件
require_once MFP_PLUGIN_DIR . 'includes/functions.php';

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

Расширение функционала с помощью Hook’ов (действий и фильтров)

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

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

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

// Пример: автоматическое добавление текста в верхнюю часть контента статьи
function mfp_add_text_to_content( $content ) {
    if ( is_single() ) {
        $custom_text = '<p>Спасибо, что прочитали эту статью!</p>'функция mfp_add_text_to_content() принимает в качестве аргумента текст, который необходимо добавить в контент, и возвращает результат, который затем используется в качестве контента для текущей страницы.  

function mfp_add_text_to_content() {  
    global $post;  
    $custom_text = get_the_content( $post );  
    if ( ! empty( $custom_text ) ) {  
        $$content = $custom_text . $$content;  
    }  
    return $$content;  
}
// Прикрепляем функцию к хуку фильтра ‘the_content'  
add_filter( 'the_content', 'mfp_add_text_to_content' );

Фильтровые хенки (filter hooks) позволяют вам изменять данные. Они принимают значение, которое после обработки вашей функцией должно быть возвращено. Приведённый выше пример является именно таким фильтром: он изменяет содержимое статьи. $contentПонимание и умелое использование хуков (hooks) является ключом к созданию мощных и совместимых плагинов.

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

Большинство плагинов требуют наличия страницы для настройок в бэкенде. WordPress предоставляет функции для создания главного меню и вложенных меню. add_menu_page() и add_submenu_page()。

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

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

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

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

// 在admin_init钩子中注册设置
add_action( 'admin_init', 'mfp_register_settings' );
function mfp_register_settings() {
    register_setting(
        'mfp_settings_group', // 设置组名
        'mfp_option_name',    // 选项名
        'sanitize_text_field' // 清理回调函数
    );

add_settings_section(
        'mfp_section_id',     // 区块ID
        '示例设置区块',       // 区块标题
        null,                 // 区块说明回调函数
        'mfp-settings-page'   // 所属页面slug
    );

add_settings_field(
        'mfp_field_id',       // 字段ID
        '示例文本字段',       // 字段标签
        'mfp_field_callback', // 字段渲染回调函数
        'mfp-settings-page',  // 页面slug
        'mfp_section_id'      // 所属区块ID
    );
}

// 渲染字段的HTML
function mfp_field_callback() {
    $option = get_option( 'mfp_option_name' );
    echo '<input type="text" name="mfp_option_name" value="' . esc_attr( $option ) . '" />';
}

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

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

В коде используется… __() Переведите и верните строку, используя _e() Переводите и выведите текст непосредственно. Вам необходимо определить это в начале кода плагина. Text Domain(Например, ‘my-first-plugin’), и использовать его в подходящий момент. load_plugin_textdomain() Функция для загрузки файлов с переводами.

Рекомендуемое чтение Овладейте основными навыками работы с WordPress и создавайте профессиональные сайты, которые сочетают в себе функциональность и эстетику.。

// 示例：加载翻译文件
add_action( 'plugins_loaded', 'mfp_load_textdomain' );
function mfp_load_textdomain() {
    load_plugin_textdomain( 'my-first-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
}

// 在代码中使用翻译函数
$message = __( 'Hello, world!', 'my-first-plugin' );
_e( 'Settings saved successfully!', 'my-first-plugin' );

Перед публикацией обязательно проведите тщательные тесты, включая проверку совместимости с различными версиями PHP, WordPress, а также с использованием разных тем и плагинов. Удалите все коды, используемые для отладки, сжмите фронтенд-ресурсы (CSS/JS), и подготовьте подробное описание процесса разработки. readme.txt В конце концов, вы можете разместить свой плагин в официальном каталоге плагинов WordPress или на сторонних рынках, чтобы поделиться своими разработками с пользователями по всему миру.

резюме

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

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

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

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

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

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

Как обеспечить, чтобы плагин, который я разрабатываю, был безопасным и эффективным?

Что касается безопасности, вводимые пользователем данные всегда проверяются и очищаются. Для этого используются функции, предоставляемые WordPress, а также проверки прав доступа (например, функции, связанные с полем non_ces). check_admin_referer() и current_user_can()При выводе данных в браузер обязательно используйте соответствующие функции экранирования (escaping functions). esc_html()、esc_attr()Что касается эффективности, следует избегать ненужных запросов к базе данных, разумно использовать API Transients для кэширования данных, а также обеспечивать загрузку файлов CSS и JavaScript только тем страницам, где они действительно необходимы (правильное применение этих механизмов). wp_enqueue_style() и wp_enqueue_script()）。

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

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

Что особенно важно учитывать при публикации плагина на сайте WordPress.org?

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