Основы плагинов WordPress

Дата публикации:Сентябрь 7, 2010

По своей структуре плагин практически ничем не отличается от темы. Вместо файла style.css, в котором, как вы помните, располагался заголовок темы, плагин имеет PHP-файл с аналогичным заголовком. Этот PHP-файл должен обладать уникальным именем. В том случае, если плагин состоит из нескольких файлов, уникальное имя должно быть у содержащей их папки.

Для чего задается уникальное имя? Поскольку плагины обычно размещаются в папке wp-content/plugins/, очень важно избежать любых конфликтов имен. Не должно быть двух плагинов, обладающих одним и тем же именем.

Идентификация плагина во многом похожа на идентификацию темы:

<?php
/*
Plugin Name: My Smashing Plugin
Plugin URI: http://my-smashing-plugin-url.com
Description: This is what my Smashing Plugin actually does.
Version: 1.0
Author: Thord Daniel Hedengren
Author URI: http://tdhedengren.com
*/
?>

Некоторые поля можно опустить, поскольку они не играют значимой роли. Основное поле, которые должно присутствовать в заголовке: это Plugin Name.

Помимо заголовка, стандарт GPL рекомендует включать также строку лицензирования плагина:

<?php
/*  Copyright YEAR  PLUGIN_AUTHOR_NAME  (e-mail : PLUGIN AUTHOR E-MAIL)
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by 
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but 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.
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
?>

Вместо строк YEAR и PLUGIN AUTHOR E-MAIL нужно ввести год выпуска и e-mail создателя плагина. Если вы не хотите включать лицензию непосредственно в основной файл плагина, вы можете создать для нее отдельный текстовый файл, обычно носящий имя license.txt. Загрузить файл лицензии можно отсюда: www.gnu.org/copyleft/gpl.html.

После того, как плагин будет размещен в папке wp-content/plugins, его можно будет активировать через панель администратора.

Теперь перейдем к самому важному вопросу — к написанию собственных плагинов. Перед тем, как приступать к этому длительному процессу, нужно обязательно решить для себя, что и как будет выполнять плагин. Для чего вам потребовался плагин? Только для добавления некоторой специфичной функциональности или для полной реорганизации WordPress?

Следующий список вопросов поможет структурировать процесс разработки плагина.

1. Существуют ли другие плагины, совершающие те же самые действия? Если существуют, не лучше ли будет несколько изменить\подкорректировать их под свои нужды, нежели писать собственный плагин с нуля?
2. Удостоверьтесь, что название вашего плагина являетя уникальным (сделать это можно через Google).
3. Используйте уникальный префикс во всех ваших функциях. Это позволит избежать конфликтов имен функций в пределах темы.
4. Можно ли будет переводить ваш плагин на другие языки? Обычно разработчики включают такую возможность.
5. Будет ли плагин обладать поддержкой виджетов?
6. Необходима ли страница настроек для плагина?
7. Какой тип лицензии имеет плагин? Для того, чтобы плагин был добавлен в wordpress.org каталог, он должен быть основан на GPL-лицензии.
8. Обязательно проведите окончательное тестирование плагина на выявление различных ошибок и неточностей. Все ли ссылки работают? Правильно ли указана версия плагина?

Изучение данных вопросов поможет вам избежать лишней головной боли в процессе разработки собственного плагина.

Поделиться

Оставить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

Получать новые комментарии по электронной почте. Вы можете подписаться без комментирования.