Добавление фильтров-хуков в ваш WordPress Theme Framework

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

Краткий обзор действий и фильтров

Прежде чем продолжить, стоит дать краткий обзор различий между действиями и фильтрами:

• Действия запускаются в определенных точках вашего кода. Хук действия сам по себе не содержит никакого кода, который выполняется, но обеспечивает местоположение, в котором вы можете выполнять свои действия с помощью функций, которые вы активируете с помощью хуков.
• Фильтры позволяют изменять код, который уже записан в вашей теме. Вместо того, чтобы быть пустым, ловушка фильтра обернута вокруг некоторого существующего кода, который вы можете затем изменить или переопределить, используя функцию, которую вы прикрепляете к ловушке.

Для получения более подробной информации см. Это великолепное руководство к действию и фильтрам .

Как создать и использовать фильтр-хук

Затем вы add_filter() доступ к этому фильтру, используя add_filter() , следующим образом:

То, что вы добавляете в функцию, заменит фильтруемый код в фреймворке, так что именно здесь вы вносите свои изменения или переопределения.

Что вам нужно

Чтобы следовать этому уроку, вам понадобится:

• Разрабатываемая установка WordPress
• Редактор кода
• Если вы работаете с кодом, используемым в моей структуре, код из предыдущего урока .

Добавление фильтров-хуков

В этом уроке я собираюсь добавить три хука фильтров в каркас:

• В шапке вложу заголовок и описание сайта в фильтр
• В нижнем колонтитуле я добавлю фильтр к функции колофона, которую мы добавили в последнем уроке

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

Добавление хука фильтра в заголовок и описание сайта

Начните с названия сайта и описания. Откройте файл header.php вашей темы и найдите следующий код:

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

В каждом случае вы заменяете bloginfo() функцию get_bloginfo() , а затем добавляете echo перед apply_filters() . Начнем с названия сайта. Отредактируйте код внутри элемента h1 так, чтобы он читал:

Как вы можете видеть, я добавил apply_filters() дважды здесь — один раз для атрибута title ссылки, а затем снова для отображаемого текста. Новый код ниже:

Это создает фильтр с именем wptutsplus_sitetitle и затем применяет его к функции get_bloginfo( 'name' ) . Это затем повторяется.

Теперь давайте сделаем то же самое с описанием сайта. Это немного проще, так как нет ссылки. Отредактируйте элемент h2 так, чтобы он читал:

Опять же, это не повлияет на выходное содержимое этого элемента, но даст вам фильтр, который вы можете использовать, чтобы изменить его позже.

Добавление фильтра-крючка в колофон

Далее я собираюсь добавить фильтр в колофон, который содержится в функции в моем файле functions.php . Это позволит пользователям моей структуры изменять или переопределять содержимое колофона.

Сначала откройте ваш файл functions.php и найдите этот блок кода:

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

Здесь я создал два фильтра:

• echo apply_filters( 'wptp_colophon_link', home_url( '/' ) применяется к ссылке, на которую указывает имя.
• echo apply_filters('wptp_colophon_name', get_bloginfo( 'name' ) ) применяется к самому имени.

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

Каждая из этих функций возвращает статический контент вместо функции php в исходном фильтре, заменяя домашний URL и имя блога моим именем и URL моего блога:

Резюме

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

В некоторых случаях вы можете обнаружить, что фильтр становится слишком сложным, и в этом случае вам нужно будет написать новую функцию или иногда создать новый файл шаблона. Например, если бы я хотел внести более существенные изменения в колофон, я бы добавил новую функцию wptp_colophon() в мою wptp_colophon() тему — поскольку wptp_colophon() в платформе является подключаемой, моя новая функция переопределит ее. Но если бы я захотел заменить весь нижний колонтитул, мне пришлось бы создать новый файл footer.php .

Однако фильтры могут быть полезны, чтобы избежать необходимости выполнять такую ​​радикальную работу — когда вы пишете файлы шаблонов вашей платформы, подумайте о том, что выводится, что ваши пользователи могут захотеть изменить, и оберните его в функцию apply_filters() .