Что такое хуки php
Хуки в PHP — расширение функций и контроллеров ядра
Общая информация
Многие функции и методы CS-Cart (Multi-Vendor) имеют специальные хуки.
Хуки позволяют модифицировать и расширять возможности платформы с помощью модуля.
С помощью хука можно:
Хуки расположены в функциях и методах ядра CS-Cart.
Общий принцип использования и работы с хуками:
Доступно очень много хуков:
Как выглядт и как использовать хук?
Хуки в PHP выглядят так:
Чтобы подключиться к хуку, вам необходимо:
Инициализировать подключение к хуку.
В данный файл добавьте функцию:
Если используте несколько хуков, передавайте названия хуков через запятую:
Создайте функцию, которая будет выполняться в хуке.
Функция должна иметь название вида: fn_[id_модуля]_[название_хука]($[параметры_хука_через_запятую])
В функции будут доступны все параметры передаваемые в хук.
Чтобы функция могла влиять на параметры (изменять снаружи), их необходимо передавать как ссылки ( &$param )
Живой пример
Предположим, что нам нужно добавить какую то новую информацию о товаре, если товара нет на складе.
Подключимся к последнему хуку и добавим нужную нам информацию с помощью модуля “Мои изменения”:
Добавим в него код:
Создадим функцию для подключения к хуку.
Создадим файл app/addons/my_changes/func.php
Добавим новую функцию, которая сработает в хуке:
Включим модуль “Мои изменения”.
Как проверить что оно работает?
Используйте функцию fn_print_r($product_data); до хука, после хука или внутри хука. Она распечатает на экран содержимое массива.
Как я могу использовать именно этот пример?
Создайте новую вкладку с SMARTY блоком для карточки товара. В данном SMARTY блоке вы можете использовать информацию из массива <$product_data>, в том числе вашу новую информацию, например, для каких либо условий.
Хуки в PHP — расширение функций и контроллеров ядра¶
Общая информация¶
Многие функции и методы CS-Cart имеют специальные хуки.
Хуки позволяют модифицировать и расширять возможности платформы с помощью модуля.
С помощью хука можно:
Хуки расположены в функциях и методах ядра CS-Cart.
Общий принцип использования и работы с хуками:
Доступно очень много хуков:
Как выглядит и как использовать хук?¶
Хуки в PHP выглядят так:
Чтобы подключиться к хуку, вам необходимо:
Инициализировать подключение к хуку.
В данный файл добавьте функцию:
Если используте несколько хуков, передавайте названия хуков через запятую:
Создайте функцию, которая будет выполняться в хуке.
Функция должна иметь название вида: fn_[id_модуля]_[название_хука]($[параметры_хука_через_запятую])
В функции будут доступны все параметры передаваемые в хук.
Чтобы функция могла влиять на параметры (изменять снаружи), их необходимо передавать как ссылки ( &$param )
Живой пример¶
Предположим, что нам нужно добавить какую то новую информацию о товаре, если товара нет на складе.
Подключимся к последнему хуку и добавим нужную нам информацию с помощью модуля “Мои изменения”:
Добавим в него код:
Создадим функцию для подключения к хуку.
Создадим файл app/addons/my_changes/func.php
Добавим новую функцию, которая сработает в хуке:
Включим модуль “Мои изменения”.
Как проверить что оно работает?
Используйте функцию fn_print_r($product_data); до хука, после хука или внутри хука. Она распечатает на экран содержимое массива.
Как я могу использовать именно этот пример?
Создайте новую вкладку с SMARTY блоком для карточки товара. В данном SMARTY блоке вы можете использовать информацию из массива <$product_data>, в том числе вашу новую информацию, например, для каких либо условий.
Разграничение редакций¶
Хуки, которыми будут расширяться редакции, необходимы, чтобы избежать услвоий по типу:
Нам нужно расширить данную функцию в Multi-Vendor. Таким образом, в файле /app/functions/fn.multivendor.php создаем функцию:
Код для определенной редакции¶
Или же использовать отрицание:
Первая часть кода означает, что этот код появится в перечисленных редакциях, вторая же часть — что код НЕ появится в этих редакциях
Хуки в PHP скриптах¶
Версионные теги так же используют фукнцию fn_allowed_for :
Что такое хуки php
У каждого хука должен быть комментарий с описанием (например, точка входа, или что делает хук), а также с описанием параметров (только для PHP-хуков ).
Основные тезисы по хукам¶
Хуки нужны для расширения функций разработчиками. Поэтому передавайте в хук максимум параметров — лучше перестараться, чем недостараться.
В названии хука обязательно должно содержаться название функции.
Префиксы использовать нельзя. Можно использовать только суффиксы.
Если у вас сложная функция, и в ней много хуков, то именовать хуки можно примерно так:
Для хуков в классах: каждый хук должен содержать название класса, в котором он вызывается.
Для хуков в классах: каждый хук должен первым параметром передавать инстанс класса:
Как и куда добавлять хуки¶
Исходим из того, что в каждой функции должно быть минимум два хука:
Также могут быть дополнительные хуки:
extra hooks, как пример, можно посмотреть на функцию выбора товаров:
Некоторые хуки не соответствуют вышеозначенным стандартам, тогда ставим им комментарий такого вида:
Формат оформления хуков¶
Ниже приведены форматы для комментариев для базы хуков.
PHP-хуки и функции¶
Формат комментариев заимствован у PHPDocumentor. Такой формат комментариев должен применяться повсеместно ко всем функциям.
Для генерации документации используется программа Doxygen (вот руководство).
Основные правила и рекомендации по написанию комментариев:
Комментарий начинается с большой буквы, точка в конце не ставится.
Глагол для описания того, что делает функция, употребляется в 3 лице и единственном числе, т.е. “Получает данные пользователя” — “Gets user data”.
Названия и значения переменных, пути к файлам, названия файлов и прочие имена собственные следует выделять курсивным написанием (при помощи HTML-тега ).
Например: Function foo (in foo/bar/functions) accepts parameter $bar
По возможности старайтесь описать переменную так, чтобы было ясно, зачем она нужна именно этой функции.
Комментарий должен находится непосредственно перед хуком.
10 полезных хук-хаков для WordPress
ВВЕДЕНИЕ
Хуки являются очень полезными фишками в WordPress. Они позволяют как бы «посадить» пользовательскую функцию «на крючок» функции существующей, разрешая тем самым изменять функциональность WordPress без внесения изменений в файлы ядра движка. В этой статье мы представляем Вам 10 особенно полезных, готовых к использованию хуков для WordPress, с примерами и пояснениями их исходников.
ЧТО ТАКОЕ ХУК?
Для достижения определенного эффекта нам нужно слегка изменить принцип работы WordPress. Некоторые модификации необходимо внести в файлы, которые были названы разработчиками файлами ядра – они нужны для того, чтобы WordPress работал должным образом.
Но изменение файлов ядра – плохая идея: это может создать брешь в системе безопасности блога. Также, все модификации исчезнут, как только Вы обновите движок до новой версии.
Однако, расширение функциональности все же необходимо. Для этого разработчиками был придуман Plugin API.
Хуки являются одним из главных блоков для построения плагинов. Почти каждый подключаемый плагин использует хуки для расширения функциональности WordPress.
КАК ИСПОЛЬЗОВАТЬ ХУКИ В ВАШЕМ БЛОГЕ
Пока Вы не написали свой плагин, Вы должны записать хуки в файл functions.php. Этот файл находится в директории wp-content/themes/yourtheme (где /yourtheme – директория, в которой находится текущая тема).
Вот пример, который показывает, как подключить Вашу пользовательскую функцию к функции ядра движка:
В этом примере мы подключили пользовательскую функцию myCustomFunction() к функции ядра publish_post(). Функция myCustomFunction() будет выполняться при каждом выполнении функции publish_post().
Конечно, мы можем также удалить хук, используя функцию remove_action():
1. ОТКЛЮЧАЕМ АВТОМАТИЧСКОЕ ФОРМАТИРОВАНИЕ В WORDPRESS
Проблема.
Вы, наверное, уже замечали, что типограф WordPress по умолчанию превращает «прямые» кавычки в «кривые» и делает другие мелкие изменения в форматировании поста.
Это хорошо, если блоггер размещает обычный контент (подразумеваются обычный текст и картинки). Но некоторые постят исходный код, чтобы потом его обсуждать, и они будут очень недовольны, когда из-за этих «кривых» кавычек интерпретатор иди компилятор выдадут им сообщения о синтаксических ошибках.
Решение.
Просто вставьте в файл functions.php нижеследующий код:
После того, как Вы это сделали, можете использовать тэг [raw] для того, чтобы текст поста был не отформатирован автоматически:
[raw]This text will not be automatically formatted.[/raw]
Объяснение кода.
Первым делом, мы создаем функцию, которая, основываясь на регулярных выражениях, находит тэг [raw] в содержании Вашего поста.
Далее, мы привязываем нашу функцию my_formatter() к функции the_content(), что означает выполнение нашей функции всякий раз, когда вызывается функция the_content().
Для того, чтобы отключить автоформатирование, мы использовали функцию remove_filter().
2. ОПРЕДЕЛЯЕМ БРАУЗЕР ПОСЕТИТЕЛЯ ПРИ ПОМОЩИ ХУКОВ
Проблема.
Кросс-браузерная совместимость – это наиболее распространенная проблема в web-разработке. Вы сэкономите много нервов и времени, если сможете определить браузер пользователя, зашедшего на Ваш блог, а затем создав CSS-класс для тэга body под каждый из браузеров.
Решение.
Ничего сложного: просто вставьте нижеследующий код в файл functions.php, сохраните его – все готово!
После того, как Вы сохраните файл, функция автоматически будет добавлять CSS-класс, соответствующий пользовательскому браузеру, для тэга body:
Объяснение кода.
WordPress имеет глобальные переменные, которые возвращают true, если пользователь использует соответствующий браузер. Если пользователь использует браузер Google Chrome, то переменная $is_chrome примет значение true. Вот для чего мы и создаем функцию browser_body_class(). После этого мы присоединяем ее к WordPress функции body_class().
3. ОПРЕДЕЛЕНИЕ ТЕКСТА ПО УМОЛЧАНИЮ В РЕДАКТОРЕ TinyMCE
Проблема.
Многие блоггеры почти всегда используют для своего блога один и тот же формат. Сообщения в моем блоге WpRecipes.com всегда отображаются одинаково: текст, код, еще немного текста.
Можно сэкономить немало времени, если научить TinyMCE отображать какой-нибудь текст по умолчанию.
Решение.
Как всегда, решением является хук. Копируем код в файл functions.php и смотрим, как он работает.
Объяснение кода.
Этот код хоть и простой, но очень мощный. Просто создаем функцию, которая возвращает требуемый текст (в этом примере мы определяем текст, который спрашивает у посетителей о подписке на RSS-ленту), и присоединяем ее к WordPress-функции default_content(). Вот так.
4. ВСТАВЛЯЕМ КОНТЕНТ АВТОМАТИЧЕСКИ ПОСЛЕ КАЖДОГО ПОСТА
Проблема.
В большинстве блогов для вывода контента после каждого поста файл single.php, но вот беда: этот контент не будет отображаться в RSS-ленте. Хуки помогут исправить эту проблему.
Решение.
Все то же самое – просто копируем следующий код в файл fucntions.php.
Enjoyed this article?
Subscribe to our RSS feed and never miss a recipe!
Объяснение кода.
Суть функции insertFootNote() проста: он лишь конкатенирует желаемый текст к переменной $content, в которой хранится содержание поста.
Затем, мы присоединяем нашу функцию insertFootNote() к функции the_content().
Видите в строке 2 вот такой код:
Если Вам нужно, чтобы текст попадал в RSS-ленту, то замените предыдущий код на этот:
5. ОТКЛЮЧАЕМ СООБЩЕНИЕ С ПРОСЬБОЙ ОБНОВИТЬСЯ В ПАНЕЛИ УПРАВЛЕНИЯ WORDPRESS
Проблема.
Вы можете видеть информацию о наличии новой версии WordPress вверху дашборда. Это действительно хорошая штука, так как обновление закрывает дыры в безопасности и позволяет пользоваться Вам последними возможностями движка. Но если блог не Ваш лично, а является проектом для кого-нибудь из клиентов, то давать возможность клиентам самим обновляться – не есть хорошая идея.
Решение.
Просто вставьте следующий код в файл fucntions.php.
После того, как Вы сохраните файл functions.php, сообщения Вы больше не увидите.
Объяснение кода.
Для начала, убедимся, что текущий пользователь обладает достаточными правами администратора, чтобы можно было обновить WordPress. Как только мы в этом убедились, создаем пару хуков, которые переписывают правила отображения сообщений в дашборде.
6. ОТКЛЮЧАЕМ АВТОСОХРАНЕНИЕ ПОСТОВ
Проблема.
WordPress периодически сохраняет пост по мере его введения. Это полезная возможность, но иногда она не требуется.
Решение.
Для того, чтобы отключить автосохранение поста, просто откройте файл functions.php и вставьте в него следующий код.
Объяснение кода.
И вновь, ничего сложного: мы просто создаем функцию, которая отключается автосохранение и привязываем ее к WordPress-функции wp_print_scripts().
7. ИЗБАВЛЯЕМСЯ ОТ ПОВТОРЯЮЩЕГОСЯ КОНТЕНТА НА СТРАНИЦАХ С КОММЕНТАРИЯМИ
Проблема.
Повторяющийся контент эта довольно распространенная SEO-проблема.
Введенная в WordPress версии 2.7 система разбиения комментариев на страницы эту проблему не решает.
Для предупреждения повторяющегося контента в комментариях будем использовать атрибут rel=«canonical».
Решение.
Копируем следующий код и вставляем его в файл functions.php.
Объяснение кода.
Сначала, мы создаем функцию, которая добавляет к каждой странице с комментариями, кроме первой, тэг link с атрибутом rel=«canonical». Затем, присоединяем эту функцию к WordPress-функци wp_head().
8. ПОЛУЧЕНИЕ ПОСТА ИЛИ СТРАНИЦЫ В КАЧЕСТВЕ PHP-ПЕРЕМЕННОЙ
Проблема.
Возможность получить текущий пост или целую страницу в качестве PHP переменной – действительно крутая вещь. Скажем, Вы можете заменять некоторые части контента при помощи функции str_replace() или делать с ним еще что-нибудь.
Решение.
И снова ничего сложного. Делаем все то же самое: вставляем следующий код в файл functions.php.
Объяснение кода.
9. ИСПОЛЬЗУЕМ ХУКИ И CRON ДЛЯ СОБЫТИЙ ПО РАСПИСАНИЮ
Проблема.
Вы, наверное, уже знаете, что WordPress может использовать события по расписанию. К примеру, можно публиковать посты в конкретное, установленное заранее, время. Используя хуки и wp-cron, мы можем запросто задать расписание для нашего собственного события. В следующем примере мы заставим блог отправлять нам сообщения на e-mail один раз каждый час.
Решение.
Вставляем следующий код в файл functions.php.
Объяснение кода.
Первое, что мы сделаем, конечно, — это создадим функцию, которая будет выполнять требуемое действие. В этом примере эта функция называется my_task_function() и она просто отправляет письмо на указанный e-mail адрес.
Для того, чтобы запланировать выполнение этой функции, мы будем использовать функцию wp_schedule_event(). Последним аргументом, передаваемым ей, будет наш хук, поэтому мы «цепляем» нашу функцию my_task_function() к my_task_hook.
10. СПИСОК ВСЕХ «ХУКНУТЫХ» ФУНКЦИЙ
Проблема.
Когда что-то идет не так, здорово может пригодиться список всех «хукнутых» функций.
Решение.
Как и все предыдущие фрагменты кода следующий также необходимо вставить в файл functions.php. Только не забудьте удалить его после использования. Если Вы этого не сделаете, то сообщения будут появляться и после отладки.
После того, как Вы вставите этот код в файл functions.php, вызовите функцию list_hooked_functions(). Она и покажет Вам список всех «хукнутых» функций.
Объяснение кода.
Данный код выясняет, передается ли имя хука в качестве аргумента функции. Если передается, то на экран выводится имя хука. Также можно посмотреть хуки только для определенной функции:
PHP система плагинов на основе хуков (hooks)
Здравствуйте, уважаемые читатели блога LifeExample, сегодня предлагаю затронуть очень редкую тему, информации о которой в интернете, кране не хватает. Говорить мы будем о том, как самостоятельно сделать систему плагинов для своей CMS.
Однажды, я где-то читал мысль, что каждый уважающий себя php программист, обязан, хотя бы попробовать сделать свою CMS. И на самом деле очень много, моих знакомых разрабатывали свои домашние системы управления сайтом. Вот и я не стал исключением, и сделал собственную CMS, которая в последствии вылилась в обособленный проект MOGUTA.CMS.
MOGUTA.CMS теперь имеет все задатки, для того, чтобы попытаться покорить сердца начинающих предпринимателей, дав им возможность комфортно управлять своими интернет-магазинами. Именно поэтому у меня давно уже зрело желание создать систему плагинов для своей CMS, да такую чтобы она была легкой и удобной для работы пользователей и программистов.
Проработав некоторое время с движком WordPress, я не мог не оценить его механизм взаимодействия плагинов и ядра, который основан на системе хуков (Hooks – с англ. крючек, зацепка). Опираясь именно на эту концепцию системы плагинов, я решил разработать ее аналог в своей CMS.
PHP hooks – хуки и их концепция
Система хуков как нельзя лучше подходит для расширения функционала CMS, поскольку позволяет довольно гибко оперировать функциями движка, меняя их логику и поведение. Поскольку мне не довелось встретить толкового и обширного объяснения природы плагинов на основе хуков, я попробую изложить ее смысл, настолько — насколько сам его понимаю.
Предлагаю рассмотреть, что такое php hooks, и как их реализовать на простом примере.
В упрощенном виде, система хуков в PHP может выглядеть таким образом:
В общих чертах система хуков именно так и должна работать, но это далеко не все ее возможности. С помощью хуков в php можно полностью изменить тело функции, в которой был создан хук, а можно лишь повлиять на результат, перед тем как она его вернет, также можно передать в исходную функцию другие параметры. Все это позволяет сделать систему неимоверно гибкой.
Но за такую гибкость приходится платить производительностью системы в целом, поэтому перед реализацией в php системы хуков, советую хорошенько подготовиться теоретически.
Как реализовать Hooks
На самом деле система хуков намного сложнее, чем приведенная ниже, но на первом этапе знакомства будет вполне достаточно рассмотреть в миниатюре механизм взаимодействия плагинов и ядра.
В архиве находится три файла:
Давайте начнем разбираться с файла index.php
//Эмуляция запуска ядра системы
$core = new Core ( ) ;
В данном скрипте происходит:
Следующая строка, создает действие с именем ‘demoHook’
Откроем из архива файл plugin.php
//пользовательская функция выполняющаяся при определенном событии
function myFunction ( ) <
echo »
>>>Действия плагина ;
>
Запустив файлы архива, мы увидим такой результат:
Как устроена система хуков
В выше приведенном примере использовалась библиотека для механизма крючков и зацепок, мы подключали ее строкой:
Давайте откроем этот файл и посмотрим, что же в нем хранится, и как все это работает.
/**
* Библиотека хуков, содержит интерфейсы PluginManager и Hook,
* а также класс PM и EventHook
* Класс PM предназначен для управления плагинами
* Класс Hook создает обработчик событий
*
* Автор: Авдеев Марк
* Ссылка на описание: http://lifeexampl.nichost.ru/php-primeryi-skriptov/php-sistema-plaginov-na-osnove-hukov-hooks.html
*/
// Клас PM (plugin Manager) управляет плагинами,
// регистрирует плагины и устанавливает их взаимодействие с системой.
class PM implements PluginManager <
//Вешает обработчик для заданного хука
class EventHook implements Hook <
Вся логика взаимодействия хуков с обработчиками основана на паттерне observer, также известного как «Издатель и Подписчик». Я не буду сейчас описывать суть данного шаблона проектирования, поскольку делал это ранее.
Смысл заключается в том, что все пользовательские функции регистрируются для соответствующих действий классом PM в качестве обработчиков событий-хуков (EventHook).
В результате, зарегистрированные на этапе подключения плагинов функции, могут влиять на поведения любого из стандартных системных методов, а это полностью удовлетворяет задачу плагинов.
Вывод
Согласитесь, что самостоятельно придумать и спроектировать систему плагинов не простое занятие. Этот материал о системе плагинов и хуков, который я изложил в данной статье, должен лишь натолкнуть вас на правильное решение, но не стоит воспринимать его как законченную систему плагинов.
Ну а если вам все же интересно как можно развить данную заготовку до полноценной системы плагинов, рекомендую ознакомиться с моим движком MOGUTA.CMS, в котором механизм хуков учитывает все атрибуты настоящих плагинов такие как:
Также всех желающих разобраться с тем как устроен движок, и помочь в его дальнейшем развитии приглашаю сюда.
Надеюсь эта реализация системы хуков оказалась для вас настолько же интересной как и для меня.