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

Підготовчі роботи перед розробкою плагінів

Перш ніж почати писати код, вам потрібно створити відповідне середовище розробки та ознайомитися з основною структурою плагінів для WordPress. Це включає вибір серверного середовища, текстового редактора або інтегрованого середовища розробки, а також чітке розуміння організації файлів плагіна.

Налаштування середовища для розробки.

Ефективне локальне середовище розробки має вирішальне значення. Рекомендується використовувати такі інструменти, як XAMPP, MAMP або Local by Flywheel, для швидкого налаштування локального сервера з підтримкою PHP, MySQL, Apache та Nginx. Ці інструменти дозволяють імітувати робоче середовище сайту в мережі, що дозволяє вам виконувати розробку та налагодження без впливу на продуктивність сайту, який знаходиться в реальному сервіруванні. Крім того, варто обрати потужний редактор коду, наприклад Visual Studio Code або PhpStorm – вони надають чудову підтримку синтаксису, підказок та функцій налагодження для мов програмування PHP, HTML, JavaScript та CSS.

Зрозуміти основну структуру плагіна.

WordPress-плагін по суті є одним або кількома файлами, які знаходяться у певній директорії вашого веб-сайту. Ці файли містять код, який додає нові функції чи змінює існуючі функції сайту. Щоб встановити плагін, ви зазвичай заван /wp-content/plugins/ Файли PHP, які знаходяться у каталозі. Кожен плагін має принаймні один головний файл, назва якого зазвичай є унікальною. my-first-plugin.phpУ верхній частині цього основного файлу міститься спеціальний коментар, який називається “інформацією про головну частину плагіна”. WordPress використовує цю інформацію для ідентифікації та відображення вашого плагіна у інтерфейсі адміністрування. Хороша структура плагіна передбачає розташування коду різних функцій у окремих підкаталогах. /includes/ Призначено для зберігання файлів основних класів./js/ 和 /css/ Використовується для зберігання ресурсів фронтенд-частини сайту./languages/ Використовується для інтернаціоналізації файлів.

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

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

Тепер давайте почнемо створювати основний файл нашого першого плагіна. Ми почнемо з написання інформації, яка буде розміщена у відповідному розділі плагіна („header“), а потім додамо просту функцію для перевірки того, чи правильно працює

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

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

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

Написати інформацію для заголовкового файлу плагіна

На початку основного файлу плагіна має бути включений стандартний блок заголовкових коментарів. Цей блок надає WordPress метадані про назву плагіна, опис, версію, автора тощо. Ось найпростіший приклад:

<?php
/**
 * Plugin Name: 我的第一个插件
 * Plugin URI:  https://yourwebsite.com/my-first-plugin
 * Description: 这是一个用于学习的简单 WordPress 插件，它将在文章底部添加一段自定义文本。
 * Version:     1.0.0
 * Author:      你的名字
 * License:     GPL v2 or later
 * Text Domain: my-first-plugin
 */

Цей код слід розмістити на початку основного PHP-файлу плагіна. Збережіть цей файл у відповідному місці. /wp-content/plugins/my-first-plugin/my-first-plugin.php Після цього, увійшовши в основний інтерфейс WordPress через панель керування, перейдіть на сторінку “Плагіни”. Там ви повинні побачити новий плагін під назвою “Мій перший плагін” та зможете його активувати. Наразі він не має жодних функцій.

Реалізація першої простої функції

Після активації плагіна ми реалізуємо класичну функцію: автоматичне додавання фрагмента користувацького тексту наприкінці кожної статті. Для цього ми використаємо… the_content Фільтри. Змініть свій основний файл та додайте наступний код під інформацією у вигляді заголовка:

/**
 * 在文章内容末尾添加自定义文本
 *
 * @param string $content 文章原始内容。
 * @return string 修改后的内容。
 */
function mfp_add_footer_text( $content ) {
    // 仅在主查询的单篇文章页面显示
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $custom_text = '<p><em>Дякуємо, що прочитали! Цю статтю підготував для вас [мій перший плагін].</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
// 将自定义函数挂载到 ‘the_content’ 过滤器
add_filter( 'the_content', 'mfp_add_footer_text' );

Після збереження файлу не потрібно оновлювати сервер; просто перейдіть на веб-сайт та відвідайте будь-яку статтю. Ви побачите, що доданий нами текст з’явився в кінці статті. Цей приклад демонструє один із основних підходів до розробки плагінів для WordPress – використання хуків (Hooks) для втручання у внутрішні процеси системи WordPress.add_filter Це функція, яка використовується для під’єднання фільтрів. the_content Це один із багатьох фільтрів, які можна використовувати для зміни вмісту.

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

Розробка основних функцій плагіна

Після оволодіння базовими знаннями ми зможемо вивчити більш потужні можливості, такі як створення сторінок керування та організація коду у класах. Це допоможе створювати більш складні, але легкі у обслуговуванні плагі

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

Багато плагінів потребують надання користувачам можливостей налаштувань. Це зазвичай досягається шляхом додавання сторінки меню до бекенду WordPress. Ось приклад додавання сторінки верхнього рівня меню:

/**
 * 在后台管理菜单中添加一个顶级菜单项
 */
function mfp_add_admin_menu() {
    add_menu_page(
        '我的插件设置', // 页面标题
        '我的插件',     // 菜单标题
        'manage_options', // 权限要求
        'mfp-settings-page', // 菜单 slug
        'mfp_render_settings_page', // 用于渲染页面的回调函数
        'dashicons-admin-generic', // 图标（可选）
        80 // 菜单位置（可选）
    );
}
add_action( 'admin_menu', 'mfp_add_admin_menu' );

/**
 * 渲染设置页面的回调函数
 */
function mfp_render_settings_page() {
    ?>
    <div class="wrap">
        <h1><p><strong>  <p><strong></h1>
        <form action="/uk/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            // 输出安全隐藏字段
            settings_fields( 'mfp_settings_group' );
            // 输出设置区块
            do_settings_sections( 'mfp-settings-page' );
            // 输出保存按钮
            submit_button( '保存设置' );
            ?>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    &lt;?php
}

Цей код використовується для… (The code is used for…) add_menu_page Функція додала новий пункт меню та вказала його параметри. mfp_render_settings_page Функція використовується для генерації HTML-коду сторінки. Щоб додати до сторінки форми, які можна зберегти, необхідно також використовувати відповідні інструменти чи механізми. register_setting, add_settings_section 和 add_settings_field Використовуйте такі функції, як `register` та `define`, для реєстрації та визначення параметрів налаштувань.

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

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

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

Організація коду за допомогою об’єктно-орієнтованого програмування

Для плагінів із трохи більш складною функціональністю використання об’єктно-орієнтованих підходів дозволяє інкапсулювати дані та функції у класах, що робить структуру коду більш зрозумілою та зменшує ймовірність конфлікт

class MyFirstPlugin {
    /**
     * 构造方法，用于初始化钩子
     */
    public function __construct() {
        add_action( 'init', array( $this, 'init' ) );
        add_filter( 'the_content', array( $this, 'modify_content' ) );
    }

/**
     * ‘init’ 钩子的回调函数
     */
    public function init() {
        // 插件初始化代码，例如注册短代码、自定义文章类型等
        load_plugin_textdomain( 'my-first-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
    }

/**
     * 修改文章内容的回调函数
     */
    public function modify_content( $content ) {
        // 类内部实现功能逻辑
        if ( is_single() ) {
            $content .= '<p>Цей контент був доданий за допомогою класної методи.</p>';
        }
        return $content;
    }
}
// 实例化插件类
new MyFirstPlugin();

Шляхом інкапсулювання функцій… MyFirstPlugin У класі всі відповідні властивості та методи зосереджені в одному області видимості. array( $this, ‘method_name’ ) Граматика цього мови дозволяє під’єднувати методи класів до певних „хаків“ (hooks) у WordPress. Цей підхід є рекомендованим способом створення середніх та великих плагінів.

Випуск та підтримка плагінів

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

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

Безпека та перевірка даних

Безпека плагінів є надзвичайно важливою. Ніколи не довіряйте даним, введеним користувачем, або даним, отриманим безпосередньо з бази даних. Перед обробкою будь-яких даних необхідно їх перевірити, очистити та виконати про
* 验证 (Validation)：检查数据是否符合预期格式（如是否为邮箱、数字）。可以使用 filter_var або WordPress sanitize_* Серія функцій.
* 清理 (Sanitization)：在将数据存入数据库或用于输出前，移除其中不安全的字符。例如，使用 sanitize_text_field Обробка текстових вхідних даних.
* 转义 (Escaping)：在将数据输出到 HTML、JavaScript 或 URL 时，必须根据上下文进行转义，以防止跨站脚本攻击。WordPress 提供了 esc_html, esc_js, esc_url 和 esc_attr Функції типу “wait” тощо.

Наприклад, під час виведення змінної, отриманої з бази даних:

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

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

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

// 假设 $user_input 是从数据库获取的文本
echo '<div class="message">'`. esc_html($user_input)`.'</div>';
// 或者用于 HTML 属性
echo '<input type="text" value="' . esc_attr( $user_input ) . '">';

Оптимізація продуктивності та кращі практики

Хороший плагін має мати мінімальний вплив на продуктивність веб-сайту. Дотримуйтеся наступних рекомендацій (найкращих практик):
* 按需加载资源：使用 wp_enqueue_script 和 wp_enqueue_style Функція дозволяє завантажувати ваші CSS- та JavaScript-файли лише на тих сторінках, де це необхідно. Це забезпечує кращу продуктивність та зменшує обсяг передаваних даних. wp_enqueue_scripts Хаки (фронтенд) та admin_enqueue_scripts Хак (в бекенді) використовується для монтування (підключення) потрібних компонентів.
* 合理使用钩子：避免在每次页面加载时都执行大量不必要的代码。将你的函数挂载到最合适的钩子上，并利用条件标签（如 is_admin(), is_single()Це дозволяє обмежити область виконання коду.
* 数据库查询优化：尽量减少直接 SQL 查询，优先使用 WordPress 的 API（如 WP_Query, get_postsЯкщо необхідно виконати власний запит, переконайтеся, що ви використовуєте правильні формати та параметри для отримання бажаних результатів. $wpdb Класи мають бути оптимізовані для ефективного виконання запитів, а також для підтримки механізмів кешування результатів цих запитів.
* 提供卸载清理选项：考虑在用户删除插件时，是否需要清理插件创建的数据（如数据库表、选项等）。可以通过注册一个卸载钩子（在单独的文件中）来实现。

підсумок

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

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

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

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

Як налаштувати та виправити помилки у своєму WordPress-плагіні?

По-перше, переконайтеся, що у вас є все необхідне для… wp-config.php У файлі увімкніть режим налагодження WordPress. WP_DEBUG Константа встановлена на значення “true”. Це забезпечує відображення PHP-помилок, попереджень та сповіщень на екрані або їх запис у файли журналів. Далі, використовуйте це значення для налаштувань системи. error_log Для відстеження значень змінних та ходу виконання програми використовуються функції чи інструменти, такі як плагін Query Monitor. Розробничі інструменти браузера (вкладки Console та Network) також є незамінними для налагодження коду на JavaScript та AJAX-запитів.

Як мій плагін може бути сумісним з різними версіями WordPress?

Під час розробки необхідно регулярно переглядати офіційну документацію, щоб ознайомитися зі ситуацією щодо занедбаних (застарілих) функцій та змін у різних версіях програмного забезпечення. Використовуйте умовну логіку та перев function_exists() Перевірте, чи доступна певна функція; якщо ні, запропонуйте альтернативне рішення її реалізації. Крім того, чітко вказайте в файлі readme.txt плагіна діапазон версій WordPress, для яких ви проводили тести.

Як реалізувати інтернаціоналізацію для мого плагіна?

WordPress використовує технологічний стек GNU gettext для підтримки міжнародної версії програми (інтернаціоналізації). Вам потрібно… __() 或 _e() Функції типу “wait” обгортають усі рядки, які потрібно перекласти. Потім за допомогою інструментів для роботи з POT-файлами (наприклад, Poedit) створюється шаблон перекладу, який дозволяє перекладачам генерувати файли з розширеннями .mo та .po для потрібної мови. Нарешті, використовуються ці файли для проведення процесу перекладу. load_plugin_textdomain() Функція завантажує мовні файли під час ініціалізації плагіна.