В этой записи пойдет речь о заголовках плагина, которые обязательно указывать, чтобы WordPress знал нужную ему информацию о плагине, например, название и автора.
Как было описано ранее, комментарии DocBlock говорят WordPress, что этот файл является плагином.
Описание заголовков
Минимально, вам нужно указать «Plugin Name» (название плагина), остальные строчки не так важны, но желательно, чтобы они тоже присутствовали.
- Plugin Name: (обязательно) Название вашего плагина, которое будет отображаться на странице «Плагины» в админке.
- Plugin URI: Сайт плагина, если есть. Может быть ваш личный блог. Значение этого поля должно быть уникальным косательно вашего плагина. Вы не можете использовать «WordPress.org» как значение в этом поле.
- Description: Краткое описание плагина, которое так же будет отображаться на странице «Плагины». Старайтесь не писать больше 140 символов.
- Version: Текущая версия плагина, например, 1.0 или 1.0.4.
Важно знать: Когда вы указываете версию вашего плагина, помните, что WordPress использует PHP функцию
version_compare() для сравнения версий. Тем самым, если вы выпускаете новую версию плагина, вам нужно указать версию выше предыдущей. Например, 1.02, на самом деле выше, чем 1.1. - Author: Имя автора плагина. Используйте запятую, если нужно указать несколько.
- Author URI: Ссылка на веб-сайт автора или профиль на другом сайте, например, WordPress.org.
- License: Сокращённое название лицензии (например, GPL2). Больше информации о лицензиях вы можеете получить в официальной документации WordPress.org.
- License URI: Ссылка на полный текст лицензии (например, https://www.gnu.org/licenses/gpl-2.0.html).
- Text Domain: Название gettext для плагина. Используется для перевода плагина на другой язык.
- Domain Path: Указывая этот путь, вы даете WordPress понять, где можно найти файлы с переводами для плагина. Например, если вы укажите
/languages, то WordPress будет искать папку/languagesвнутри основной папки плагина.
Визуально
Ниже я приложил скриншот одного плагина со страницы «Плагины».
- В левом верхнем, жирным выделен заголовок плагина — оно выводится благодаря полю «Plugin Name».
- Описание плагина выводится с поля «Description».
- Версия с поля «Version»
- В этом примере авторов несколько, тем самым они писались через запятую, как было описаны выше.
- Ссылка «Детали» создается WordPress автоматически, после того как вы загрузите плагин в официальную репозиторию WordPress.
Пример комментария
Ниже представлен пример с PHP комментарием:
<?php /* Plugin Name: Название плагина Plugin URI: https://developer.wordpress.org/plugins/the-basics/ Description: Описание плагина Version: 1.0.0 Author: Bologer.org Author URI: http://bologer.ru/ License: GPL2 License URI: https://www.gnu.org/licenses/gpl-2.0.html Text Domain: bologer Domain Path: /languages */
