Базова структура та принцип роботи плагінів для WordPress
Щоб розробити плагін для WordPress, спочатку необхідно зрозуміти його основну структуру та спосіб функціонування протягом життєвого циклу WordPress. Плагін по суті являє собою один або кілька PHP-файлів, які використовують велику кількість API (програмних інтерфейсів) WordPress для розширення або зміни функціоналу веб-сайту.
Основою будь-якого плагіна є інформація, яка знаходиться у вступній частині плагіна („header“), яка розміщується на початку основного файлу плагіна. Ця інформація форматується згідно з певними правилами PHP-коментарів та призначена для надання WordPress даних про назву плагіна, опис, версію, автора та інші метадані. Наприклад, плагін із назвою… my-first-plugin.php Файл може починатися з наступної інформації:
<?php
/**
* Plugin Name: 我的第一个插件
* Plugin URI: https://example.com/my-first-plugin
* Description: 这是一个用于学习插件开发的简单示例。
* Version: 1.0.0
* Author: 开发者姓名
* License: GPL v2 or later
* Text Domain: my-first-plugin
*/WordPress взаємодіє з плагінами за допомогою механізму “хаків” (Hooks). Існує два типи хаків: дії (Actions) та фільтри (Filters). Хаки-дії дозволяють вставляти власний код у певні моменти виконання WordPress – наприклад, після публікації статті чи під час завантаження стилів у верхній частині сторінки. Хаки-фільтри, у свою чергу, дозволяють змінювати дані, які генерує WordPress під час виконання – наприклад, вміст статті чи довжину її анотації. Розуміння та вміле використання хаків є ключовим для ефективного розроблення плагінів.
Рекомендуємо до прочитання. Поєднання глибокого зрозуміння та простого викладу: Повний посібник з розробки плагінів для WordPress для початківців。
Розуміння структури файлів плагінів
Простий плагін може містити лише один основний файл. Однак зі збільшенням кількості функцій раціональна структура файлів стає надзвичайно важливою. Зазвичай каталог повноцінного плагіна включає основний файл плагіна, а також інші файли, які відповідають my-plugin.php), який використовується для зберігання функцій та класів includes Папки, призначені для зберігання ресурсів фронтенд-частини програми. assets Папка (яка містить CSS, JavaScript, зображення), призначена для файлів, що потребують перекладу languages Фолдери, а також матеріали для шаблонів користувацького інтерфейсу templates Папки. Така модульна структура сприяє обслуговуванню коду та співпраці в команді.
Створіть свій перший простий плагін.
Давайте почнемо з практичного прикладу. Ми створимо плагін, який автоматично додасть у кінець всього контенту статей та сторінок на сайті власне повідомлення про авторські права.
Спочатку вам потрібно знайти каталог встановлення WordPress. wp-content/plugins У цьому папці створіть новий папірець під назвою my-copyright-noticeПотім створіть у цьому папці головний PHP-файл, наприклад, під назвою my-copyright-notice.php。
Функція додавання вмісту
Ми будемо використовувати фільтрувальні хаки (filter hooks). the_content Щоб реалізувати цю функцію, відкрийте головний файл, спочатку додайте інформацію про плагін, а потім напишіть основну функцію.
<?php
/**
* Plugin Name: 自动版权声明
* Description: 在文章和页面内容末尾自动添加版权信息。
* Version: 1.0
* Author: WordPress 学习者
*/
// 防止直接访问文件
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* 在内容末尾添加版权声明的函数
*
* @param string $content 原始的文章内容。
* @return string 添加了版权声明后的内容。
*/
function mycn_add_copyright_to_content( $content ) {
// 仅对主循环内的文章和页面生效
if ( is_single() || is_page() ) {
$copyright_text = '<p><em>© Авторське право: Цей текст належить цьому веб-сайту та не може бути переданий без дозволу.</em></p>';
$content .= $copyright_text;
}
return $content;
}
// 将函数挂载到 ‘the_content’ 过滤器上
add_filter( 'the_content', 'mycn_add_copyright_to_content' );Після збереження файлу увійдіть у свій WordPress-бекенд, перейдіть на сторінку “Плагіни” (Plugins), і там ви повинні побачити плагін “Автоматичне вказування авторських прав” (Automatic Copyright Statement). Після його активації, переглянувши будь-яку статтю чи сторінку, внизу контенту з’явиться текст авторських прав, який ви визначили. Цей приклад, хоча й простий, повністю демонструє весь процес створення, кодування та активації плагіна.
Рекомендуємо до прочитання. Оволодіння розробкою плагінів для WordPress з нуля: принципи, практика та складніші техніки。
Взаємодія з базою даних за допомогою API WordPress
Просунуті плагіни зазвичай потребують зберігання та пошуку даних. WordPress надає дуже зручні класи для роботи з базами даних. wpdb API для опцій дозволяє безпечно обробляти базу даних, не потребуючи безпосереднього написання SQL-запитів.
Для простих даних у вигляді пар ключ-значення, наприклад, налаштувань плагінів, дуже рекомендується використовувати API з параметрами (option API). Ви можете скористатися ним для обробки цих даних. add_option(), get_option(), update_option() 和 delete_option() Використовуються такі функції для керування даними. Ці функції автоматично обробляють процес серіалізації даних та їх зберігання. wp_options У таблиці.
Створення власних таблиць у базі даних
Коли потрібно зберігати структуровані, складні дані (наприклад, інформацію про замовлення чи записи відправлених форм), може знадобитися створити власні таблиці бази даних. Це зазвичай відбувається під час активації плагіна. Для цього необхідно написати функцію та зареєструвати її в системі. register_activation_hook На цьому особливому крючку.
У вашому основному файлі плагіна можна включити код, схожий на наступний:
/**
* 插件激活时创建自定义数据库表
*/
function myplugin_create_custom_table() {
global $wpdb;
$table_name = $wpdb->prefix . 'myplugin_data'; // 获取带前缀的表名，如 wp_myplugin_data
$charset_collate = $wpdb->get_charset_collate();
$sql = "CREATE TABLE IF NOT EXISTS $table_name (
id mediumint(9) NOT NULL AUTO_INCREMENT,
user_id int NOT NULL,
data_value text NOT NULL,
created_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
PRIMARY KEY (id)
) $charset_collate;";
// 引入 WordPress 升级所需的文件
require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
dbDelta( $sql );
}
// 注册激活钩子
register_activation_hook( __FILE__, 'myplugin_create_custom_table' );dbDelta() Функції в WordPress є потужним інструментом для створення чи оновлення таблиць у базі даних. Вони порівнюють існуючу структуру таблиць із вашим SQL-запитом та виконують лише необхідні зміни. Зверніть увагу…dbDelta() Дуже чутливий до формату SQL-запитів (наприклад, до визначення ключів, належного відступу).
Створення інтерфейсу керування плагінами та застосування практик безпеки
Професійний плагін зазвичай потребує сторінки налаштувань у бекенді, щоб користувачі могли змінювати параметри. Ви можете використовувати API налаштувань WordPress для створення цієї сторінки у стандартизованому та безпечному форматі. Цей API відповідає за перевірку форм, обробку захищених полів (nonce) та зберігання налаштувань, що значно спрощує процес розробки.
Рекомендуємо до прочитання. Персоналізована тема WordPress: повне керівництво зі створення унікального дизайну веб-сайту з нуля.。
Сторінка налаштувань плагінів
По-перше, вам потрібно використати… add_action() Функція монтує один об’єкт на інший. admin_menu Функція-повернення (callback) дієвого хака (action hook) використовується для додавання нового пункту меню та сторінки. Потім, у функції-поверненні цієї сторінки, за допомогою функцій API для налаштувань створюється форма.
Ось спрощений приклад, який демонструє, як додати сторінку верхнього меню та зареєструвати поле налаштувань:
/**
* 添加插件设置菜单
*/
function myplugin_add_admin_menu() {
add_menu_page(
'我的插件设置', // 页面标题
'我的插件', // 菜单标题
'manage_options', // 所需权限
'myplugin-settings', // 菜单 slug
'myplugin_settings_page', // 显示设置页面的回调函数
'dashicons-admin-generic', // 图标
80 // 菜单位置
);
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );
/**
* 初始化插件设置
*/
function myplugin_settings_init() {
// 注册一个新的设置到 “myplugin_settings” 页面
register_setting( ‘myplugin_settings’, ‘myplugin_options’ );
// 在页面中添加一个区域
add_settings_section(
‘myplugin_section’,
‘主要设置’,
null, // 可选的区域描述回调函数
‘myplugin_settings’
);
// 向区域中添加一个字段
add_settings_field(
‘api_key’,
‘API 密钥’,
‘myplugin_api_key_field_callback’, // 渲染字段 HTML 的回调函数
‘myplugin_settings’,
‘myplugin_section’
);
}
add_action( ‘admin_init’, ‘myplugin_settings_init’ );
/**
* 渲染 API 密钥字段
*/
function myplugin_api_key_field_callback() {
$options = get_option( ‘myplugin_options’ );
?>
<input type="‘text’" name="‘myplugin_options[api_key]’" value="‘NO NUMERIC NOISE KEY" 1003’>
<?php
}
/**
* 设置页面的显示内容
*/
function myplugin_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( ‘myplugin_settings’ ); // 输出安全字段
do_settings_sections( ‘myplugin_settings’ ); // 输出设置区域和字段
submit_button( ‘保存设置’ );
?>
<input type="hidden" name="trp-form-language" value="uk"/></form>
</div>
<?php
}Дотримуйтеся правил безпеки WordPress.
Безпека є найважливішим аспектом розробки плагінів. Усі дані, введені користувачем, та результати їх обробки мають піддаватися належній перевірці. WordPress надає низку функцій, які допоможуть вам у цьому.
Ескапований вивід: використовуйте < esc_html(), esc_attr(), esc_url() 和 wp_kses_post() Функції, такі як ці, забезпечують, щоб дані, які відображаються на сторінці, були безпечними.
* 验证和清理输入：在处理表单提交的数据前，使用 sanitize_text_field(), intval(), sanitize_email() Необхідно очистити такі функції.
* Nonce 验证：对于所有涉及状态更改的操作（如表单提交、AJAX 请求），使用 wp_nonce_field(), wp_create_nonce() 和 wp_verify_nonce() Це робиться для запобігання атакам типу Cross-Site Request Forgery (CSRF).
* 能力检查：使用 current_user_can() Функція для перевірки того, чи має поточний користувач права виконати певну операцію (наприклад,…) ‘edit_posts’, ‘manage_options’）。
підсумок
Розробка плагінів для WordPress – це систематичний процес, який починається з розуміння основної структури системи (хаки, заголовкові дані) та поступово переходить до реалізації функцій, управління даними, створення інтерфейсів та підвищення рівня безпеки. Починаючи з простих плагінів, наприклад, для відображення авторських прав, розробники можуть швидко отримати чітке уявлення про процес роботи з плагінами. Потім вони вивчають використання API для налаштувань плагінів та інших інструментів, необ wpdb Виконання операцій з даними за допомогою класів є необхідним кроком для зберігання складної інформації. Нарешті, створення зручного користувацького інтерфейсу на основі встановлених API та суворе дотримання стандартів безпечного програмування WordPress є ключовими факторами для того, щоб плагін виглядав професійно, надійно та був широко використовуваним. Постійна практика, а також вивчення вихідного коду основного програмного забезпечення та інших якісних плагінів є найкращим способом покращення ваших навичок програмув
Часті запитання
Як мінімум, які файли потрібні для плагіна WordPress?
Функціональний WordPress-плагін може містити лише один окремий PHP-файл. Достатньо, щоб цей файл містив правильні коментарі щодо структури плагіна та виконував необхідні функції – WordPress автоматично його ідентифікує та активує. Для складних плагінів, з міркувань зручності обслуговування, рекомендується розділити їх на кілька файлів та папок.
Як зробити так, щоб плагін підтримував багатомовний переклад?
WordPress використовує технологію GNU gettext для підтримки інтернаціоналізації (i18n). Вам потрібно виконати наступні кроки: по-перше, у верхній частині плагіна та всюди, де є текст, який потрібно перекласти, використовуйте відповідні маркери для позначення тексту, який потребує перекладу. __(‘文本’, ‘your-text-domain’) 或 _e(‘文本’, ‘your-text-domain’) Таку функцію необхідно упакувати у відповідний формат. Потім використовуйте інструменти на кшталт Poedit для створення шаблонного файлу .pot, а також файлів .po та .mo для потрібної мови. zh_CN.poНа завершення, за допомогою load_plugin_textdomain() Функція завантажує файли з перекладами під час ініціалізації плагіна.
Як правильно завантажувати файли JavaScript та CSS, які знаходяться у плагінах?
Для забезпечення сумісності та уникнення конфліктів не варто безпосередньо посилатися на файли ресурсів у HTML-коді. Для ресурсів, які використовуються на передньому кінці (фронтенді), слід використовувати відповідні методи та мех wp_enqueue_script() 和 wp_enqueue_style() Функції, і прив'язати їх до wp_enqueue_scripts На дієвих гачках. Для ресурсів сторінки адміністратора заднього середовища необхідно їх завантажити (монтувати). admin_enqueue_scripts На гачках. Ці функції дозволяють вам вказати залежності та версії програмних компонентів, а також гарантують, що одні й ті самі ресурси будуть завантажені тільки один раз.
Як виконувати налагодження під час розробки плагінів?
WordPress надає потужні інструменти для налагодження (дебагування). По-перше, у веб-сайті… wp-config.php У файлі буде… WP_DEBUG Стала величина встановлена як trueЦе буде відображати PHP-помилки, попередження та сповіщення безпосередньо на сторінці. Ви також можете увімкнути цю функцію одночасно. WP_DEBUG_LOGЗаписати помилку у… wp-content/debug.log Файли) та WP_DEBUG_DISPLAY(Контролюється, чи відображати цей елемент на сторінці). Крім того, використовується… error_log() Функції чи запис логів у власні файли також є ефективними способами відстеження змінних та процесів виконання програми.
Наступний крок, що робити далі?
Для подальшого читання та практичних знань
Наступні матеріали пов'язані з темою цієї статті і можуть бути корисними для подальшого вивчення. Зазвичай краще починати з статей, які найбільш тісно пов'язані з вашим поточною проблемою, а потім поступово переходити до суміжних тем.
- Як вибрати та налаштувати ідеальну тему для вашого WordPress-сайту?
- Посібник з розробки плагінів для WordPress: створіть свій перший власний плагін з нуля
- Як стати розробником плагінів для WordPress: повний посібник від нуля
- Від нуля до одиниці: Повний посібник та практичні поради щодо створення професійних веб-сайтів за допомогою WordPress
- Повний посібник з розробки плагінів для WordPress: від початківців до майстрів – створення професійних розширень
Українська