10 полезных хук-хаков для Wordpress

О том, что такое хуки в Wordpress и как их там использовать. Статья молодого Wordpress-специалиста, владельца сайта www.wprecipes.com, из Бельгии.

ВВЕДЕНИЕ

Хуки являются очень полезными фишками в Wordpress. Они позволяют как бы «посадить» пользовательскую функцию «на крючок» функции существующей, разрешая тем самым изменять функциональность Wordpress без внесения изменений в файлы ядра движка. В этой статье мы представляем Вам 10 особенно полезных, готовых к использованию хуков для Wordpress, с примерами и пояснениями их исходников.

ЧТО ТАКОЕ ХУК?

Для достижения определенного эффекта нам нужно слегка изменить принцип работы Wordpress. Некоторые модификации необходимо внести в файлы, которые были названы разработчиками файлами ядра – они нужны для того, чтобы Wordpress работал должным образом.
Но изменение файлов ядра – плохая идея: это может создать брешь в системе безопасности блога. Также, все модификации исчезнут, как только Вы обновите движок до новой версии.
Однако, расширение функциональности все же необходимо. Для этого разработчиками был придуман Plugin API.
Хуки являются одним из главных блоков для построения плагинов. Почти каждый подключаемый плагин использует хуки для расширения функциональности Wordpress.

КАК ИСПОЛЬЗОВАТЬ ХУКИ В ВАШЕМ БЛОГЕ

Пока Вы не написали свой плагин, Вы должны записать хуки в файл functions.php. Этот файл находится в директории wp-content/themes/yourtheme (где /yourtheme – директория, в которой находится текущая тема).
Вот пример, который показывает, как подключить Вашу пользовательскую функцию к функции ядра движка:

1. add_action ( 'publish_post', 'myCustomFunction' );

В этом примере мы подключили пользовательскую функцию myCustomFunction() к функции ядра publish_post(). Функция myCustomFunction() будет выполняться при каждом выполнении функции publish_post().
Конечно, мы можем также удалить хук, используя функцию remove_action():

1. remove_action ( 'publish_post', 'myCustomFunction' );

1. ОТКЛЮЧАЕМ АВТОМАТИЧСКОЕ ФОРМАТИРОВАНИЕ В WORDPRESS

Проблема.

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

Решение.

Просто вставьте в файл functions.php нижеследующий код:

1. function my_formatter($content) {
2. $new_content = '';
3. $pattern_full = '{(\[raw\].*?\[/raw\])}is';
4. $pattern_contents = '{\[raw\](.*?)\[/raw\]}is';
5. $pieces = preg_split($pattern_full, $content, -1, PREG_SPLIT_DELIM_CAPTURE);
6.  
7. foreach ($pieces as $piece) {
8. if (preg_match($pattern_contents, $piece, $matches)) {
9. $new_content .= $matches[1];
10. } else {
11. $new_content .= wptexturize(wpautop($piece));
12. }
13. }
14.  
15. return $new_content;
16. }
17.  
18. remove_filter('the_content', 'wpautop');
19. remove_filter('the_content', 'wptexturize');
20.  
21. add_filter('the_content', 'my_formatter', 99);

После того, как Вы это сделали, можете использовать тэг [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, сохраните его – все готово!

1. add_filter('body_class','browser_body_class');
2. function browser_body_class($classes) {
3. global $is_lynx, $is_gecko, $is_IE, $is_opera, $is_NS4, $is_safari, $is_chrome, $is_iphone;
4.  
5. if($is_lynx) $classes[] = 'lynx';
6. elseif($is_gecko) $classes[] = 'gecko';
7. elseif($is_opera) $classes[] = 'opera';
8. elseif($is_NS4) $classes[] = 'ns4';
9. elseif($is_safari) $classes[] = 'safari';
10. elseif($is_chrome) $classes[] = 'chrome';
11. elseif($is_IE) $classes[] = 'ie';
12. else $classes[] = 'unknown';
13.  
14. if($is_iphone) $classes[] = 'iphone';
15. return $classes;
16. }

После того, как Вы сохраните файл, функция автоматически будет добавлять CSS-класс, соответствующий пользовательскому браузеру, для тэга body:

1. <body class="home blog logged-in safari">

Объяснение кода.

Wordpress имеет глобальные переменные, которые возвращают true, если пользователь использует соответствующий браузер. Если пользователь использует браузер Google Chrome, то переменная $is_chrome примет значение true. Вот для чего мы и создаем функцию browser_body_class(). После этого мы присоединяем ее к Wordpress функции body_class().

3. ОПРЕДЕЛЕНИЕ ТЕКСТА ПО УМОЛЧАНИЮ В РЕДАКТОРЕ TinyMCE

Проблема.

Многие блоггеры почти всегда используют для своего блога один и тот же формат. Сообщения в моем блоге WpRecipes.com всегда отображаются одинаково: текст, код, еще немного текста.
Можно сэкономить немало времени, если научить TinyMCE отображать какой-нибудь текст по умолчанию.

Решение.

Как всегда, решением является хук. Копируем код в файл functions.php и смотрим, как он работает.

1. add_filter('default_content', 'my_editor_content');
2.  
3. function my_editor_content( $content ) {
4. $content = "If you enjoyed this post, make sure to subscribe to my rss feed.";
5. return $content;
6. }

Объяснение кода.

Этот код хоть и простой, но очень мощный. Просто создаем функцию, которая возвращает требуемый текст (в этом примере мы определяем текст, который спрашивает у посетителей о подписке на RSS-ленту), и присоединяем ее к Wordpress-функции default_content(). Вот так.

4. ВСТАВЛЯЕМ КОНТЕНТ АВТОМАТИЧЕСКИ ПОСЛЕ КАЖДОГО ПОСТА

Проблема.

В большинстве блогов для вывода контента после каждого поста файл single.php, но вот беда: этот контент не будет отображаться в RSS-ленте. Хуки помогут исправить эту проблему.

Решение.

Все то же самое – просто копируем следующий код в файл fucntions.php.

1. function insertFootNote($content) {
2.         if(!is_feed() && !is_home()) {
3.                 $content.= "<div class='subscribe'>";
4.                 $content.= "<h4>Enjoyed this article?</h4>";
5.                 $content.= "<p>Subscribe to our  <a href='http://feeds2.feedburner.com/WpRecipes'>RSS feed</a> and never miss a recipe!</p>";
6.                 $content.= "</div>";
7.         }
8.         return $content;
9. }
10. add_filter ('the_content', 'insertFootNote');

Объяснение кода.

Суть функции insertFootNote() проста: он лишь конкатенирует желаемый текст к переменной $content, в которой хранится содержание поста.
Затем, мы присоединяем нашу функцию insertFootNote() к функции the_content().
Видите в строке 2 вот такой код:

1. if(!is_feed() && !is_home()) {

Если Вам нужно, чтобы текст попадал в RSS-ленту, то замените предыдущий код на этот:

1. if (!is_home()) {

Вот и все.

5. ОТКЛЮЧАЕМ СООБЩЕНИЕ С ПРОСЬБОЙ ОБНОВИТЬСЯ В ПАНЕЛИ УПРАВЛЕНИЯ WORDPRESS

Проблема.

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

Решение.

Просто вставьте следующий код в файл fucntions.php.

1. if (!current_user_can('edit_users')) {
2.   add_action( 'init', create_function( '$a', "remove_action( 'init', 'wp_version_check' );" ), 2 );
3.   add_filter( 'pre_option_update_core', create_function( '$a', "return null;" ) );
4. }

После того, как Вы сохраните файл functions.php, сообщения Вы больше не увидите.

Объяснение кода.

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

6. ОТКЛЮЧАЕМ АВТОСОХРАНЕНИЕ ПОСТОВ

Проблема.

Wordpress периодически сохраняет пост по мере его введения. Это полезная возможность, но иногда она не требуется.

Решение.

Для того, чтобы отключить автосохранение поста, просто откройте файл functions.php и вставьте в него следующий код.

1. function disableAutoSave(){
2.     wp_deregister_script('autosave');
3. }
4. add_action( 'wp_print_scripts', 'disableAutoSave' );

Объяснение кода.

И вновь, ничего сложного: мы просто создаем функцию, которая отключается автосохранение и привязываем ее к Wordpress-функции wp_print_scripts().

7. ИЗБАВЛЯЕМСЯ ОТ ПОВТОРЯЮЩЕГОСЯ КОНТЕНТА НА СТРАНИЦАХ С КОММЕНТАРИЯМИ

Проблема.

Повторяющийся контент эта довольно распространенная SEO-проблема.
Введенная в Wordpress версии 2.7 система разбиения комментариев на страницы эту проблему не решает.
Для предупреждения повторяющегося контента в комментариях будем использовать атрибут rel=«canonical».

Решение.

Копируем следующий код и вставляем его в файл functions.php.

1. function canonical_for_comments() {
2. global $cpage, $post;
3. if ( $cpage > 1 ) :
4. echo "\n";
5.    echo "<link rel='canonical' href='";
6.    echo get_permalink( $post->ID );
7.    echo "' />\n";
8.  endif;
9. }
10.  
11. add_action( 'wp_head', 'canonical_for_comments' );

Объяснение кода.

Сначала, мы создаем функцию, которая добавляет к каждой странице с комментариями, кроме первой, тэг link с атрибутом rel=«canonical». Затем, присоединяем эту функцию к Wordpress-функци wp_head().

8. ПОЛУЧЕНИЕ ПОСТА ИЛИ СТРАНИЦЫ В КАЧЕСТВЕ PHP-ПЕРЕМЕННОЙ

Проблема.

Возможность получить текущий пост или целую страницу в качестве PHP переменной – действительно крутая вещь. Скажем, Вы можете заменять некоторые части контента при помощи функции str_replace() или делать с ним еще что-нибудь.

Решение.

И снова ничего сложного. Делаем все то же самое: вставляем следующий код в файл functions.php.

1. function callback($buffer) {
2. // modify buffer here, and then return the updated code
3. return $buffer;
4. }
5.  
6. function buffer_start() {
7. ob_start("callback");
8. }
9.  
10. function buffer_end() {
11. ob_end_flush();
12. }
13.  
14. add_action('wp_head', 'buffer_start');
15. add_action('wp_footer', 'buffer_end');

Объяснение кода.

Для того, чтобы этот хак работал, необходимы три функции:

• callback(): эта функция возвращает страницу целиком как переменную $buffer. Вы можете модифицировать ее как угодно, например, при помощи регулярных выражений;
• buffer_start(): эта функция начинает буферизацию. Ее мы присоединяем к функции wp_head();
• buffer_end(): эта функция очищает буфер. Ее мы присоединяем к функции wp_footer().

9. ИСПОЛЬЗУЕМ ХУКИ И CRON ДЛЯ СОБЫТИЙ ПО РАСПИСАНИЮ

Проблема.

Вы, наверное, уже знаете, что Wordpress может использовать события по расписанию. К примеру, можно публиковать посты в конкретное, установленное заранее, время. Используя хуки и wp-cron, мы можем запросто задать расписание для нашего собственного события. В следующем примере мы заставим блог отправлять нам сообщения на e-mail один раз каждый час.

Решение.

Вставляем следующий код в файл functions.php.

1. if (!wp_next_scheduled('my_task_hook')) {
2. wp_schedule_event( time(), 'hourly', 'my_task_hook' );
3. }
4.  
5. add_action( 'my_task_hook', 'my_task_function' ); 
6.  
7. function my_task_function() {
8. wp_mail('you@yoursite.com', 'Automatic email', 'Hello, this is an automatically scheduled email from WordPress.');
9. }

Объяснение кода.

Первое, что мы сделаем, конечно, — это создадим функцию, которая будет выполнять требуемое действие. В этом примере эта функция называется my_task_function() и она просто отправляет письмо на указанный e-mail адрес.
Для того, чтобы запланировать выполнение этой функции, мы будем использовать функцию wp_schedule_event(). Последним аргументом, передаваемым ей, будет наш хук, поэтому мы «цепляем» нашу функцию my_task_function() к my_task_hook.

10. СПИСОК ВСЕХ «ХУКНУТЫХ» ФУНКЦИЙ

Проблема.

Когда что-то идет не так, здорово может пригодиться список всех «хукнутых» функций.

Решение.

Как и все предыдущие фрагменты кода следующий также необходимо вставить в файл functions.php. Только не забудьте удалить его после использования. Если Вы этого не сделаете, то сообщения будут появляться и после отладки.

1. function list_hooked_functions($tag=false){
2.  global $wp_filter;
3.  if ($tag) {
4.   $hook[$tag]=$wp_filter[$tag];
5.   if (!is_array($hook[$tag])) {
6.   trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
7.   return;
8.   }
9.  }
10.  else {
11.   $hook=$wp_filter;
12.   ksort($hook);
13.  }
14.  echo '<pre>';
15.  foreach($hook as $tag => $priority){
16.   echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>$tag</strong><br />";
17.   ksort($priority);
18.   foreach($priority as $priority => $function){
19.   echo $priority;
20.   foreach($function as $name => $properties) echo "\t$name<br />";
21.   }
22.  }
23.  echo '</pre>';
24.  return;
25. }

После того, как Вы вставите этот код в файл functions.php, вызовите функцию list_hooked_functions(). Она и покажет Вам список всех «хукнутых» функций.

1. list_hooked_functions();

Объяснение кода.

Данный код выясняет, передается ли имя хука в качестве аргумента функции. Если передается, то на экран выводится имя хука. Также можно посмотреть хуки только для определенной функции:

1. list_hooked_functions('wp_head');