Руководство разработчика плагинов для WordPress (часть 4) 05 Марта 2018

Руководство разработчика плагинов для WordPress (часть 4)

Требования к заголовку

Как уже было описано в разделе [Начало работы], заголовочный комментарий это то, что говорит WordPress, что данный файл является плагином. По минимуму заголовочный комментарий должен содержать имя плагина, но некоторые части могут, а обычно должны, быть включены:
  • Имя плагина (Plugin Name, опционально): Имя вашего плагина, которое будет отображаться в списке плагинов в консоли WordPress.
  • URI плагина: домашняя страница плагина, которая должна иметь уникальный URI, предпочтительно вашего веб-сайта. Он должен быть уникальным для вашего плагина. Вы не можете использовать URL Wordpress для этого.
  • Описание: короткое описание плагина, как оно должно отображаться в секции Плагины в консоли WordPress. Описание должно быть длиной менее 140 символов.
  • Версия: номер текущей версии плагина, такой как 1.0 или 1.0.3.Когда вы присваиваете номер версии вашему плагину, имейте в виду, что WordPress использует PHP-функцию version_compare() для сравнения номеров версий плагинов. Поэтому перед тем как выпускать новую версию вашего плагина, вам следует убедиться, что эта PHP-функция возвращает более "новое" значение. Например, 1.02 точно выше, чем 1.1.
  • Автор: имя автора плагина. Множество авторов может быть перечислено используя запятые.
  • URI автора: веб-сайт автора или профиль на другом веб-сайте, таком как Wordpress.org.
  • Лицензия: короткое имя (slug) лицензии плагина (например, GPL2). Больше информации о лицензировании может быть найдено в инструкциях Wordpress.org.
  • URI лицензии: ссылка на полный текст лицензии (например, https://www.gnu.org/licenses/gpl-2.0.html)
  • Text Domain: текстовый домен gettext данного плагина. Больше информации может быть найдено в секции Text Domain на странице Как интернационализировать ваш плагин.
  • Путь домена: доменный путь позволяет WordPress знать, где можно найти переводы. Больше информации может быть найдено в секции Domain Path на странице Как интернационализировать ваш плагин.
Валидный PHP-файл с заголовочным комментарием может выглядеть так:
<?php
            /*
            Plugin Name:  WordPress.org Plugin
            Plugin URI:   https://developer.wordpress.org/plugins/the-basics/
            Description:  Basic WordPress Plugin Header Comment
            Version:      20160911
            Author:       WordPress.org
            Author URI:   https://developer.wordpress.org/
            License:      GPL2
            License URI:  https://www.gnu.org/licenses/gpl-2.0.html
            Text Domain:  wporg
            Domain Path:  /languages
            */