WordPress как на ладони
wordpress jino

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

Заголовки плагина - это важный компонент, который сообщает WordPress, что PHP файл внутри каталога плагинов является плагином WordPress. Такие заголовки выглядят как PHP комментарий в начале файла, который должен соответствовать определенным стандартам, ниже о них.

Заголовок плагина должен находится в основном файле плагина и только там.

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

<?php
/**
 * Plugin Name: Мой первый плагин
 */

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

В заголовке могут быть указанны и другие данные. Рассмотрим все возможные параметры заголовка:

Plugin Name:(обязательный)
Название плагина, которое будет отображаться в списке плагинов в консоли WordPress.
Description:
Краткое описание плагина, которое отображается в разделе Плагины в консоли WordPress. Рекомендуется не превышать 140 символов.
Version:

Номер текущей версии плагина, например, 1.0 или 1.0.3.

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

Plugin URI:
Домашняя страница плагина, которая может быть на WordPress.org или на вашем собственном сайте.
Author:
Имя автора плагина.  В списке может быть более одного автора.
Author URI:
Сайт автора или профиль на другом веб-сайте, например, WordPress.org.
License:
Короткое имя лицензии плагина, например GPL2. Более подробную информацию о лицензировании можно найти на WordPress.org.
License URI:
Ссылка на лицензию, например, https://www.gnu.org/licenses/gpl-2.0.html .
Text Domain:
ID перевода (домен локализации) указывается в функции.
Domain Path:
Используется чтобы WordPress знал, где находятся файлы перевода. Например /lang означает что в папке плагина есть папка lang и в ней лежать .mo файл a перевода.
Network:
Укажите "true" чтобы плагин обязательно активировался по всей сети сайтов в MU сборке WordPress. Это сделает невозможным активировать плагин для одного сайта, если активирована мультисеть.

Пример заголовка плагина WordPress

<?php
/**
 * Plugin Name: Название плагина
 * Description: Описание плагина желательно не очень длинное (140 символов)
 * Plugin URI:  Ссылка на инфо о плагине
 * Author URI:  Ссылка на автора
 * Author:      Имя автора
 * Version:     Версия плагина, например 1.0
 *
 * Text Domain: Идентификатор перевода, указывается в load_plugin_textdomain()
 * Domain Path: Путь до файла перевода. Нужен если файл перевода находится не в той же папке, в которой находится текущий файл.
 *              Например, .mo файл находится в папке myplugin/languages, а файл плагина в myplugin/myplugin.php, тогда тут указываем "/languages"
 *
 * License:     GPL2
 * License URI: https://www.gnu.org/licenses/gpl-2.0.html
 *
 * Network:     Укажите "true" для возможности активировать плагин по все сети сайтов (для Мультисайтовой сборки).
 */

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

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

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

Eugene Kopich 100web2033.com
Creative sites for creative people ★ Digital marketing
Заголовки плагина 2 комментария
  • Николай cайт: vk.com/nikolays_93

    Как установить мультиязычное название плагина?

    Ответить5 дней назад #
    • Kama4464

      Указываешь Text Domain: и Domain Path:.

      Потом в коде указываешь строку для перевода, чтобы она попала в файл перевода. Например так:

      /**
       * Plugin Name: Название плагина
       * Description: Описание плагина желательно не очень длинное (140 символов)
       * Text Domain: domain
       * Domain Path: /languages/
       */
      
      // код плагина
      __('Название плагина');
      __('Описание плагина желательно не очень длинное (140 символов)');

      Делаешь перевод этих строк в poedit и все! Дальше ВП сам подхватит их по указанным в комментах Text Domain и Domain Path.

      Ответить4 дня назад #

Здравствуйте, !

Ваш комментарий