Написание простого плагина WordPress, руководство для начинающих

Учебники

Последнее обновление Сен 22, 2021

Содержание

Основы, которые нужно знать перед созданием плагина WordPress

Как назвать плагин WordPress

Как создать файлы плагинов

Добавление заголовка файла в основной файл PHP

Как написать простой плагин для WordPress – WP Renym

Название нашего плагина

Добавление функций

Сжать папку

Используйте свой плагин

Ресурсы

Заключение

На языке непрофессионала плагин WordPress – это простая программа, которая помогает вам настраивать и улучшать ваш веб-сайт WordPress без необходимости редактировать базовые программы. Когда мастер WordPress плагин развития, вы будете иметь возможность добавлять всевозможные функциональности вашего блога в кратчайшие сроки. Но прежде чем стать профессионалом, вы должны изучить веревки.

Плагин WordPress – это программа или набор из одной или нескольких функций, написанных на языке сценариев PHP, которые добавляют определенный набор функций или услуг в веб-журнал WordPress, который может быть легко интегрирован с веб-журналом с использованием точек доступа и методов. предоставляется программным интерфейсом (API) плагина WordPress. – Написание плагина WordPress Codex

В сегодняшнем посте мы проведем вас через процесс создания вашего первого плагина WordPress. Мы сделаем это руководство простым, чтобы помочь разработчикам-новичкам, которые практически не знают PHP (язык сценариев, лежащий в основе WordPress).

Однако прежде чем приступить к написанию кода, мы рассмотрим несколько моментов, которые вам следует знать о разработке плагинов для WordPress.

Основы, которые нужно знать перед созданием плагина WordPress

В этом разделе мы раскроем первые несколько шагов, которые вам нужно выполнить при создании плагина WordPress. Кроме того, мы упомянем все различные вещи, которые вам нужно учитывать при написании плагина. Отлично. Начнем с основ.

Как назвать плагин WordPress

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

Имя вашего плагина должно быть уникальным, чтобы избежать конфликтов с другими плагинами. Чтобы убедиться, что ваше имя уникально, вы можете выполнить поиск в Google по имени. Кроме того, вы можете выполнять поиск в различных каталогах плагинов, включая репозиторий плагинов WordPress.

Чтобы назвать любой плагин, мы должны создать хотя бы один файл плагина (основной файл PHP), который вводит нас в наш следующий раздел.

Как создать файлы плагинов

Плагин может состоять из одного файла PHP или нескольких файлов в зависимости от того, для чего он предназначен. Самый важный файл – это главный файл PHP, который является эквивалентом index.php и index.html в темах WordPress и дизайне HTML соответственно.

Разработчикам WordPress рекомендуется по соглашению называть свой основной файл плагина в честь своего плагина. Например, основным файлом плагина для плагина под названием WP Renym plugin будет wp-renym.php. Если вы добавляете разделитель в свое имя, используйте только дефис (-) между словами, а не символы подчеркивания (_).

Как упоминалось выше, плагин может состоять из одного или нескольких файлов (изображений, JavaScript, языка, файлов CSS и т.д. ). В любом случае файлы ваших плагинов должны находиться в одном каталоге. Таким образом, для плагинов с именем WP Renym файл wp-renym.php будет помещен в папку wp-renym. Дополнительные подпапки могут быть добавлены внутри основной папки плагина для хранения и организации других файлов.

После того, как вы заложите весь код для плагина, вы затем сжимаете свою основную папку в zip-файл (в данном случае это будет архив wp-renym.zip), который будет загружен и установлен на сайте WordPress.

Добавление заголовка файла в основной файл PHP

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


/*
Plugin Name: Name of your plugin
Plugin URI:  http://link to your plugin homepage
Description: Describe what your plugin is all about in a few short sentences
Version:     1.0
Author:      Your name (Yay! Here comes fame...) Author URI:  http://link to your website
License:     GPL2 etc
License URI: http://link to your plugin license
*/

Каждый параметр в заголовке выше не требует пояснений, поэтому я не буду вдаваться в подробности. Просто убедитесь, что вы включили соответствующий http: // или https: // при написании URI плагина и автора, иначе ссылки не будут работать.

Если вы будете использовать лицензию GPL2 или лицензию, совместимую с GPL2, укажите в заголовке следующую информацию о лицензии :


/* Copyright YEAR PLUGIN_AUTHOR_NAME (email: your email address)
(Plugin Name) 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
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 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 (Plugin Name). If not, see (http://link to your plugin license).
*/

Объем этого руководства не позволяет нам выйти за рамки этих основных шагов. Вам нужно будет ознакомиться с написанием руководства по плагинам в кодексе, чтобы узнать больше о хуках плагинов WordPress, тегах шаблонов, сохранении данных плагина в базах данных, механизме параметров плагина и обновлении вашего плагина среди прочего. Кодекс также включает в себя обширную коллекцию ресурсов для подключаемых модулей, в которой есть видео-руководства, сложные темы и многое другое.

Теперь, когда мы рассмотрели основы, давайте напишем простой плагин WordPress, который будет выполнять две основные (но отличные) функции:

Замените слова в вашем контенте на ваш собственный выбор слов
Добавьте пометку «Спасибо, что прочитали это руководство…» в конце каждого сообщения в блоге.

Как написать простой плагин для WordPress – WP Renym

В этом разделе мы напишем код для плагина WP Renym, о котором я упоминал все время.

Что вам нужно:

Ваш любимый редактор кода (например, Notepad ++ и SublimeText )
Браузер, чтобы увидеть ваш плагин в работе (например, Chrome )
Рабочая установка WordPress

Название нашего плагина

Сначала мы проверили репозиторий плагинов WordPress и выполнили поиск в Google по нашему имени; В. П. Реним был свободен. Изначально я выбрал WP Rename, но он уже был занят.

Продолжаем … Откройте новый файл в редакторе кода и добавьте следующий код вверху после открытия плагина с помощью <? Php :


/*
Plugin Name: WP Renym
Plugin URI:  http://link to your plugin homepage
Description: This plugin replaces words with your own choice of words.
Version:     1.0
Author:      Freddy Muriuki
Author URI:  http://link to your website
License:     GPL2 etc
License URI: https://link to your plugin license
Copyright YEAR PLUGIN_AUTHOR_NAME (email: your email address)
(Plugin Name) 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
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 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 (Plugin Name). If not, see (http://link to your plugin license).
*/

Сохраните файл как wp-renym.php в папке wp-renym. Если у вас еще нет папки, создайте ее. wp-renym.php будет вашим основным файлом PHP.

Добавление функций

Теперь добавим в плагин актуальные функции. Чуть ниже кода выше добавьте следующую функцию для исправления орфографических ошибок wordpress в WordPress :


function renym_wordpress_typo_fix( $text) {
    return str_replace( 'wordpress', 'WordPress', $text );
}
add_filter( 'the_content', 'renym_wordpress_typo_fix' );

renymwordpresstypo_fix – это уникальное имя, которое мы дали нашей функции. При добавлении новых функций никогда не начинайте их с wp – это для предотвращения любой будущей несовместимости с функциями кода WordPress, которые все используют префикс wp.

Наша функция PHP принимает ($ text) в качестве аргумента и возвращает первую строку wordpress, замененную второй строкой WordPress.

Мы добавили фильтр (add_filter) в наш плагин, чтобы наша функция (renym_wordpress_typo_fix) работала с выбранным текстом, который в данном случае является всем содержимым сообщения (the_content).

Чтобы заменить более одного слова (возможно, вы хотели бы отредактировать несколько слов в своем блоге или использовать плагин в качестве простого фильтра ненормативной лексики), замените приведенный выше код следующим кодом:


function renym_content_replace( $content) {
    $search  = array( 'wordpress', 'goat', 'Easter', '70', 'sensational' );
    $replace = array( 'WordPress', 'coffee', 'Easter holidays', 'seventy', 'extraordinary' );
    return str_replace( $search, $replace, $content );
}
add_filter( 'the_content', 'renym_content_replace' );

В приведенном выше коде мы уже выбрали слова для замены, например wordpress, goat, Easter и т.д. Мы также выбрали слова для замены, например WordPress, кофе, пасхальные каникулы и т.д. Надеемся, что код в некоторой степени говорит сам за себя:

Функция renym_content_replace принимает ($ content) в качестве аргумента, заменяет все слова, содержащиеся в массиве $ search, и возвращает теперь измененные слова в WordPress.
$ search содержит все слова, которые нужно заменить
$ replace содержит заменяющие слова
str_replace делает то, что умеет лучше всего, заменяя слова новыми словами

Обратите внимание, как мы добавляем префикс renym к каждой функции. Это предотвращает конфликты с другими плагинами, которые могут быть установлены. Вы должны иметь привычку добавлять префиксы к своим функциям, разрабатываете ли вы плагины, темы или виджеты.

Если вы выполнили вышеуказанные шаги, ваш плагин сможет эффективно заменить все выбранные вами слова. Теперь давайте добавим примечание «Спасибо, что прочитали это руководство…», которое будет отображаться в нижней части каждого сообщения. Добавьте следующий код в свой основной файл плагина (renym_content_replace) перед закрывающей скобкой PHP (?> ), Которая находится в последней строке:

Сохраните изменения. Функция renym_content_footer_note добавляет разметку HTML к параметру $ content и возвращает новое значение в WordPress. Мы также добавили к нашему тексту класс нижнего колонтитула, чтобы его можно было легко стилизовать позже.

Мы включили фильтр (add_filter), который сообщает нашей функции работать с выбранным текстом, который является содержимым сообщения, представленным the_content.

Сжать папку

На этом этапе ваш окончательный файл wp-renym.php должен выглядеть так:

Сохраните все свои изменения. Сожмите папку WP Renym в архив wp-renym.zip (на Mac это так же просто, как щелкнуть правой кнопкой мыши, сжать файл – и на ПК, я думаю, это очень похоже). Просто убедитесь, что ваш файл сохранен с расширением .ZIP, иначе плагин не установится.

Используйте свой плагин

Загрузите и активируйте свой новый плагин WP Renym через экран плагинов WordPress. Поздравляю с написанием вашего первого плагина!

Ресурсы

Чтобы узнать больше о разработке плагинов для WordPress, ознакомьтесь со следующими ресурсами:

Заключение

Я надеюсь, что этот урок указал вам правильное направление в понимании плагинов. Этот пост должен послужить отправной точкой для разработки сложных плагинов WordPress, которые будут делать все, что вы хотите. Не останавливайтесь здесь, ознакомьтесь с ресурсами, которые я рекомендовал выше, чтобы расширить свои знания о разработке плагинов WordPress.

Если вы нашли это руководство полезным или у вас есть что добавить, мы будем рады узнать. Пожалуйста, поделитесь своими мыслями в разделе комментариев ниже. Увидимся вокруг ?

Источник записи: https://www.wpexplorer.com