Создание плагина для WordPress: структура плагина. Часть 4

Ромчик
1

Создание плагина для WordPressДоброго времени суток. Мы продолжаем создавать собственный плагин для CMS WordPress. И в данной статье мы остановимся на структуре плагина. Давайте немного отвлечемся и вспомни, что мы уже сделали: разобрали понятие “Плагин” и разобрали первый способ реализации плагина “Популярные статьи”, используя таблицу postmeta, разобрали второй способ реализации плагина “Популярные статьи”, изучили класс wpdb для работы с базой даных,  разобрали работу хуков в WordPress. Вот и пришло время к написанию плагина. Но прежде, чем мы продолжим писать наш с Вами плагин давайте рассмотрим структуру плагинов в WordPress.

Все плагины в WordPress находятся в специально для них отведенной папке: wp-content/plugins.

Файловая структура плагина WordPress

Для простого плагина, который состоит из одного файла, можно в этой папке создать php файл и назвать его как называется плагин. Но это не очень хорошо. И рекомендуется для плагина создавать отдельную папку, таким образом Вы структурируете плагины и если Вам понадобиться расширить функционал, то Вы с легкостью можете добавить дополнительные файлы для плагина. И так давайте создадим папку popular_post_1 в папке wp-content/plugins. Почему я так назвал папку? Все очень просто, плагин. который мы создаем для WordPress, называется “Популярные статьи” или popular post, а единица в конце — это потому, что плагин будет реализовываться первым способом.
Особое внимание уделите названию плагина. Имя плагина должно быть уникальным (это необходимо, чтобы Ваш плагин не конфликтовал с другими плагинами)
Теперь в этом каталоге создадим файл нашего плагина popular_post.php — это основной файл нашего плагина.
Если же Вы хотите поместить Ваш плагин в репазиторий, то Вы должны создать файл readme.txt по строго определенному формату, с которым Вы можете познакомиться тут.
Плагин также может содержать и JavaScript файлы, и CSS файлы, и файлы картинок, и языковые файлы.Так, например, чтобы узнать полный путь к файлу style.css нашего плагина требуется использовать следующую конструкцию:

plugins_url( 'style.css', __FILE__ );

Данная конструкция вернет полный путь к файлу style.css: <название сайта>/wp-content/plugins/popular_post_1/style.css
Теперь Вы можете легко подключить его с помощью функции wp_enqueue_style. Если же необходимо подключить javascript файл, то используйте функцию wp_enqueue_script.
Для определения пути к плагину Вы можете использовать следующие функции:

plugins_url

Данная функция возвращает URL к заданному файлу плагина
plugins_url( $path, $plugin ); где:

  1. $path — путь по отношению к плагину
  2. $plugin — файл плагина относительно которого мы получаем URL.

Например мы хотим получить URL к файлу image.png, который находиться в папке img в папке нашего плагина, тогда URL мы можем получить следующим образом:

plugins_url(‘img/image.png’,__FILE__);

plugin_dir_url

Возвращает URL к заданому плагину
plugin_dir_url( $file ); где:

  1. $file — имя файла плагина

plugin_dir_path

Возвращает путь к каталогу файловой системы с косой чертой для заданного плагина.
plugin_dir_path( $file ); где:

  1. $file — имя файла плагина

plugin_basename

Возвращает имя плагина
plugin_basename($file); где

  1. $file — имя файла плагина

Откроем основной файл нашего плагина popular_post.php.

Основная информация о плагине

В верхней части основного файла плагина должна быть стандартная информация о плагине. Благодаря этой информации WordPress выдает в административной части сайта: название плагина, описание, автора и др. Наличие данной информации позволяет запустить плагин (активировать). Будьте внимательны без этого заголовка Вам не удастся запустить плагин.
Давайте добавим данные о нашем плагине:

<?php
/*
Plugin Name: Название плагина
Plugin URI: Адрес домашней страницы плагина
Description: Описание плагина
Version: Версия плагина
Author: Имя автора плагина
Author URI: Адрес сайта автора плагина
License: Лицензия
*/
?>

Это минимальная информация о плагине, которая должна находиться в заголовке основного файла плагина. Тут следует обратить внимание:

  1. Файл должен быть в кодировке UTF-8 и это очень важно.
  2. Порядок строк не имеет значения.
  3. Версию плагина лучше писать в следующем формате xx.xx или xx.xx.xx, так системе легче будет определить есть ли обновление данного плагина.

Все каркас плагина мы создали. Теперь пришло время к программированию функциональности плагина. Но это тема следующей статьи, а пока все.

Понравилась статья? Поделись с друзьями.
  • Add to favorites
  • Добавить ВКонтакте заметку об этой странице
  • Twitter
  • Facebook
  • Мой Мир
  • LiveJournal
  • Одноклассники
  • Блог Я.ру
  • MySpace
  • FriendFeed
  • В закладки Google
  • Google Buzz
  • Яндекс.Закладки
  • Reddit
  • StumbleUpon
  • Technorati
  • del.icio.us
  • БобрДобр
  • LinkedIn
  • Memori.ru
  • Сто закладок
  • Blogger

  • samsim - 06.02.2015 в 23:15

    Очень интересный пост. Все изложено очень внятно и мне Ваш блог очень понравился. Буду ждать новых постов.

  • ©2012-2017 По всем вопросам обращайтесь через форму обратной связи

    Яндекс.Метрика