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

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

Среда разработки и основные подготовительные работы

Прежде чем начать писать первый строк кода, крайне важно наличие стабильной и эффективной среды разработки. Это позволяет сосредоточиться исключительно на построении логики программы и помогает избежать многих распространенных ошибок.

Настройка локальной среды разработки.

Рекомендуется использовать наборы инструментов для работы с локальными серверами, такие как XAMPP, MAMP или более профессиональный Local by Flywheel. Убедитесь, что версия PHP (рекомендуется 7.4 или выше) совместима с средой, в которой будет развернут WordPress, и включите режим отладки. В WordPress…wp-config.phpВ файле установлены настройки.WP_DEBUGДля…trueВо время этапа разработки будут отображаться все ошибки и предупреждения, что поможет вам быстро выявить проблемы.

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

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

Стандартный плагин должен содержать по меньшей мере один основной файл. Обычно принято создавать для плагина отдельную папку, название которой соответствует его основной функции. Например:my-first-pluginВ этой папке основной файл обычно носит то же имя, что и папка сама, но с расширением….phpа именноmy-first-plugin.phpЧеткая структура облегчает дальнейшее добавление файлов JavaScript, CSS, языковых пакетов или классов.

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

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

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

Создание основного файла плагина и базовой информации о заголовках

Вход в плагин и процесс его идентификации зависят от информации, содержащейся в заголовочных строках (headers) в начале основного файла плагина. Именно эта информация позволяет системе WordPress распознать плагин и загрузить его.

Написание стандартной заголовочной части плагина

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

<?php
/**
 * Plugin Name:       我的第一个功能插件
 * Plugin URI:        https://example.com/my-first-plugin
 * Description:       这是一个实战指南中创建的示例插件，用于演示核心开发流程。
 * 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иText DomainЭто обязательный пункт; остальные пункты являются необязательными. Текстовое поле.Text DomainПредназначено для поддержки международной локализации (иностранного языкового интерфейса).

Предотвращение прямого доступа к файлам

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

Рекомендуемое чтение Руководство по пользовательскому развитию плагинов для WooCommerce: Создание собственного интернет-магазина。

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

КонстантаABSPATHЭто абсолютный путь к корневому каталогу WordPress; он определяется во время выполнения самого WordPress. Данное условие гарантирует, что последующий код будет выполнен только в среде WordPress.

Реализация основных функций с использованием хуков WordPress

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

Использование действий-хуков (action hooks) для добавления новых функций

Действия-хаки (action hooks) позволяют выполнять пользовательский код при наступлении определённых событий. Например, мы можем создать функцию, которая автоматически добавляет информацию об авторских правах в конец текста статьи. Для этого потребуется использование…the_contentФильтры (по сути, это фильтровые хаки, но их использование схоже с использованием действий-хаков) и…wp_enqueue_scriptsДля загрузки ресурсов используются действия-хаки (action hooks).

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

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

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

Во-первых, мы напишем функцию.mfp_add_copyright_noticeИ подключите его к… (или: и монтируйте его на…)the_contentНа крючке.

// 在文章内容后添加版权声明
function mfp_add_copyright_notice( $content ) {
	if ( is_single() && in_the_loop() && is_main_query() ) {
		$copyright_text = '<p><em>Авторские права на эту статью принадлежат данному веб-сайту. При перепечатке необходимо указать источник.</em></p>';
		$content .= $copyright_text;
	}
	return $content;
}
add_filter( 'the_content', 'mfp_add_copyright_notice' );

Условия проверки гарантируют, что заявление об авторских правах будет отображаться только в основном цикле обработки отдельной статьи на переднем плане (в пользовательском интерфейсе) и не повлияет на содержимое страницы, её резюме, а также на работу серверной части системы.

Использование хуков фильтров для изменения данных

Фильтр-хаки (filter hooks) предназначены для изменения любых данных, передаваемых им. Например, если мы хотим изменить некоторые элементы заголовка веб-сайта, мы можем создать соответствующую функцию и добавить её в систему.wp_titleили более современные методы/инструментыdocument_title_partsФильтр.

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

// 修改网站标题后缀
function mfp_modify_title_suffix( $title ) {
	if ( is_home() ) {
		$title['suffix'] = ' | 我的精彩博客';
	}
	return $title;
}
add_filter( 'document_title_parts', 'mfp_modify_title_suffix' );

Безопасное внедрение скриптов и стилей

Чтобы добавить фронтенд-стили или интерактивные элементы к плагину, необходимо использовать инструменты, рекомендуемые WordPress.wp_enqueue_style()иwp_enqueue_script()Функция, и с помощью…wp_enqueue_scriptsЗапрос через хук (hook).

// 注册并排队插件的前端样式
function mfp_enqueue_frontend_assets() {
	// 获取插件目录的URL
	$plugin_url = plugin_dir_url( __FILE__ );

// 排队一个CSS文件
	wp_enqueue_style(
		'mfp-frontend-style',
		$plugin_url . 'assets/css/frontend.css',
		array(),
		'1.0.0'
	);

// 排队一个JS文件，并依赖jQuery
	wp_enqueue_script(
		'mfp-frontend-script',
		$plugin_url . 'assets/js/frontend.js',
		array( 'jquery' ),
		'1.0.0',
		true // 在页脚加载
	);
}
add_action( 'wp_enqueue_scripts', 'mfp_enqueue_frontend_assets' );

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

Многие плагины требуют предоставления пользователю настроек. WordPress предоставляет API для настройок, который позволяет безопасно и стандартизированно создавать меню управления и страницы с параметрами.

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

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

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

Добавить меню управления

Во-первых, используйтеadd_action( ‘admin_menu’, … )Для регистрации нового пункта меню управления или подменю используйте следующую функцию:mfp_create_admin_menuБудет добавлено подменю в главном меню “Настройки”.

// 创建插件管理菜单
function mfp_create_admin_menu() {
	add_options_page(
		‘我的插件设置’, // 页面标题
		‘我的插件’,     // 菜单标题
		‘manage_options’, // 权限要求
		‘mfp-settings’,   // 菜单slug
		‘mfp_settings_page_html’ // 用于输出页面内容的回调函数
	);
}
add_action( ‘admin_menu’, ‘mfp_create_admin_menu’ );

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

Далее необходимо определить функцию-обратный вызов (callback function).mfp_settings_page_htmlНеобходимо отобразить содержимое страницы, а также с помощью предоставленного API зарегистрировать группу настроек, один из параметров (опцию) и конкретные поля (фильтры).

// 设置页面的HTML输出
function mfp_settings_page_html() {
	// 检查用户权限
	if ( ! current_user_can( ‘manage_options’ ) ) {
		return;
	}
	?>
	<div class="“wrap”">
		<h1></h1>
		<form action="/ru/“options.php”/" method="“post”" data-trp-original-action="“options.php”">
			<?php
			// 输出设置字段、非ce等
			settings_fields( ‘mfp_options_group’ );
			do_settings_sections( ‘mfp-settings’ );
			submit_button( ‘保存设置’ );
			?>
		<input type="hidden" name="trp-form-language" value="ru"/></form>
	</div>
	‘mfp_field_copyright_text’ )
	);
}
add_action( ‘admin_init’, ‘mfp_settings_init’ );

// 渲染版权文本文档字段
function mfp_field_copyright_text_html() {
	$options = get_option( ‘mfp_options’ );
	$value = $options[‘copyright_text’] ?? ‘默认版权文本’; // PHP 7.0+ 空合并运算符
	?&gt;
	<input type="“text”"
		   id="“mfp_field_copyright_text”"
		   name="“mfp_options[copyright_text]”"
		   value="“NO NUMERIC NOISE KEY" 1000”
		 class="“regular-text”">
	&lt;?php
}

Теперь вы можете использовать то, что было сделано ранее.mfp_add_copyright_noticeВ функции используется…get_option( ‘mfp_options’ )[‘copyright_text’]Необходимо динамически получать текст, заданный пользователем в настройках, чтобы функции плагина были настраиваемыми.

резюме

В этой статье подробно описан полный процесс разработки плагина для WordPress с нуля. Мы начали с создания среды разработки и главного файла плагина, содержащего стандартную информацию о плагине, и подчеркнули важность мер безопасности. Затем мы глубоко рассмотрели основы разработки плагинов для WordPress — механизм хуков (hooks), включая использование хуков действий (action hooks) для выполнения кода и хуков фильтров (filter hooks) для изменения данных, а также показали способы безопасного загрузки фронтенд-ресурсов. В заключение с помощью API настроек WordPress мы создали страницу управления плагином, обладающую профессиональным дизайном, что позволяет пользователям настраивать функции плагина по своему усмотрению.

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

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

Как выбрать подходящее префиксирование для функций и классов плагинов?

Во всех плагинах глобальные функции, классы, переменные и константы должны иметь уникальные префиксы, чтобы избежать конфликтов в названиях с другими плагинами или темами. Префикс обычно состоит из аббревиатуры или сокращения названия плагина. Например, если название плагина — “My First Plugin”, то префикс может быть, например, “MfP_”.mfp_илиmyfirstplugin_Соблюдение единообразия крайне важно.

Почему для добавления скриптов необходимо использовать функцию `wp_enqueue_script`?

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

Какие важные правила безопасности соблюдаются при разработке плагинов?

Основной принцип: никогда не доверяйте пользовательскому вводу. Для всех данных, полученных от пользователя, выполняйте проверку на достоверность.$_GET、$_POST、$_REQUESTДанные, полученные из базы данных, необходимо проверить, очистить и обработать (включая процедуру экранирования специальных символов). После этого их следует использовать при формировании HTML-кода.esc_html()、esc_attr()Выведите это на URL для использования.esc_url()В SQL-запросах обязательно используйте…$wpdb->prepare()Используйте параметризованные запросы для предотвращения взлома системы с помощью SQL-инъекций.current_user_can()Проверьте права пользователя.

Как добавить поддержку интернационализации к моему плагину?

Во-первых, необходимо правильно настроить информацию в заголовке плагина.Text DomainиDomain PathЗатем во всех местах кода, где требуется перевод строк, используйте…()Выполнить вывод перевода._e()Выполнить операцию отображения результатов (эхо-перевода).( ‘Hello World’, ‘my-first-plugin’ )В конце используйте такой инструмент, как Poedit, чтобы сканировать код и сгенерировать необходимые результаты..potШаблонные файлы, созданные для разных языков..poи.moПереведите файл и разместите его в указанном месте./languagesВнутри каталога.