Від нуля: Основні кроки та найкращі практики розробки плагінів для WordPress

Від нуля: Основні кроки та найкращі практики розробки плагінів для WordPress

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

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

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

Розробна середовище та базова структура

Перш ніж починати писати будь-який код, дуже важливо створити відповідне середовище для розробки. Рекомендується використовувати локальні інструменти для розробки, такі як Local by Flywheel, XAMPP або MAMP, які дозволяють швидко налаштувати середовище, що включає PHP, MySQL та веб-сервер. Крім того, необхідні також текстовий редактор (наприклад, VS Code чи PhpStorm) та інструменти для налагодження коду (наприклад, Query Monitor чи Debug Bar).

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

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

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

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

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

Створіть щось на кшталт: „Створення нового проекту під назвою…“ my-first-plugin.php Файл, і введіть наступний вміст:

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

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

Каталог плагінів та організація файлів

Зі збільшенням кількості функцій окремі файли стають складнішими для підтримки та обслуговування. Добре структурований каталог плагінів зазвичай містить наступні частини:
* 主插件文件：plugin-name.php
* includes/ Каталог: місце для зберігання файлів, що містять класи чи функції, які виконують основні функції програми.
* admin/ Каталог: містить код, CSS та JavaScript, пов’язані з фоновою обробкою даних (бекендом).
* public/ Каталог: містить код, CSS та JavaScript, пов’язані з фронтенд-частиною сайту.
* assets/ Каталог: місце для зберігання зображень, таблиць стилів та файлів скриптів.
* languages/ Каталог: місце для зберігання файлів із міжнародними перекладами (.pot, .po, .mo).
* uninstall.php Файл: Параметри для очищення бази даних після видалення додатка/плагіна.

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

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

Основою розробки плагінів для WordPress є розуміння та вміле використання наданих ним API (програмних інтерфейсів), до яких належать дії-хаки (Action Hooks), фільтри-хаки (Filter Hooks) та скорочені коди (Shortcodes).

Оволодіння використанням механізмів динамічного керування діями (action hooks)

Акційні хаки (action hooks) дозволяють вам “вставляти” власний код у певні моменти виконання WordPress. Використовуйте їх для автоматизації різних процесів чи додавання додаткових функцій до вашого сайту. add_action() Функція дозволяє прикріпити вашу власну функцію до певного „хака“ (hook).

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

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

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

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

function myplugin_add_custom_meta() {
    echo '<meta name="my-custom-meta" content="value">';
}
add_action( 'wp_head', 'myplugin_add_custom_meta' );

Ще одним поширеним прикладом є виконання певних ініціалізаційних операцій під час активації плагіна, наприклад створення таблиць у базі даних. Для цього необхідно прикріпити відповідні функції до системи. register_activation_hook На гаку.

Використовуйте фільтри для зміни вмісту.

Фільтр-хаки (filter hooks) призначені для зміни даних під час їх обробки в WordPress. Ви можете їх використовувати для виконання різних дій, таких як додавання нової інформації, видалення непотрібних даних чи зміна структури даних. add_filter() Функції використовуються для зміни текстового контенту, значень опцій тощо. Функції-фільтри обов’язково мають повертати певне значення.

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

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

function myplugin_modify_post_content( $content ) {
    if ( is_single() ) {
        $custom_text = '<p><em>Дякуємо, що прочитали цю статтю!</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
add_filter( 'the_content', 'myplugin_modify_post_content' );

Створення та керування скороченими кодами

Короткі коди дозволяють користувачам легко вставляти динамічний контент, створений плагінами, у статті, сторінки чи невеликі інструменти. add_shortcode() Функція дозволяє зареєструвати новий скорочений код.

Зареєструйте об’єкт під назвою… [greeting] Це скорочений код, який може відображати різні привітання залежно від часу доби:

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

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

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

function myplugin_greeting_shortcode( $atts ) {
    $hour = date( 'G' );
    $greeting = ( $hour ? 'Доброго ранку!' : ( ($hour) < 18 ) ? '下午好！' : '晚上好！' );
    return &#039;<div class="greeting">'`. esc_html($greeting).`'</div>'add_shortcode( 'greeting', 'myplugin_greeting_shortcode' );

Безпека плагінів та управління даними

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

Реалізація перевірки даних та їх ескапування

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

• Підтвердження: використовуйте. sanitize_text_field(), sanitize_email(), intval() Функції очищення використовуються для обробки користувацького введення.
• Ескапування: Під час виведення даних у HTML, JavaScript або URL необхідно використовувати відповідні функції ескапування. esc_html(), esc_js(), esc_url()。

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

$user_input = $_POST['username'] ?? ''; // 使用空合并运算符提供默认值
$clean_username = sanitize_text_field( $user_input );
echo '你好，' . esc_html( $clean_username );

Використання API параметрів WordPress

Для зберігання простих налаштувань (наприклад, перемикачів, тексту тощо) слід використовувати API параметрів WordPress. Він надає можливості для керування цими налаштуваннями. add_option(), get_option(), update_option() 和 delete_option() Функції на кшталт цих дозволяють безпечно зберігати дані. wp_options У таблиці.

Створіть налаштування для плагіна та отримайте їх.

// 保存一个选项
update_option( 'myplugin_setting_color', '#336699' );

// 获取一个选项，如果不存在则使用默认值
$color = get_option( 'myplugin_setting_color', '#000000' );

Створення власних таблиць у базі даних

Коли плагін потребує зберігати складні дані у вигляді реляційних структур, може знадобитися створення власних таблиць у базі даних. Це зазвичай виконується під час активації плагіна та має відповідати правилам структури бази даних WordPress.

在 my-first-plugin.php У цьому коді додається функція створення таблиці для активації хуків плагіна:

function myplugin_create_custom_table() {
    global $wpdb;
    $table_name = $wpdb->prefix . 'myplugin_items'; // 使用 $wpdb->prefix 确保表前缀正确
    $charset_collate = $wpdb->get_charset_collate();

    $sql = "CREATE TABLE IF NOT EXISTS $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        name varchar(100) NOT NULL,
        created_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
        PRIMARY KEY (id)
    ) $charset_collate;";

    require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
    dbDelta( $sql );
}
register_activation_hook( __FILE__, 'myplugin_create_custom_table' );

Створення інтерфейсу для керування плагінами з боку сервера

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

Додати меню керування та підменю

Використовуйте add_menu_page() 和 add_submenu_page() Функції дозволяють додати елементи меню до бічної панелі веб-сервера WordPress для вашого плагіна.

До наведеного нижче коду потрібно додати верхній меню “Мої плагіни” та підменю “Налаштування”:

function myplugin_add_admin_menu() {
    // 添加顶级菜单
    add_menu_page(
        '我的插件设置',          // 页面标题
        '我的插件',             // 菜单标题
        'manage_options',       // 所需权限
        'myplugin-dashboard',   // 菜单 Slug
        'myplugin_dashboard_page', // 回调函数，用于输出页面内容
        'dashicons-admin-generic', // 图标
        30                      // 菜单位置
    );

    // 添加子菜单
    add_submenu_page(
        'myplugin-dashboard',   // 父菜单 Slug
        '插件设置',             // 页面标题
        '设置',                 // 菜单标题
        'manage_options',       // 权限
        'myplugin-settings',    // 子菜单 Slug
        'myplugin_settings_page' // 回调函数
    );
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );

// 定义“仪表盘”页面的回调函数
function myplugin_dashboard_page() {
    echo '<div class="wrap"><h1>Мій плагін-панель приладів</h1></div>';
}

// 定义“设置”页面的回调函数
function myplugin_settings_page() {
    echo '<div class="wrap"><h1>Налаштування мого плагіна.</h1></div>';
}

Інтегроване налаштування API для створення форм

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

Ось простий приклад сторінки налаштувань, яка містить текстове поле:

function myplugin_settings_init() {
    // 注册一个新的设置项 “myplugin_settings”
    register_setting( 'myplugin_settings_group', 'myplugin_settings' );

    // 添加一个新的设置区域
    add_settings_section(
        'myplugin_section_basic',
        '基础设置',
        null, // 区域描述的回调函数，这里不需要
        'myplugin-settings' // 页面 Slug
    );

    // 在区域内添加一个字段
    add_settings_field(
        'myplugin_field_api_key',
        'API 密钥',
        'myplugin_field_api_key_callback', // 渲染字段 HTML 的回调函数
        'myplugin-settings',
        'myplugin_section_basic'
    );
}
add_action( 'admin_init', 'myplugin_settings_init' );

// 字段的回调函数
function myplugin_field_api_key_callback() {
    $options = get_option( 'myplugin_settings' );
    $value = $options['api_key'] ?? '';
    echo '<input type="text" name="myplugin_settings[api_key]" value="' . esc_attr( $value ) . '" class="regular-text">';
}

// 修改之前的设置页面回调函数，以输出表单
function myplugin_settings_page() {
    ?&gt;
    <div class="wrap">
        <h1>Налаштування мого плагіна.</h1>
        <form action="/uk/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            settings_fields( 'myplugin_settings_group' ); // 输出必要的安全字段
            do_settings_sections( 'myplugin-settings' ); // 输出所有设置区域和字段
            submit_button(); // 输出提交按钮
            ?>
        <input type="hidden" name="trp-form-language" value="uk"/></form>
    </div>
    &lt;?php
}

підсумок

Розробка плагінів для WordPress – це процес, який починається з розуміння основної структури системи, поступово переходить до вивчення її ключових API та механізмів безпеки, а на завершення призводить до створення повноцінного користувацького інтерфейсу. Ключовим моментом є дотримання стандартів кодування та найкращих практик WordPress, таких як правильне використання хуків (hooks), суворе оброблення даних, а також використання вбудованих API для налаштувань та керування плагіном. Починаючи зі створення простого файлу з коментарями до головної частини плагіна, ви поступово додаєте функції (акції, фільтри, короткі коди), а також механізми для керування базою даних та внутрішнім інтерфейсом плагіна. Кожен крок ґрунтується на міцній та стабільній основі системи WordPress. Систематичне вивчення та практика цих етапів дозволить вам розробляти плагіни з розширеними можливостями, високим рівнем безпеки та простотою у обслуговуванні, чим ви зможете внести свій внесок у величезну всесвітню екосистему WordPress.

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

Які базові знання необхідні для розробки плагінів для WordPress?

Для розробки плагінів для WordPress необхідно володіти мовою програмування PHP, адже основний код плагінів написаний на цій мові. Також потрібно мати базові знання HTML, CSS та JavaScript для створення фронтенд-інтерфейсів та забезпечення їхньої взаємодії з користувачем. Найважливіше – добре знати основні концепції WordPress, такі як гачки (Actions та Filters), цикли (The Loop), ієрархія шаблонів, а також структуру бази даних WordPress.

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

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

Як моє додаткове програмне забезпечення (плагін) може підтримувати кілька мов (інтернаціоналізацію)?

WordPress використовує технологічну платформу GNU gettext для реалізації інтернаціоналізації (i18n). Спочатку, у коді плагінів для всіх рядків, які потребують перекладу, використовуються спеціальні маркери. () 或 _e() Обгорніть ці функції обробки даних у певну структуру (наприклад, клас чи модуль), а також забезпечте їх підтримку в інших частинах програми. () Функція визначає текстовий домен (Text Domain), який має бути встановлений у вихідному коді плагіна. Потім за допомогою інструментів на кшталт Poedit виконується сканування вихідного коду плагіна з метою генерації необхідних файлів чи змі .pot Шаблонні файли, на основі яких створюються версії продукту для різних мов. .po І після компіляції .mo Файл потрібно розмістити у плагіні. /languages/ У каталозі. Нарешті, використовуйте… load_plugin_textdomain() Функція завантаження.

Як надіслати свій плагін до офіційного каталогу плагінів WordPress?

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