Вступне керівництво з розробки плагінів для WordPress: створіть свій перший налаштований плагін з нуля.

Підготовка середовища для розробки плагінів для WordPress

Перш ніж почати писати код, вам знадобиться відповідне середовище розробки. Це не лише підвищить вашу ефективність роботи, але й допоможе краще налагоджувати та тестувати плагіни. Спочатку вам потрібно налаштувати середовище для роботи з WordPress на вашому локальному комп’ютері. Ви можете використовувати інтегровані середовища розробки, такі як XAMPP, MAMP або Local by Flywheel – вони дозволяють швидко встановити PHP, MySQL та сервери Apache/Nginx. Для основних файлів WordPress рекомендується завантажувати та встановлювати найновіші стабільні версії з офіційного сайту.

Переконайтеся, що ваша версія PHP відповідає мінімальним вимогам WordPress, та увімкніть функцію звітування про помилки – це дуже важливо для налагодження проблем. Ви можете це зробити у налаштуваннях вашого сервера чи через панель керування WordPress.wp-config.phpДодайте наступний код до файлу, щоб увімкнути режим налагодження:

define('WP_DEBUG', true);
define('WP_DEBUG_LOG', true); // 将错误记录到 /wp-content/debug.log
define('WP_DEBUG_DISPLAY', false); // 不在页面上显示错误

Крім того, незамінним є потужний редактор коду, такий як Visual Studio Code,PhpStorm або Sublime Text. Ці редактори зазвичай мають функції підсвічування синтаксису, підказок під час написання коду та інтеграції з системами контролю версій, що значно покращує процес програмування. Також рекомендується встановити розробницькі інструменти у браузері та використовувати додатки, спеціально розроблені для роботи з WordPress, щоб полегшити перевірку функцій сайту, виконання запитів до бази даних та моніторинг продуктивності.

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

Створіть свій перший файл плагіна.

Найбазовішою формою плагіна для WordPress є файл на мові PHP. Усі плагіни зберігаються у певному каталозі системи WordPress./wp-content/plugins/Кожен плагін може бути окремим PHP-файлом або папкою, яка містить кілька файлів.

UltaHost – хостинг для сайтів, побудованих на платформі WordPress

Гарантія повернення грошей протягом 30 днів, необмежена пропускна здатність мережі та доступ до баз даних, безкоштовний захист від DDoS-атак; знижка 50% при покупці на термін 3 роки (варіанти об’ємів трафіку: 4 ТБ/5

сторінка доступу

Спочатку створіть для свого плагіна папку з унікальною назвою, наприклад:my-first-pluginУ цьому папці створіть основний файл плагіна; його зазвичай називають так само, як і папку.my-first-plugin.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
 * Domain Path:       /languages
 */

У цьому коментарі поле “Plugin Name” є обов’язковим; воно визначає ім’я плагіна, яке відображається на інтерфейсі адміністрування в бекенді. Інша інформація, така як версія плагіна та автор, допомагає користувачам краще ознайомитися з ним. Після створення цього файлу розмістіть його у відпов/wp-content/plugins/my-first-plugin/Ось як це зробити: увійдіть у свій обліковий запис WordPress у менеджері, перейдіть на сторінку “Плагіни” (Plugins). Там ви повинні побачити новий плагін під назвою “Мій перший кастомізований плагін” (My First Customized Plugin) та зможете його активувати. Хоча наразі він нічого не робить, ви успішно створили базову структуру плагіна.

Обробка активації та деактивації плагінів

Під час активації та деактивації плагінів часто потрібно виконати певні ініціалізаційні та очищувальні процедури – наприклад, створити таблиці в базі даних, встановити параметри за замовчуванням чи видалити тимчасові дані. WordPress використовує два спеціальні механізми (хуки, англ. hooks) для керування цими процregister_activation_hook和register_deactivation_hook。

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

Ви можете визначити ці „хаки“ (hooks) у основному файлі плагіна. Наприклад, коли плагін активується, ми можемо захотіти записати певний параметр конфігурації у базу даних; коли плагін вимкнений, може знадобитися видалити цей параметр. Код для реалізації цього виглядає так:

// 定义插件激活时执行的函数
function my_plugin_activate() {
    // 添加一个默认选项到数据库
    add_option('my_plugin_default_option', '这是默认值');
    // 或者可以在这里初始化自定义数据库表（需要更复杂的SQL）
}
register_activation_hook(__FILE__, 'my_plugin_activate');

// 定义插件停用时执行的函数
function my_plugin_deactivate() {
    // 删除之前创建的选项
    delete_option('my_plugin_default_option');
    // 注意：通常不在停用钩子中删除数据，以免用户重新激活时丢失设置
    // 更常见的清理工作在卸载钩子中处理
}
register_deactivation_hook(__FILE__, 'my_plugin_deactivate');

Варто звернути увагу на те, що…register_deactivation_hookЗазвичай це використовується для легкого очищення системи, а постійне видалення даних (наприклад, таблиць з бази даних) має виконуватися у механізмах, пов’язаних з процесом видалення програми. Функції видалення повинні бути реалізовані через спеregister_uninstall_hookЗареєструйтеся. Раціональне використання цих „хуків“ (hooks) допоможе забезпечити належну поведінку вашого плагіна та уникнути накопичення зайвих даних на веб-сайті.

Зрозуміти та використовувати хуки й фільтри.

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

hosting.com Віртуальний хостинг

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

сторінка доступу

Акційні хаки (action hooks) дозволяють вам виконувати власні функції під час виникнення певних подій. Наприклад, після публікації статті…publish_postПід час завантаження вгорі веб-сторінки;wp_head) або під час ініціалізації в адміністративному інтерфейсіadmin_initВи можете використовувати…add_action()Функція для монтажу вашого коду. Ось простий приклад: вона автоматично додає фрагмент користувацького тексту наприкінці кожної статті.

function add_custom_footer_to_content($content) {
    if (is_single()) { // 仅在单篇文章页面添加
        $custom_text = '<p><em>Дякуємо, що прочитали цю статтю!</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
// 使用‘the_content’过滤器，注意这是一个过滤器（Filter）的例子
add_filter('the_content', 'add_custom_footer_to_content');

Як показано у вищенаведеному коді, ми насправді використовуємо фільтри (filters). Фільтри мають спеціальні механізми (хаки, hooks), які дозволяють модифікувати дані, що надаються їм. Основна відмінність фільтрів від інших механізмів обробки даних полягає у тому, що фільтри обов’язково мають повертати модифіthe_content(Зміна змісту статті)the_title(Змінено заголовок) Іexcerpt_length(Змінено довжину резюме). Відповідно до цього…add_filter()Функція призначена для монтування фільтрів.

Створення власних хуків для розширення можливостей системи

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

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

Наприклад, перед тим, як ваш плагін обробить певні дані, можна надати фільтр, який дозволяє іншим особам змінювати вхідні параметри:

// 定义插件的主要处理函数
function my_plugin_process_data($input_data) {
    // 在核心处理前，允许其他开发者通过过滤器修改 $input_data
    $filtered_data = apply_filters('my_plugin_filter_input', $input_data);

// ... 使用 $filtered_data 进行核心处理 ...

// 在处理完成后，触发一个动作钩子，通知其他开发者
    do_action('my_plugin_after_processing', $filtered_data);

return $result;
}

Створюючи власні хаки (custom hooks), ваш плагін набуває високої розширюваності та відповідає філософії розробки самого WordPress.

Міжсерверний віртуальний хостинг

Віртуальний хостинг $2.50 USD на місяць, перший місяць $0.1 USD за промокодом tryinterserver, 461 скрипт хмарних додатків, встановлення в один клік.

сторінка доступу

Додайте сторінку керування та параметри налаштувань для плагіна.

Більшість практичних плагінів потребують інтерфейсу для керування з бекенду, щоб адміністратори веб-сайтів могли налаштовувати їхні параметри. WordPress надає розширену API для створення меню керування та сторінок налаштувань.

По-перше, вам потрібно використати…add_action('admin_menu', 'your_function')Щоб зареєструвати елемент меню, використовуйте відповідні функції.add_menu_page()或add_submenu_page()Функції для додавання верхнього меню чи підменю. Ось приклад базового коду для додавання верхнього меню та налаштування сторінки:

// 钩入 admin_menu 来添加管理菜单
function my_plugin_add_admin_menu() {
    add_menu_page(
        '我的插件设置',           // 页面标题
        '我的插件',               // 菜单标题
        'manage_options',         // 权限（管理员）
        'my-plugin-settings',     // 菜单slug
        'my_plugin_settings_page', // 用于显示页面内容的回调函数
        'dashicons-admin-generic', // 图标（Dashicon）
        80                         // 菜单位置
    );
}
add_action('admin_menu', 'my_plugin_add_admin_menu');

// 定义设置页面的显示内容
function my_plugin_settings_page() {
    // 检查用户权限
    if (!current_user_can('manage_options')) {
        return;
    }
    ?>
    <div class="wrap">
        <h1><?php echo esc_html(get_admin_page_title()); ?></h1>
        <form action="/uk/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            // 输出设置字段和非ce字段
            settings_fields('my_plugin_options_group');
            do_settings_sections('my-plugin-settings');
            submit_button('保存设置');
            ?>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    &lt;?php
}

Поля для налаштування реєстрації та підтвердження

Просто мати сторінки недостатньо – вам потрібно використовувати API налаштувань WordPress для безпечної реєстрації, зберігання та підтвердження параметрів налаштувань. Цей процес включає в себе використання…register_setting()、add_settings_section()和add_settings_field()Функції типу “wait” тощо.

Наведений нижче код демонструє, як зареєструвати групу параметрів налаштувань та текстове поле:

// 初始化插件设置
function my_plugin_settings_init() {
    // 注册一个设置选项组及其数据
    register_setting(
        'my_plugin_options_group', // 选项组名，需与settings_fields()参数一致
        'my_plugin_settings',      // 存储在wp_options表中的选项名
        'my_plugin_sanitize_input' // 可选的验证回调函数
    );

// 添加一个设置区域
    add_settings_section(
        'my_plugin_section_main',
        '主要设置',
        null, // 区域描述的回调函数，可为空
        'my-plugin-settings' // 所属页面的slug
    );

// 向该区域添加一个具体的字段
    add_settings_field(
        'my_plugin_field_text',
        '示例文本字段',
        'my_plugin_field_text_render', // 渲染字段HTML的回调函数
        'my-plugin-settings',
        'my_plugin_section_main'
    );
}
add_action('admin_init', 'my_plugin_settings_init');

// 渲染文本输入字段的函数
function my_plugin_field_text_render() {
    $options = get_option('my_plugin_settings');
    $value = $options['text_field'] ?? ''; // PHP 7.0+ 空合并运算符
    ?>
    <input type='text' name='my_plugin_settings[text_field]' value='<?php echo esc_attr($value); ?>'>
    <?php
}

// 清理和验证输入的函数
function my_plugin_sanitize_input($input) {
    $sanitized_input = [];
    if (isset($input['text_field'])) {
        // 清理文本输入，移除非法标签
        $sanitized_input['text_field'] = sanitize_text_field($input['text_field']);
    }
    return $sanitized_input;
}

За допомогою API налаштувань (Settings API) WordPress автоматично обробляє збереження параметрів, перевірку їх безпеки та перевірку прав доступу, що значно спрощує процес розробки та підвищує рівень безпеки.

підсумок

За допомогою цього посібника ми систематично пройшли основні етапи розробки плагінів для WordPress: від налаштування середовища роботи та створення базових файлів плагіна до розуміння та використання основних механізмів взаємодії („хаків“) системи, а також до додавання професійного інтерфейсу керування та параметрів налаштувань для плагіна. На кожному етапі були наведені ключові фрагменти коду та стандартні практики розробки. Суть розробки плагінів полягає у ефективному використанні величезної системи хаків WordPress для розширення її функціоналу, а також у дотриманні її API-стандартів для забезпечення безпеки та сумісності. Пам’ятайте, що ефективним шляхом створення якісного плагіна є початок з простої ідеї, поступове додавання нових функцій та ретельне тестування на кожному етапі розробки. Далі ви зможете дізнатися більше про складніші аспекти розробки плагінів, такі як створення власних типів статей, використання скорочених кодів („шорткодів“), обробка AJAX-запитів та інтернаціоналізація плагіна.

Часті запитання

Чи обов’язково для розробки плагінів для WordPress потрібно досконало володіти мовою програмування PHP?

Так, міцні знання PHP є обов’язковими. Адже ядро WordPress та його плагіни написані на PHP. Вам потрібно розуміти синтаксис PHP, функції, концепції об’єктно-орієнтованого програмування тощо. Крім того, базові знання HTML, CSS та JavaScript дуже допоможуть під час створення користувацького інтерфейсу та забезпечення його взаємодії з користувачем.

Скільки файлів має містити плагін?

Немає жодних обов’язкових вимог. Плагін може містити лише один основний PHP-файл. Однак у міру збільшення складності функцій доцільно модульність коду реалізовувати за допомогою кількох файлів.admin.phpОбробка даних у фоновому режимі.public.phpОбробка фронтенд-частини програми.includesЗберігати загальні функції у папках є кращою практикою, адже це сприяє організації та підтримці коду.

Чому після активації мого плагіна сайт відображається у вигляді „білого екрана“?

Зазвичай це спричинено фатальною помилкою (Fatal Error), наприклад, помилкою синтаксису, викликом невідомої функції чи класу. Переконайтеся, що ви все правильно зробили.wp-config.phpБуло увімкнено.WP_DEBUGМодель, і перевірте її.wp-content/debug.logУ файлі міститься інформація про помилки. Ви можете швидко відновити доступ до веб-сайту, вимкнувши свій плагін через FTP або за допомогою файлового менеджера (перейменувавши папку з плагіном).

Як безпечно обробляти дані, надіслані користувачем на фронтенді?

Ніколи не можна довіряти даним, введеним користувачем. Перед обробкою будь-яких даних, отриманих з форм, параметрів URL чи cookies, необхідно їх перевірити, очистити та ескапувати. WordPress надає безліч функцій для забезпечення безпеки.sanitize_text_field()(Очищення тексту)esc_url()(Ескапована URL)wp_kses_post()(Фільтруйте вміст за допустимими HTML-тегами) іintval()(Перетворіть на цілі числа). Під час виведення даних на HTML-сторінку обов’язково використовуйте цей формат.esc_html()、esc_attr()Функції для ескапування символів.

Як зробити так, щоб текст у моєму плагіні підтримував кілька мов?

Це потрібно реалізувати за допомогою міжнародної локалізації (i18n). У вашому коді замініть усі рядки, які потрібно перекласти, на відповідні перекладені версії.__()或_e()Функціональне обгортання. Потім правильно налаштуйте це у коментарях на початку плагіна.Text Domain和Domain PathВикористовуйте такі інструменти, як Poedit, для створення..potЦе файл-шаблон, для якого потрібно створити версії у різних мовах..po和.moWordPress автоматично завантажує відповідні переклади відповідно до мовних налаштувань сайту.