WordPress как на ладони
Готовые темы (шаблоны) для WordPress wordpress jino

Ajax в WordPress

Цель этой статьи показать, как использовать AJAX при создании тем и плагинов.

С этой статьей вам может понадобится информация о том, как написать плагин для WordPress.

Оглавление:

AJAX в админ-панели WordPress

С тех пор, как AJAX был встроен в админ-панель WP, использовать функционал AJAX в плагинах стало очень удобно. Небольшой пример. Все делается в одном файле (файле плагина или файле темы functions.php).

#1. Добавляем javascript

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

<?php
//add_action('admin_print_scripts', 'my_action_javascript'); // такое подключение будет работать не всегда
add_action('admin_print_footer_scripts', 'my_action_javascript', 99);
function my_action_javascript() {
	?>
	<script type="text/javascript" >
	jQuery(document).ready(function($) {
		var data = {
			action: 'my_action',
			whatever: 1234
		};

		// с версии 2.8 'ajaxurl' всегда определен в админке
		jQuery.post( ajaxurl, data, function(response) {
			alert('Получено с сервера: ' + response);
		});
	});
	</script>
	<?php
}
?>

С версии 2.8 javascript переменная ajaxurl определена глобально на всех страницах админки. Используйте её в js коде, как ссылку на файл обработчик AJAX запроса. Обычно это файл /wp-admin/admin-ajax.php. В теме (шаблоне) эта переменная не определена. Чтобы использовать её во фронт-энде, её нужно определить самостоятельно. Как это сделать смотрите ниже.

#2. Создаем PHP функцию

Теперь, создадим PHP функцию, которая будет обрабатывать переданный AJAX запрос. Для этого добавляем следующий код в functions.php (можно в плагин):

add_action('wp_ajax_my_action', 'my_action_callback');
function my_action_callback() {
	$whatever = intval( $_POST['whatever'] );

	$whatever += 10;
	echo $whatever;

	wp_die(); // выход нужен для того, чтобы в ответе не было ничего лишнего, только то что возвращает функция
}

Тут мы цепляемся на хук wp_ajax_my_action - это динамический хук и выглядит он так: wp_ajax_(action), где вместо (action) вставляется значение передаваемой в первом коде переменной action - my_action.

Вот и все, за исключением одной детали: проверка запроса, что он пришел с правильной страницы. Для такой проверки используется функция check_ajax_referer().

Примера выше будет достаточно, чтобы начать использовать AJAX в админ-панели WordPress.

По возможности всегда используйте wp_die() вместо die() или exit(), в вашей функции обработки AJAX запроса. Так вы добьетесь лучшей интеграции с WordPress и в случае ошибок в коде, получите данные о них.

к началу

AJAX во внешней части WordPress

Первое в чем нужно проверить - установлена ли на сайте библиотека jQuery.

Во фронт-энде (внешней части сайта) нужно использовать еще один хук для обработки AJAX запросов: wp_ajax_nopriv_(action). Этот хук в отличии от wp_ajax_(action), срабатывает для неавторизованных пользователей.

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

add_action('wp_ajax_(action)', 'my_action_callback');
add_action('wp_ajax_nopriv_(action)', 'my_action_callback');

'wp_ajax_nopriv_(action)' можно не указывать, если не нужно, чтобы AJAX запрос обрабатывался для неавторизованных пользователей.

Переменная ajaxurl

Напомню, что переменная ajaxurl есть только в админке и её нет в лицевой части сайта (фронт-энде), поэтому её нужно определить (создать). Но мы назовем её по-другому - myajax.url, для фронта так удобнее, потому что так в объект myajax можно будет добавить еще данные связанные с AJAX запросом.

Правильный способ создать такую переменную - это использовать функцию wp_localize_script().

// Подключаем локализацию в самом конце подключаемых к выводу скриптов, чтобы скрипт
// 'twentyfifteen-script', к которому мы подключаемся, точно был добавлен в очередь на вывод.
// Заметка: код можно вставить в любое место functions.php темы
add_action( 'wp_enqueue_scripts', 'myajax_data', 99 );
function myajax_data(){

	// Первый параметр 'twentyfifteen-script' означает, что код будет прикреплен к скрипту с ID 'twentyfifteen-script'
	// 'twentyfifteen-script' должен быть добавлен в очередь на вывод, иначе WP не поймет куда вставлять код локализации
	// Заметка: обычно этот код нужно добавлять в functions.php в том месте где подключаются скрипты, после указанного скрипта
	wp_localize_script('twentyfifteen-script', 'myajax', 
		array(
			'url' => admin_url('admin-ajax.php')
		)
	);  

}

В результате, получим в head части сайта прямо перед скриптом 'twentyfifteen-script':

<script type='text/javascript'>
/* <![CDATA[ */
var myajax = {"url":"http://wptest.ru/wp-admin/admin-ajax.php"};
/* ]]> */
</script>
<script type='text/javascript' src='http://wptest.ru/wp-content/themes/twentyfifteen/js/functions.js?ver=20150330'></script>

На этом теория AJAX закончена, теперь все как для админ части, только вместо ajaxurl указываем myajax.url и нужно прикрепить функцию обработчик на еще один хук wp_ajax_nopriv_(action).

Пример AJAX кода для фронт энда

<?php

add_action( 'wp_enqueue_scripts', 'myajax_data', 99 );
function myajax_data(){

	wp_localize_script('twentyfifteen-script', 'myajax', 
		array(
			'url' => admin_url('admin-ajax.php')
		)
	);  

}

add_action('wp_footer', 'my_action_javascript', 99); // для фронта
function my_action_javascript() {
	?>
	<script type="text/javascript" >
	jQuery(document).ready(function($) {
		var data = {
			action: 'my_action',
			whatever: 1234
		};

		// 'ajaxurl' не определена во фронте, поэтому мы добавили её аналог с помощью wp_localize_script()
		jQuery.post( myajax.url, data, function(response) {
			alert('Получено с сервера: ' + response);
		});
	});
	</script>
	<?php
}

add_action('wp_ajax_my_action', 'my_action_callback');
add_action('wp_ajax_nopriv_my_action', 'my_action_callback');
function my_action_callback() {
	$whatever = intval( $_POST['whatever'] );

	echo $whatever + 10;

	// выход нужен для того, чтобы в ответе не было ничего лишнего, только то что возвращает функция
	wp_die();
}

Код рассчитан на тему twentyfifteen. Вставлять код можно в functions.php темы.

Этот код будет работать для любой темы, единственное что для этого нужно - это поменять название основного скрипта темы twentyfifteen-script, который подключается после jquery.

к началу

Правильное подключение AJAX хуков

Я не стал усложнять чтение и не говорил, как правильно подключать AJAX через хуки в коде. Впрочем все что написано ниже не обязательно, потому что работать будет и так, но это рекомендуется.

Функции обработчики установленные хукам:

  • wp_ajax_(action)
  • wp_ajax_nopriv_(action) 

Оба хука всегда удовлетворяют условиям:

if( is_admin() ){}

// или 
if( defined('DOING_AJAX') && DOING_AJAX ){}

// или с версии 4.7.0
if( wp_doing_ajax() ){}

А значит сами хуки нужно подключать только если срабатывает одно из этих условий или сразу оба.

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

Пример того, как рекомендуется подключать все AJAX хуки.

// подключаем AJAX обработчики, только когда в этом есть смысл
if( defined('DOING_AJAX') && DOING_AJAX ){
	add_action('wp_ajax_myaction', 'ajax_handler');
	add_action('wp_ajax_nopriv_myaction', 'ajax_handler');
}

// или так 
if( is_admin() ){
	add_action('wp_ajax_myaction', 'ajax_handler');
	add_action('wp_ajax_nopriv_myaction', 'ajax_handler');
}

// или так с WP 4.7
if( wp_doing_ajax() ){
	add_action('wp_ajax_myaction', 'ajax_handler');
	add_action('wp_ajax_nopriv_myaction', 'ajax_handler');
}

В обоих случаях данные отправляемые с фронтэнда на файл wp-admin/admin-ajax.php обработаются функцией ajax_handler, независимо авторизован пользователь или нет.

к началу

Защита: используем nonce и проверяем права

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

Существует 2 вида защиты, которые нужно использовать в AJAX запросах в большинстве случаев.

1. Код nonce (случайный код)

Nonce - это уникальная строка, которая создается и используется один раз (once). Nonce проверка используется, когда нужно убедится, что запрос был послан с указанного места.

В WordPress есть функции wp_create_nonce() и wp_verify_nonce() - это базовые функции для создания и последующей проверки nonce кода. С их помощью мы и будем создавать защиту nonce для AJAX запросов.

Для начала создадим nonce код:

add_action( 'wp_enqueue_scripts', 'myajax_data', 99 );
function myajax_data(){

	wp_localize_script('twentyfifteen-script', 'myajax', 
		array(
			'url' => admin_url('admin-ajax.php'),
			'nonce' => wp_create_nonce('myajax-nonce')
		)
	);  

}

Здесь 'twentyfifteen-script' это название основного скрипта темы (см. выше), который подключается на сайте с помощью wp_enqueue_script().

Затем, в AJAX запросе добавим переменную с кодом nonce:

var ajaxdata = {
	action : 'myajax-submit',
	nonce : myajax.nonce
};
jQuery.post( myajax.url, ajaxdata, function( response ) {
	alert( response );
});

Теперь, в обработке заброса необходимо проверить nonce код:

add_action( 'wp_ajax_nopriv_myajax-submit', 'myajax_submit' );
add_action( 'wp_ajax_myajax-submit', 'myajax_submit' );
function myajax_submit(){
	$nonce = $_POST['nonce'];

	// проверяем nonce код, если проверка не пройдена прерываем обработку
	if( ! wp_verify_nonce( $nonce, 'myajax-nonce' ) )
		die( 'Stop!');

	// обрабатываем данные и возвращаем
	echo 'Возвращаемые данные';

	// Не забываем завершать PHP
	die();
}

2. Проверка прав доступа

Тут AJAX запросы будут срабатывать только для пользователей с правом author. Для всех остальных включая неавторизованных пользователей, AJAX запрос вернет ошибку.

Особенность тут в том, что не авторизованные пользователи тоже должны видеть сообщение об ошибке при AJAX запросе. Для этого нужно обрабатывать запрос для них возвратом ошибки:

add_action( 'wp_ajax_nopriv_myajax-submit', 'myajax_submit' );
add_action( 'wp_ajax_myajax-submit', 'myajax_submit' );
function myajax_submit(){
	$nonce = $_POST['nonce'];

	// проверяем nonce код, если проверка не пройдена прерываем обработку
	if ( ! wp_verify_nonce( $nonce, 'myajax-nonce' ) )
		die('Nonce error')

	// текущий пользователь имеет права автора или выше
	if( ! current_user_can('publish_posts') )
		die('Этот запрос доступен пользователям с правом автора или выше.')

	// Делаем что нужно и выводим данные на экран, чтобы вернуть их скрипту

	// Не забываем выходить
	die;
}
к началу

Отлавливаем баги

Проблемы могут возникнуть при AJAX запросе и появлении ошибок PHP. Заметки или сообщения могут изменить возвращаемый результат или вызвать ошибку javascript.

Дебаг (вывод ошибок на экран)

Вариант:

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

При этом в коде можно использовать привычные функции print_r() или var_dump(), чтобы увидеть что находится в нужных переменных.

Вариант:

Если по ходу написания кода нужно заглянуть в переменную $myvar, то еще можно использовать такой код в обработчике ajax запроса:

error_log( print_r($myvar, true) );

В результате, в файл логов сервера (error.log) будет записано содержимое переменной $myvar. Так можно выполнить ajax, и заглянуть в лог.

Такого же результат можно добиться включив константу WP_DEBUG_LOG.

Вариант:

Если не получается увидеть сообщение об ошибке и нужно работать в режиме разработчика, можно очистить буфер сразу перед возвратом данных:

ob_clean();
echo $whatever;
die();

После этого нужно посмотреть что возвращает запрос через дебаг браузера или как-то еще...

Вариант:

Также, для дебага можно воспользоваться инструментом FirePHP, который записывает ошибки в консоль браузера.

Ошибка при возвращении данных

Если AJAX запрос на в файл wp-admin/admin-ajax.php провалился, то будет возвращен ответ -1 или 0.

  • -1 - не указан параметр action
  • 0 - обработка запроса вернула пустой результат
  • 0 - также возвращается по умолчанию во всех остальных случаях.

Полезная стать по теме (англ): 5 TIPS FOR USING AJAX IN WORDPRESS

к началу

Плагины

Интересный плагин AJAX Manufactory - добавляет класс, с помощью которого можно удобно и быстро писать AJAX запросы на стороне клиента и ответы на стороне сервера.

Http://medcnskaya-knjka.com

Только на сайте http://medcnskaya-knjka.com вы можете узнать подробную информацию.

medicinskaya-knijka.com

Ajax в WordPress 88 комментариев
Полезные 5 Вопросы 6 Все
  • lincaseidhe22 cайт: ardeya.ru
    @

    Написал для себя, но может еще кому из новичков, как я, пригодится. Тут пример, как можно получать строки посредством ajax, ну а при желании можно допилить и делать вообще огонь smile

    -1
  • Андрей

    У меня почему сфлеши таки страные при создание свой переменой ajax

    <script type='text/javascript'>
    /* <![CDATA[ */
    var myajax = {"url":"http:\/\/wp.loc\/wp-admin\/admin-ajax.php","nonce":"4e0eedac9b"};
    /* ]]> */
    </script>
    //Функция обработчика для AJAX
    add_action( 'wp_enqueue_scripts', 'myajax_data', 99 );
    function myajax_data(){
    
    	wp_localize_script('calck', 'myajax', 
    		array(
    			'url' => admin_url('admin-ajax.php')
    		)
    	);  
    
    }
    Ответить3 месяца назад #
  • Илья
    @

    Сделал как увас, а WordPress возращает ноль, уже второй день не могу понять вчем может быть проблема вот код

    //Функция обработчика для AJAX
    add_action( 'wp_enqueue_scripts', 'myajax_data', 99 );
    function myajax_data(){
    
    wp_localize_script('mail', 'myajax', 
    		array(
    			'url' => admin_url('admin-ajax.php')
    		)
    	);
    }  
    //Обработка AJAX запроса калькулятора
    add_action('wp_ajax_nopriv_mail_action', 'mail_action');
    add_action('wp_ajax_mail_action', 'mail_action');
    function mail_action()
    {
    
       //wp_mail('dzerglib@yandex.ru', 'Тема',  'Сообщение');
      if(isset($_POST['data'])) { 
    
    	echo $_POST['data'];
    
    	}
    
    wp_die();
    }

    А вот JS

    $('.calckform').submit(function() {
    
    		   $.ajax({
    									type: "POST",
    									data: {
    
    										  action: "mail_action",
    										  data: 1,
    
    									},
    									url: myajax.url,
    									success:function(res){
    
    											 alert(res);
    
    										 // $('#zakazresult').text('заказ отправлен');
    
    									},
    									error:function(){
    										  $('#zakazresult').text('произошла ошибка');
    									}
    	});
    
    	return false;
      });
    

    Как я понял ошибка в action но я немогу понять, вроде бы все правельно

    Ответить3 месяца назад #
    • campusboy1455 cайт: wp-plus.ru
      @

      Только что проверил твой код - работает. Единственное, что я изменил в твоем скрипте, так это переменную myajax.url, так как у меня она не определялась. В Хроме нажми F12 и отправь форму, поглядывая туда, может ошибки у тебя тоже есть. Дебаг - великая вещь smile

      Попробуй задать ссылку на обработчки на прямую, то есть:

      url: 'http://test-wp.ru/wp-admin/admin-ajax.php',
      Ответить3 месяца назад #
      1
      • Илья
        @

        Да ноль почему то выводит не знаю почему ((

        Ответить3 месяца назад #
      • Kama4349

        А у тебя wp_localize_script('mail', правильно работает вообще? В HTML коде видишь что добавился скрипт со ссылкой на admin-ajax.php? Там вон локализация подключается к скрипту mail он вообще есть (подключается)?

        Ответить3 месяца назад #
  • Otshelnik-Fm173 cайт: across-ocean.otshelnik-fm.ru

    Тимур - может добавишь еще один метод в подраздел "Отлавливаем баги"?
    error_log(print_r($some_variable,true));

    • т.е. мы будем писать в файл логов сервера (error.log) содержимое переменной $some_variable.
      Мне этот метод для дебага удобней - не надо активировать плагины дебага или назначать константу дебага. Вписал переменную - выполнил ajax, и глянул в лог
    Ответить3 месяца назад #
    2
    • Kama4349

      Спасибо, дополнил описание раздела "Отлавливаем баги" thank_you

      Ответить3 месяца назад #
      1
  • Андрей

    Столкнулся с любопытным случаем. Настраиваю под кастомные посты шаблоны там : категория и сингл - ajax выполняется даже без функции обработчика на фронте ... просто через переменную $_POST ... Неправильно конечно, но работает. Только вылез на кастомную станицу - СЮРПРИЗ ... не видит $_POST в глухую. Если с $_SESSION вопрос решается регистрацией, то с $_POST я такого не нашел ...

    Ответить2 месяца назад #
  • Денис cайт: www.dampi.ru

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

    Ответить2 месяца назад #
    -12
    • петья

      Сам себя рекламишь? Так хоть не сри автора. Опечаток много... Проверь сначала свое функциональное программирование и кучу нотисов.

      Ответить2 месяца назад #

Здравствуйте, !

Ваш комментарий