2.1 Требования к заголовку (header)

Как описано в разделе «Основы плагинов», основной файл PHP должен содержать комментарий заголовка, который сообщает WordPress, что файл является плагином, и предоставляет информацию о плагине.

Минимальные поля

Как минимум, заголовок комментария должен содержать имя плагина (Plugin Name):

<?php
/**
 * Plugin Name: YOUR PLUGIN NAME
 */

Поля заголовка

Доступные поля заголовка:

  • Plugin Name (обязательно): Название вашего плагина, который будет отображаться в списке плагинов в админке WordPress.
  • Plugin URI: Домашняя страница плагина, которая должна быть уникальным URL, желательно на вашем собственном сайте. Должно быть уникальным для вашего плагина. Вы здесь не можете использовать URL-адрес WordPress.org.
  • Description: Краткое описание плагина, которое показано в разделе плагинов в админке WordPress. Описание должно быть до 140 символов.
  • Version: Текущий номер версии плагина, например 1.0 или 1.0.3.
  • Requires at least: Самая низкая версия WordPress, над которой будет работать плагин.
  • Requires PHP: Минимальная требуемая версия PHP.
  • Author: Имя автора плагина. Несколько авторов могут быть перечислены с помощью запятых.
  • Author URI: Сайт автора или профиль на другом сайте, например WordPress.org.
  • License: Краткое название (slug, слаг) лицензии плагина (например, GPLv2). Более подробную информацию о лицензировании можно найти в руководствах WordPress.org.
  • License URI: Ссылка на полный текст лицензии (например, https://www.gnu.org/licenses/gpl-2.0.html).
  • Text Domain: Текстовый домен gettext плагина. Дополнительную информацию можно найти в разделе «Текстовый домен» (Text Domain) на странице «Как интернационализировать свой плагин» (How to Internationalize your Plugin).
  • Domain Path: Путь к домену позволяет WordPress знать, где найти переводы. Дополнительную информацию можно найти в разделе «Путь к домену» (Domain Path) на странице «Как интернационализировать свой плагин» (How to Internationalize your Plugin).
  • Network: Может ли плагин быть активирован только для всей сети. Может быть установлено только в true и должно быть пропущено, когда нет необходимости.

Правильный файл PHP с комментарием заголовка может выглядеть так:

<?php
/**
 * Plugin Name:       My Basics Plugin
 * Plugin URI:        https://example.com/plugins/the-basics/
 * Description:       Handle the basics with this plugin.
 * Version:           1.10.3
 * Requires at least: 5.2
 * Requires PHP:      7.2
 * Author:            John Smith
 * Author URI:        https://author.example.com/
 * License:           GPL v2 or later
 * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
 * Text Domain:       my-basics-plugin
 * Domain Path:       /languages
 */

Вот еще один пример, который допускает файловый уровень PHPDoc DocBlock, а также заголовки файлов плагинов WordPress:

<?php
/**
 * Plugin Name
 *
 * @package           PluginPackage
 * @author            Your Name
 * @copyright         2019 Your Name or Company Name
 * @license           GPL-2.0-or-later
 *
 * @wordpress-plugin
 * Plugin Name:       Plugin Name
 * Plugin URI:        https://example.com/plugin-name
 * Description:       Description of the plugin.
 * Version:           1.0.0
 * Requires at least: 5.2
 * Requires PHP:      7.2
 * Author:            Your Name
 * Author URI:        https://example.com
 * Text Domain:       plugin-slug
 * License:           GPL v2 or later
 * License URI:       http://www.gnu.org/licenses/gpl-2.0.txt
 */

Замечание

При назначении номера версии вашему проекту, помните, что WordPress использует функцию PHP version_compare() для сравнения номеров версий плагина. Поэтому, прежде чем выпускать новую версию своего плагина, вы должны убедиться, что эта функция PHP считает, что новая версия «больше», чем старая. Например, 1.02 на самом деле больше, чем 1.1.

Наверх ↑