Заголовки плагіна

Заголовки плагіна – це важливий компонент, який повідомляє WordPress, що PHP файл усередині каталогу плагінів є плагіном WordPress. Такі заголовки виглядають як коментар PHP на початку головного файлу. Заголовки мають свій стандарт, нижче про ні.

Можливі заголовки плагіна

Заголовок плагіна повинен бути в основному файлі плагіна і тільки там.

Як мінімум, заголовок повинен містити ім’я плагіна:

<?php
/**
 * Plugin Name: Мій перший плагін
 */

// код плагіна

У заголовку можуть бути зазначені інші дані:

<?php

/**
 * Plugin Name: Назва плагіна
 * Description: Опис плагіна бажано не дуже довге (140 символів)
 * Plugin URI: Посилання на сторінку плагіна
 * Author URI: Посилання на автора
 * Автор: Ім'я автора
 * Version: Версія плагіна, наприклад 1.0
 *
 * Text Domain: ID перекладу, вказується в load_plugin_textdomain()
 * Domain Path: Шлях до файлу перекладу.
 * Requires at least: 2.5
 * Requires PHP: 5.4
 *
 * License: GPL2
 * License URI: https://www.gnu.org/licenses/gpl-2.0.html
 *
 * Network: Вкажіть "true" для можливості активувати плагін для мережі Multisite.
 * Update URI: https://example.com/link_to_update
 */

// код плагіна

Plugin Name:
(обов’язковий)

Назва плагіну, що відображається у списку плагінів в адмінці.

Description:

Короткий опис плагіна, який відображається в розділі Плагіни в адмінці. Рекомендовано не перевищувати 140 символів.

Version:

Номер поточної версії плагіна, наприклад 1.0 або 1.0.3.

Під час встановлення версії майте на увазі, що WP для порівняння версій використовує функцію version_compare() . Тому при зміні версії переконайтеся, що нова версія буде вищою. Наприклад, 1.02 більше ніж 1.1

Plugin URI:

Домашня сторінка плагіна, яка може бути на WordPress.org або вашому власному сайті.

Автор:

Ім’я автора плагіна. У списку може бути більше одного автора.

Автор URI:

Сайт автора або профіль на іншому веб-сайті, наприклад WordPress.org.

Requires at least:

Найнижча версія WordPress, на якій працюватиме плагін. Наприклад:
2.5 .

Requires PHP:

Мінімальна необхідна версія PHP. Наприклад:
5.4 .

License:

Коротке ім’я ліцензії плагіна, наприклад, GPL2. Докладнішу інформацію про ліцензування можна знайти на
WordPress.org .

License URI:

Посилання на ліцензію, наприклад,
https://www.gnu.org/licenses/gpl-2.0.html .

Text Domain:

Ідентифікатор перекладу (домен локалізації) використовується у функціях локалізації та в назві файлу перекладу mo. Докладніше дивіться
цитату тут .

Domain Path:

Потрібен якщо файл перекладу знаходиться не в тій же папці, що містить поточний файл. Наприклад, .mo файл перебуває у папці
/myplugin/languages, а файл плагіна в
/myplugin/myplugin.php, тоді вказуємо
/languages.

Network:

Вкажіть “true” щоб плагін обов’язково активувався по всій мережі сайтів у
MU збиранні WordPress . Це унеможливить активувати плагін для одного сайту, якщо активована мультимережа.

Update URI:

URL для поновлення сайту. Використовується у функції
wp_update_plugins() . З домену буде створено хук
update_plugins_(hostname) .

Розмір заголовка

Заголовок плагіна розбирається функцією get_plugin_data() , яка обробляє лише перші 8kiB (6000-8000 символів) інформації, і якщо дані плагіна виходять більше, автору доведеться їх зменшити або перемістити дані плагіна нагору. Таке може статися, якщо, наприклад, додати дані про ліцензію перед даними плаглина.

Вказівка ​​ліцензії плагіна

Більшість плагінів WordPress опубліковано під ліцензією GPL , що відповідає тій самій ліцензії, яку використовує сам WordPress. Проте є й інші варіанти. Найкраще завжди чітко вказати, яку ліцензію використовує ваш плагін.

Вище було показано, що ліцензію можна вказати у параметрі заголовка License:. Але є ще одна поширена практика – помістити блок ліцензії під заголовками плагіна в основному файлі плагіна.

Блок ліцензії виглядає приблизно так:

{Plugin Name} is free software: ви можете перерозподілити його та/або modify
це під час положень GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
any later version.

{Plugin Name} is distributed in the hope that it will be useful,
але WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

Ви повинні отримати від GNU General Public License
along with {Plugin Name}. If not, see {URI to Plugin License}.

Об’єднавши із заголовками плагіна отримаємо:

/**
 * Plugin Name: Plugin Name
 * Plugin URI: http://URI_Of_Page_Describing_Plugin_and_Updates
 * Description: Цей опис містить свій Plug-in в короткому сенсі
 * Version: 1.5
 * Автор: John Smith
 * Author URI: http://URI_Of_The_Plugin_Author
 * License: GPL2
 *
 * {Plugin Name} is free software: ви можете перерозподілити його та/або змінити
 * Це під термінами GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * any later version.
 *
 * {Plugin Name} is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY або FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * Ви повинні отримати від GNU General Public License
 * along with {Plugin Name}. If not, see {License URI}.
*/

PHPDoc DocBlock

У заголовки також можна підмішувати будь-що, наприклад можна додати блок документації PHPDoc для різних IDE:

/**
 * 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
 * Автор: 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
 */