Внимание! В статье содержится много ссылок на англоязычные инструкции, учебники и руководства.
На WordPress работает 25% всех сайтов в Интернете. Это мега популярный движок. И если вам нравится с ним работать, вы можете попробовать разработать свой собственный плагин для него.
Создание плагинов WordPress с нуля не является ни простым, ни легким делом. Тем не менее, это вполне выполнимо даже для начинающего разработчика! Хитрость заключается в том, чтобы хорошо спланировать код и красиво его написать.
Сегодня расскажем вам о том, как создать свой плагин для WordPress, словно профи.
Каким должен быть хороший плагин?
Конечно же, вы захотите сделать отличный плагин. Есть некие стандарты, которые отличают хороший подключаемый модуль он плохого:
1. Плагин построен на долгие годы
В идеале, ваш плагин должен работать не только с текущей, но и с обновленными версиями WordPress, спустя даже несколько лет.
Но как? Никакой магии – просто нужно научиться использовать стандарты WordPress.
Если вы будете следовать стандартам кода в соответствии с требованиями WordPress, потребуется очень большое обновление, чтобы плагин перестал работать.
2. Простой и легкий для чтения код
Если вы сами не можете прочитать свой код после того, как несколько дней в него не заглядывали – это плохой код.
Код должен читаться легко, как книга. Даже начинающий разработчик должен легко в нем разбираться.
Конечно, это требует времени и сознательного усилия. Чтобы вам было проще – вот два пособия для написания красивого кода.
3. Плагин не должен дублировать существующие функции
Сейчас WordPress поставляется с большим количеством функциональных возможностей.
Существует очень незначительная вероятность того, что вы предложите что-то новое.
Хороший плагин элегантно использует все, что WordPress может предложить, и делает еще что-то большее.
Когда вы создаете свой плагин, подумайте о том, как вы можете творчески использовать возможности движка. Свою идею развивать проще, чем вы думаете.
Стоит ли создавать свой собственный плагин?
Если вы не делаете плагин для того, чтобы получить новый опыт – это в большинстве случаев действительно не нужно.
Есть ситуации, когда создавать плагин необходимо:
- Когда нужного вам функционала не существует;
- Когда доступные решения слишком дороги для вашего бюджета, и вы чувствуете, что можете создать альтернативу;
- Когда вы разрабатываете тему, и некоторые функции для нее должны работать в виде плагина.
Вот ситуации, когда создавать плагин с нуля целесообразно с точки зрения бизнеса. Но если вам нужно это для опыта, для творчества, для обучения – просто делайте.
Основы разработки плагинов
Основной трюк в разработке плагина — возможность работать локально на вашем собственном компьютере.
Вот все, что нужно для оптимальной локальной среды:
Установить редактор кода
Один из лучших — редактор кода Atom.
У него открытый исходный код; и доступен на OSХ и Windows.
Запустить WordPress локально
Есть много учебных пособий о том, как это сделать. Самый простой способ — сделать это с MAMP (здесь — как использовать его для установки WordPress).
Установить WP CLI
WP CLI — интерфейс командной строки WordPress.
WP CLI сэкономит вам кучу времени, улучшая стандарты работы. Вы можете установить WordPress, плагины, темы и многое, многое другое с помощью командной строки.
WP CLI является обязательным условием для нескольких следующих рекомендаций, поэтому установите его сразу после MAMP.
Это очень легко. Есть и инструкция, как работать с ним и MAMP.
Начальная установка модульных тестов
Хорошо написанные модульные тесты помогут писать чистый код, избежать больших ошибок.
Понять концепцию вам поможет вот эта инструкция.
На данный момент, WP CLI уже должен быть установлен. Следующее, что вам нужно, это PHPUnit, который вы можете скачать здесь.
К сожалению, создание и запуск модульных тестов — это совершенно другая тема, так что мы можем только дать ссылку на хороший учебник по ней.
Очищайте свой код
Кроме выполнения модульных тестов, WP CLI дает возможность очистить свой код автоматически.
Вы можете установить линтер, который сообщит вам, когда вы нарушаете стандарты кодирования WordPress. Часто он может исправить многие из них автоматически.
Вот как установить его в командной строке:
wp package install frozzare/wp-cli-lint
В рамках проекта, все, что вам нужно сделать, это запустить:
wp lint
Спланируйте модуль перед тем, как начать кодить
Прежде чем приступить к коду, вы должны тщательно все спланировать.
Начните на бумаге
Распишите подробную функциональность вашего плагина.
Что он делает? Какие функции нужны? Какие пользователи могут добавлять или удалять контент? Какие пользователи могут видеть эти функции вообще?
Продумайте все, что вы хотите от вашего плагина. Рассмотрите каждый элемент. Все это нужно записать.
Организуйте аналогичные кусочки вместе
В результате у вас получится довольно раскиданный список, поэтому похожие моменты нужно сгруппировать.
Размышляйте в терминах WordPress. Какая функциональность подходит лучше всего? Будет ли это работать в качестве пользовательского поста? Нужен ли виджет? Вы будете делать пользовательские запросы к базе данных, или можно использовать get_posts ()?
Продумайте логику
Это самая трудная часть: вы должны делать вид, что пишете плагин, без фактического кодирования. Кодируйте на бумаге, если это помогает.
Это научит решать проблемы прагматично, не делать синтаксических ошибок. Продумайте плагин кусок за куском, логику его работы. Определите, какие данные вам нужно сообщить WordPress, и какие данные вам необходимо собрать с WordPress. Как вы будете это делать?
Чтобы найти ответ, начните исследовать конкретные методы WordPress.
Вы можете поискать в Google некоторые фрагменты кода. Будете удивлены тем, что люди уже опробовали! Добавьте в закладки учебники и фрагменты кода, которые могут подойти вашему проекту.
Это займет некоторое время, но все это - часть процесса. В конце концов, вы будете лучше информированы, и придумаете более сильные решения.
P.S. Если нет сил терпеть, вот руководство для быстрого старта; и курс по WordPress.
Распланируйте структуру проекта
Вы должны также рассмотреть вопрос организации фактических файлов для вашего проекта.
Вот примерная структура:
/plugin-slug
plugin-slug.php
/admin # admin settings pages
/assets # images, styles, scripts
/css
/img
/js
/library # all classes and other files
class.example.php
/tests # unit tests
А вот теперь можно начинать кодить
К настоящему времени, ваш плагин уже принял некоторую окончательную форму. А вы еще даже не открывали редактор!
Вся эта теория, изложенная выше, кажется нудной и никому не нужной. Но если вы хотите строить плагины, как профи, а не клепать на скорую руку импровизированные модули «на костылях» – это все очень нужно.
Перед тем, как приступить к работе над кодом, запомните два правила:
- Не повторяйтесь. У WordPress тысячи функций, которые уже делают много из того, что вам нужно. Прежде чем тратить много времени на сложные пользовательские функции, проверьте, нет ли уже готового решения.
- Стройте на фреймворке. Как уже говорилось ранее, у WordPress есть много удивительно мощных и гибких инструментов. Для того, чтобы создать хороший плагин, вы всегда должны работать с фреймворками. Используйте все лакомства WordPress в ваших интересах. Сосредоточьте усилия на то, что делает ваш плагин умным и уникальным.
Требования к основе плагина
Добро пожаловать в ваш плагин. WordPress имеет несколько минимальных требований.
Во-первых, создайте папку в локальной папке плагинов WordPress — /wordpress/wp-content/plugins. Что-то вроде /wp-dictionary.
Внутри папки создайте файл .php, который имеет то же название, что и папка — что-то вроде Wp-dictionary.php.
В верхней части этого файла, вы будете вставлять некоторую базовую информацию о вашем плагине. Вот пример:
<?php
/*
Plugin Name: Dictionary Plugin for WordPress
Plugin URI: www.yoursite/wp-dictionary
Description: Easily build your own custom dictionary with WordPress!
Version: 2.4
Author: Freelancer
Author URI: http://www.yoursite/
Поздравления!
С этого момента, все, что вам нужно сделать, это реализовать логику, разработанную вами ранее. Просто помните, что написание кода больше похоже на марафон, чем на спринт.
Создайте свой плагин по частям, проверяя каждый новый элемент с помощью модульных тестов, о которых мы говорили ранее. Рано или поздно, вы обнаружите, делаете плагин качества WordPress, который делает то, что вы ожидаете, когда вы ожидаете.
Если вы можете успешно сделать это, то вы серьезно улучшили свои навыки, которые сейчас востребованы на рынке труда.
Не так уж и плохо, а?
А где примеры кода?
Существует миллион учебных пособий, объясняющих в подробностях создание папки, добавление файлов, и активацию плагина в WordPress.
Все это очень легко ищется.
Наше же руководство – об общей правильной стратегии строительства плагина, который работает и будет работать долгое время в будущем.
Подытожим. Что же нужно, чтобы создать хороший плагин?
- Разобраться в стандартах WordPress;
- Посмотреть, нет ли такого же готового решения;
- Установить нужные программы для работы, тесты, программную строку, линтер;
- Проработать и продумать логику будущего плагина, в идеале – на бумаге;
- Приступить к кодированию.
Удачи вам в разработке профессиональных плагинов для WordPress!
0 комментариев