WordPress как на ладони
wordpress jino

AJAX Simply

Создавать AJAX запросы в WordPress легко, но можно еще легче... Для этого я создал плагин AJAX Simply.

О том, как пользоваться AJAX в WordPress я подробно описал в одноименной статье. Использование хуков для создания ajax запроса в WordPress - штука очень неудобная, каждый раз нужно создавать функцию и «вешать» её на хук. Более того, AJAX запросы очень часто делаются для фронта и в этом случае нужно вешать функцию на два хука. Зачем для этого в WP используются хуки понятно, чтобы функции срабатывали в конце, и в них были доступны все, что есть в плагинах и темах.

Но несмотря на это AJAX в WordPress можно значительно упростить, дополнив функционал и обернув функцию jQuery.ajax. AJAX Simply делает это и многое другое, и в разы упрощает работу с AJAX в WordPress.

Плагин состоит из двух маленьких файлов .php и .js и его при необходимости можно легко встроить в любой проект без установки самого плагина (см. в конце).

Коротко о плагине

Давайте представим, что мы установили AJAX Simply и создаем AJAX запрос, тогда код будет выглядеть так:

<!-- HTML -->

<form class="form">
	<input type="text" name="my_text" value="Привет, обработал!" />
	<textarea name="my_textarea">просто текст</textarea>
	<input type="submit" value="Отправить" >
</form>
// JS

jQuery('.form').submit( function(event){
	event.preventDefault(); // останавливаем отправку формы

	// AJAX запрос
	ajaxs( 'php_function', jQuery('.form') );
} );
// PHP

// функция-обработчик запроса. 'ajaxs_' - это обязательный префикс
function ajaxs_php_function( $jx ){

	$jx->alert( $jx->my_text );
	$jx->console( $jx->my_textarea );

}

Все! Теперь после нажатия на кнопку «Отправить!» вы увидите:

  • в браузере alert-сообщение «Привет, обработал!»
  • в консоли браузера появится надпись «просто текст».

Т.е. ajaxs() соберет и отправит данные формы (поле my_text и my_textarea). Мы их получим в PHP функции и отправим обратно, при этом из PHP «сказав», чтобы браузер вывел alert и сообщение в консоль.

Такой код будет работать и в админке WP и на фронт-энде.

Оглавление:
Что конкретно упрощает плагин?

Плагин не создает что-то новое, а «оборачивает» всю работу с AJAX в свою логику и значительно её упрощает. Отправил-обработал-получил - все просто! Это значит, что в случае чего, легко можно использовать базовую логику AJAX запросов в WordPress - это привычные хуки и дополнительные переменные самого AJAX запроса.

О какой «возне» можно забыть:

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

  2. Забываем про глобальные переменные $_POST, $_GET и удобно получаем данные отправленные на сервер в едином формате, без необходимости помнить, каким методом данные были отправлены и что с данных нужно убрать экранирование.

  3. Забываем про «неудобности» при отправки данных с сервера обратно в JS: они могут быть массивами объектами, числами, строками и т.д. И все это с учетом типа данных.

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

  5. Забываем про URL запроса, который постоянно нужно передавать при создании AJAX запроса, и про то что его нужно сначала определить на фронте.

  6. Забываем про сложности при загрузке файлов через AJAX.

  7. Забываем про возню связанную с дебагом. Например, можно выдать данные в консоль браузера сразу из PHP (см. $jx->console()).

  8. Забываем про сложность с просмотром ошибок в PHP. Теперь при включенном WP_DEBUG ошибки любого уровня, включая фатальные, вы будите видеть в консоли браузера.

  9. Забываем про необходимость указать die или exit в конце PHP функции-обработчика.

  10. Забываем про защиту запросов с помощью nonce кода. Такую защиту (проверку) плагин делает автоматически. Эту опцию нужно включить отдельно (см. заметки).

Этот «сухой» список показывает о скольком можно не беспокоится используя AJAX Simply, но он не может передать ощущения простоты. Чтобы хоть немного это почувствовать, смотрите примеры ниже.

Хочу заметить, что плагин не создает никакой лишней нагрузки, как может показаться глядя на функционал. Все продумано и работает быстро! Разницы в скорости с ним и без него нет. Единственное что он делает - это подключает +1 js файл, код которого впрочем можно встроить в HTML (см.заметки).

Более того, если создать свой файл обработчик AJAX запросов для фронта, то нагрузка при запросах чувствительно снизится (см.заметки).

Перейдем к документации AJAX Simply.

JS функция отправки ajax

// POST запрос
ajaxs( action, data, doneFunc, alwaysFunc, failFunc );

// GET запрос
ajaxsGET( action, data, doneFunc, alwaysFunc, failFunc );

Обязательным является только параметр action.

Параметр data можно опустить:

ajaxs( action, doneFunc, alwaysFunc, failFunc );

Описание параметров

action(обязательный)

Функция обработчик, которая будет использоваться в PHP. Вместо функции можно указать и метод класса.

Рассмотрим все варианты:

  • 'php_function'
    Название PHP функции, которая будет обрабатывать AJAX запрос.

    В PHP к указанному тут значению нужно добавить префикс:

    • ajaxs_ - ajaxs_php_function - для всех юзеров.
    • ajaxs_priv_ - ajaxs_priv_php_function - только для авторизованных.
  • 'Myclass::method'
    Название метода класса, который будет обрабатывать AJAX запрос. Метод должен быть статический. Использовать методы удобно для понятности кода - создали класс и добавляем в него методы.

    В PHP к указанному тут значению нужно добавить префикс:

    • AJAXS_ - AJAXS_Myclass::method - для всех юзеров.
    • AJAXS_PRIV_ - AJAXS_PRIV_Myclass::method - только для авторизованных.
    • ajaxs_ - Myclass::ajaxs_method - для всех юзеров.
    • ajaxs_priv_ - Myclass::ajaxs_priv_method - только для авторизованных.
  • 'wp_ajax_{$action}'
    'wp_ajax_nopriv_{$action}'
    Стандартный хук WordPress, если функция/метод не найдены. Это обратная совместимость с привычным поведением WordPress.

    $action будет заменен на значение указанное в этом параметре. Т.е. если в action указать 'php_function', то сработает один из хуков: wp_ajax_nopriv_php_function (для не авторизованных) или wp_ajax_php_function (для авторизованных).

Для понятности, префиксы: ajaxs_, ajaxs_priv_, AJAXS_, AJAXS_PRIV_ можно указать сразу в параметре action.

Также, в action можно указать скобки на конце () они в итоге будут удалены: 'php_function()', 'AJAXS_Class::method()' и т.д.

data

Данные которые нужно передать вместе с AJAX запросом. Если данных нет, параметр можно пропустить.

Передавать можно: объект с данными, HTML (DOM) элемент или объект с данными среди которых есть HTML (DOM) элемент...

Рассмотрим все варианты подробнее:

  • { key: 'val' }
    Объект с данными (ключ/значение).

    ajaxs( 'php_func', { my_key: 'my_val', num: 1 } );
  • HTML элемент (DOM элемент)
    Если передать HTML элемент, например, HTML форму, то будут собраны значения всех input, select, textarea полей из указанного элемента. У полей должен быть установлен атрибут name он станет ключом.

    Передавать можно любой элемент с полями формы, это НЕ обязательно должна быть форма <form>, может быть <div> или другой.

    Если в качестве элемента передается само поле формы, например <input>, то в данные добавится значение этого поля. У него также должен быть атрибут name, который станет ключом.

    Пример:

    var element = document.getElementById('my_id');
    ajaxs( 'php_func', element );
  • jQuery элемент
    Тоже самое что передать элемент, только в виде jQuery объекта.

    Пример:

    var $element = jQuery('#my_id');
    ajaxs( 'php_func', $element );
  • Комбинирование - параметры и HTML элементы
    Можно передавать JS объект внутри которого будет HTML элемент(ы). Тогда в запрос будут добавлены данные объекта и данные полей из HTML элемента. При совпадении ключей, данные будут затирать друг друга в порядке очередности...

    var data = {
    	my_key : 'my_val',
    	foo    : jQuery('.my_form')
    }
    ajaxs( 'php_func', data );

    Ключ foo в данном случае нигде не используется и нужен только для «целостности» объекта. Реальные названия ключей будут взяты из атрибута name полей формы находящихся внутри элемента '.my_form'.

  • Файлы и поле файл типа: input[type="file"]
    Переданные в данных файлы будут обработаны и в PHP мы получим стандартный массив $_FILES.

    Для файлов работает все, что описано для варианта "HTML элемент". А именно:

    • Поле file может находится внутри переданного элемента (быть частью формы).

    • Поле file можно передать как отдельный элемент. Т.е. передать само поле file.

    • Можно комбинировать - передать объект данных среди которых будет HTML элемент с полем file.

    • Данные файла можно напрямую указать в объекте данных:

      var fileElement = jQuery('input[type="file"]')[0]
      var data = {
      	my_key : 'my_val',
      	myfile : fileElement.files[0] // первый файл
      }
      ajaxs( 'my_function', data );
  • Параметр data.ajax
    Позволяет указать дополнительные параметры AJAX запроса.

    Если в данных указать ключ ajax и в значении указать объект данных ключ/значение. То эти параметры станут параметрами AJAX запроса. Пример:

    data = {
    	my_key : 'my_val',
    	ajax   : {
    		async      : false,
    		beforeSend : function( jqXHR, settings ){  },
    		method     : 'PUT'
    	}
    }
    ajaxs( 'my_func', data );

    Полный список параметров смотрите в описании jQuery.ajax.

doneFunc

Функция, которая сработает при успешном ответе сервера на AJAX запрос.

Получит ответ сервера: response.

В качестве параметра функция получит то, что вернет PHP функция обработчик - это может быть число, строка, true/false, простой или ассоциативный массив.

Пример:

ajaxs( 'my_function', data, function( response ){
	// для числа, строки, true/false
	response;

	// для простых массивов
	resp[0];
	resp[1];

	// для ассоциативных массивов
	resp.my_key;
	resp['my_key'];
});
alwaysFunc

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

Получит следующие параметры: xhr, status.

ajaxs( 'my_function', data,
	// success function
	function( result ){},
	// always function
	function( xhr, status ){},
);

Если нужно пропустить эту функцию, но определить следующую функцию: failFunc - ошибка ответа, то укажите здесь null или false.

failFunc

Функция, которая сработает, если запрос провалился. Например, когда сервер не ответил, или вернул 500 ответ, или когда вернувшиеся данные не удалось получить (вернулась не json строка) и т.д.

Получит следующие параметры: xhr, status, error.

ajaxs( 'my_function', data,
	// success function
	function( result ){},
	// always function
	null,
	// error function
	function( xhr, status, error ){
		alert( status +': '+ error );
	}
);

Функции ajaxs() и ajaxsGET() возвращают объект jqXHR - то что возвращает jQuery.ajax(), поэтому к ним можно применять дополнительные методы: .done(), .fail(), .always(), .then(). Посмотрим на примере:

ajaxs( 'my_function', { foo:'bar' } )
	.done(function( response ){
		// успешный ответ сервера
	})
	.always(function( xhr, status ){
		// любой ответ сервера
	})
	.fail(function( xhr, status, error ){
		// ошибка при ответе сервера
	})

Этими функциями можно заменить параметры: doneFunc, alwaysFunc, failFunc.

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

PHP функция обработки ajax

Функция которая обрабатывает ajax запрос должна называться ajaxs_(action) (для всех) или ajaxs_priv_(action) (только для авторизованных). Подробнее смотрите выше, в описании параметра action.

PHP функция-обработчик в качестве единственного параметра получает объект $jx. В $jx->data содержаться все полученные от JS данные.

Разберем работу функции-обработчика на примере.

Допустим, в JS мы отправили данные так:

var data = {
	color : 'Зеленый',
	item  : 'Яблоко',
	image : jQuery('input[name="item_image"][type="file"]')
};

ajaxs( 'my_func', data );

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

<?php
function ajaxs_my_func( $jx ){
	// $jx - это PHP объект

	// $_POST, $_GET содержат все данные запроса в исходном виде,
	// но они нам не нужны!
	// Все полученные от JS данные находятся в переменной (экранирование тут уже снято):
	$jx->data; //> array( color => Зеленый, item => Яблоко )

	// отдельный элемент данных
	$color = $jx->data['color']; //> Зеленый

	// полученный от JS файл картинки
	$image = $_FILES['item_image']; //> массив данных файла.

	// МАГИЯ -----
	// данные можно получать напрямую:
	$jx->color;      //> Зеленый
	$jx->item;       //> Яблоко
	$jx->item_image; //> массив данных файла

	// МЕТОДЫ -----
	// в $jx есть специальные методы. Например:
	// говорит JS создать алерт
	$jx->alert( $jx->color );

	// говорит JS вывести данные в консоль
	$jx->console( $jx->item );

	// ОТВЕТ СЕРВЕРА -----
	// можно просто вернуть любое значение: массив/строку/число/true/false
	// тогда JS получит его как есть
	return array( 'foo' => 'bar' );
	return array( 'foo', 'bar' );
	return 'я свободная строка!';
	return true;
	return 69;

	// ECHO -----
	// можно просто вывести строку на экран
	echo 'я свободная строка!';
	// или вывести строку так
	?>
	<div class="foo">Текст</div>
	<?php

	// ОБРЫВ -----
	// внутри функции можно использовать: die, exit и обертки для них
	die( 'я свободная строка!' );    // не рекомендуется!
	wp_die( 'я свободная строка!' ); // рекомендуется!
	$jx->success('текст сообщения'); // = wp_send_json_success( 'текст сообщения' );
	$jx->error('текст ошибки');      // = wp_send_json_error( 'текст ошибки' );
}

Методы объекта $jx в PHP функции

Эти методы можно использовать в PHP функции-обработчике запроса. Использование некоторых из них вы видели выше в примерах.

$jx->success( $data )
Одноразовая - обрывает работу PHP через die!

Отправит объект успешного выполнения. Аналог функции WP wp_send_json_success().

Объект будет содержать элемент success = true и элемент data с данными указанными в $data - это может быть строка/число/массив... Т.е. в результате JS получит такой объект:

array(
	'success' => true,
	'data'    => $data
)

Важно: Метод обрывает работу PHP и любой код после $jx->success() НЕ будет работать!

$jx->error( $data )
Одноразовая - обрывает работу PHP через die!

Отправит объект ошибки и оборвет работу PHP с помощью die(). Аналог функции WP wp_send_json_error().

Объект будет содержать элемент success = false и элемент data с данными указанными в $data - это может быть строка/число/массив... Т.е. в результате JS получит такой объект:

array(
	'success' => false,
	'data'    => $data
)

Важно: Метод обрывает работу PHP и любой код после $jx->error() НЕ будет работать!

$jx->reload( $delay = 0 )
Многоразовая - перебивает данные предыдущего вызова.

«Скажет» JS перезагрузить текущую страницу с которой был отправлен AJAX запрос.

В $delay можно указать задержку в миллисекундах: 1000 мс = 1 сек.

$jx->redirect( $url, $delay = 0 )
Многоразовая - перебивает данные предыдущего вызова.

«Скажет» JS перейти на указанную в $url страницу. URL очищается с помощью wp_sanitize_redirect().

В $delay можно указать задержку в миллисекундах: 1000 мс = 1 сек.

$jx->html( $selector, $html )
Многоразовая - дополняет данные предыдущего вызова.

Вставит в указанный элемент указанный HTML код.

Селектор указывается для jQuery('селектор'), поэтому в $selector можно указать почти любой CSS селектор, например: '#myid', '.myclass'...

В $html указывается любой HTML код, он будет вставлен в указанный через селектор элемент с помощью .html().

$jx->console( $data )
Многоразовая - дополняет данные предыдущего вызова.

«Скажет» js вывести в консоль указанные данные. В $data можно передать любые данные: строку/число/true/false/массив/объект. Массив, объект выведутся в формате PHP функции print_r().

Можно указать сколько угодно параметров через запятую: $jx->console( $data, $data2, ... );

Новинка: с версии 1.1.3, для удобства можно использовать $jx->log() вместо $jx->console().

$jx->dump( $data )
Многоразовая - дополняет данные предыдущего вызова.

Тоже что console(), только указанные данные выводятся в формате PHP var_dump().

Можно указать сколько угодно параметров через запятую: $jx->dump( $data, $data2, ... );

$jx->alert( $data )
Многоразовая - дополняет данные предыдущего вызова.
Тоже что console(), только получим алерт в браузере.
$jx->trigger( $event, $selector = false, $args = array() )
Многоразовая - дополняет данные предыдущего вызова.

Активирует указанное в $event JS событие на указном в $selector элементе. В $args можно передать данные, которые передадутся в функцию обрабатывающую событие.

Сектор может быть любой в стиле jQuery: jQuery('#myid').

Если селектор не указан, то событие будет активировано для документа: jQuery(document).trigger( event, vars ).

Пример. После обработки AJAX запроса, нам нужно эмулировать клик по ссылке .mylink (событие click):

function ajaxs_php_function( $jx ){
	$jx->trigger( '.mylink', 'click' );
}
$jx->call( $func_name, $args = array() )
Многоразовая - дополняет данные предыдущего вызова.

«Говорит» JS использовать указанную в $func_name функцию. Функция должна быть глобальной, т.е. в видимости window. Например, если мы указали myFunc, то будет вызвана функция window.myFunc( args ).

$args - параметры передаваемые вызываемой функции.

$jx->jseval( $code )
Многоразовая - дополняет данные предыдущего вызова.

«Просит» JS запустить указанный в $code JS код. Код должен быть оформлен по всем правилам javascript.

Пример:

$jx->jseval('alert("Выполнил!");');

PHP функция-обработчик может просто вернуть (return) или вывести на экран (echo) любое значение (массив/строку/число/true/false). JS получит вернувшиеся данные.

PHP функция jx(). Если в функции обработчике используются другие функции и уже из них нужен доступ к текущему $jx объекту, то его можно получить через функцию jx(). Например:

function ajaxs_my_func( $jx ){
	$foo = my_func_help();
}
function my_func_help(){
	$data = array('нужные данные');

	// выведем $data в консоль
	jx()->console( $data );
}

События AJAX Simply

Ловить моменты до или после выполнения AJAX запроса можно через события, которые срабатывают каждый раз при запуске функции ajaxs() или ajaxsGET().

// срабатывает прямо перед запросом
jQuery(document).on( 'ajaxs_start', function( data, jx ){} );

// после получения ответа: успешный ответ
jQuery(document).on( 'ajaxs_done', function( data, jx ){} );

// после получения ответа: неожиданный ответ, ошибка ответа
jQuery(document).on( 'ajaxs_fail', function( data, xhr, status, error ){} );

// после получения ответа: срабатывает всегда: при успехе или ошибке
jQuery(document).on( 'ajaxs_always', function( data, xhr, status ){} );

Все события вешаются на document, значит там их и ловим, например так:

jQuery(document).on( 'ajaxs_done', function( event, data ){
	console.log( data );
});

Параметры:

  • data - параметры переданные при AJAX запросе.
  • jx - параметры самого AJAX запроса.
  • status - строка, статус ответа сервера.
  • error - сообщение об ошибке.
  • xhr - объект AJAX запроса. См. XMLHttpRequest.
Пример использования событий

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

jQuery(document).on( 'ajaxs_start', function( event, data ){
	// показываем лоадер
});

jQuery(document).on( 'ajaxs_always', function( event, data ){
	// прячем лоадер
});

Все, теперь при написании js кода не надо будет постоянно включать и выключать лоадер. Один раз прописали и забыли - очень удобно!

Заметки AJAX Simply

URL файла-обработчика

URL файла обработчика AJAX запросов находится в глобальной переменной JS jxs.url. Иногда бывает нужно получить этот URL, например для скрипта jQuery.validate().

Защита nonce

Nonce проверка в плагине по умолчанию отключена, чтобы он нормально работал с плагинами страничного кэширования...

Но, вообще-то такая проверка нужна! Поэтому важные запросы проверяйте самостоятельно. Пользуйтесь хотя бы базовым nonce кодом от плагина, он отправляется при любом запросе. Чтобы его проверить при обработке запроса в PHP, используйте такой код:

    ## PHP функция-обработчик
	function ajaxs_my_func( $jx ){
		if( ! wp_verify_nonce( $jx->ajaxs_nonce, 'ajaxs_action' ) )
			return; // обрываем

		// базовая проверка пройдена, делаем что-нужно...
	}

Или так

    ## PHP функция-обработчик
	function ajaxs_my_func( $jx ){
		check_ajax_referer( 'ajaxs_action', 'ajaxs_nonce' ); // обрываем

		// базовая проверка пройдена, делаем что-нужно...
	}

Включение nonce проверки для всех запросов

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

## разрешим ajaxs выполнять базовую nonce проверку
add_filter( 'allow_ajaxs_nonce', '__return_true' );

Это хороший плюс к защите. Если вдруг забыли выставить nonce проверку, плагин сделает это за вас.

Важные запросы, хорошо бы защищать еще одним, своим nonce кодом!

inline подключение скрипта

Плагин подключает один js файл. Он маленький и чтобы избавиться от лишнего HTTP запроса, код скрипта можно вывести прямо в HTML. Чтобы это сделать используйте хук в functions.php темы или в файле плагина:

## выводим код скрипта ajaxs прямо в HTML (inline)
add_filter( 'ajaxs_use_inline_js', '__return_true' );

Переопределение файла-обработчика на фронте

Для фронтэнда посылать запросы на файл /wp-admin/admin-ajax.php не очень хорошо, потому что там подгружается все что нужно в админке. Ссылку на такой файл можно переопределить через хук:

add_action( 'ajaxs_front_request_url', function(){
	return get_template_directory_uri() . '/ajaxs_requests.php';
});

Этот код показывает как поместить такой файл в тему. Для этого в корне темы нужно создать файл ajaxs_requests.php и в него поместить код файла /wp-admin/admin-ajax.php. Далее нужно удалить от туда лишние проверки, константу WP_ADMIN и хук admin_init. Т.е. выглядеть он должен как минимум так:

<?php
/**
 * WordPress Front Ajax Process Execution
 */

define( 'DOING_AJAX', true );

// Load WordPress Bootstrap
// ВАЖНО!!! укажите правильный путь
require_once( $_SERVER['DOCUMENT_ROOT'] . '/wp-load.php' );

// Allow for cross-domain requests (from the front end).
send_origin_headers();

// Require an action parameter
if ( empty( $_REQUEST['action'] ) )
	die( '0' );

@header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
@header( 'X-Robots-Tag: noindex' );

send_nosniff_header();
nocache_headers();

if ( is_user_logged_in() )
	do_action( 'wp_ajax_' . $_REQUEST['action'] );
else
	do_action( 'wp_ajax_nopriv_' . $_REQUEST['action'] );

// Default status
die( '0' );

Важно сохранить AJAX хуки WP, на их основе работает этот плагин.

Очень важно правильно указать путь до файла wp-load.php. Иначе ничего работать не будет!

Групповая проверка прав

Для удобства в плагине есть хук:

$allow = apply_filters( 'ajaxs_allow_process', true, $action, $jx );
if( ! $allow && $allow !== null ){
	wp_die( -1, 403 );
}

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

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

Например, представим, что у нас есть класс My_Class, который содержит методы обрабатывающие AJAX запросы. Таких методов там 10 штук и для всех нужна одна и та же проверка права: current_user_can('edit_others_posts'). Теперь, чтобы в начале каждого метода не писать:

if( ! current_user_can('edit_others_posts') ) return;

Перенесем эту проверку в хук, так:

// общая проверка прав доступа для всех ajax запросов
add_filter( 'ajaxs_allow_process', function( $foo, $action ){
	if( false === strpos($action, 'My_Class') && ! current_user_can('edit_others_posts') ){
		return false;
	}
}, 10, 2 );

Все, теперь при обработке любого запроса направленного на метод класса My_Class будет срабатывать проверка и если она не пройдена, то обработка AJAX запроса будет прервана.

Такой подход поможет очистить код от лишнего и оградить от необходимости помнить о проверках прав.

Функция хука 'ajaxs_allow_process' должна вернуть false, чтобы прервать обработку запроса или не возвращать ничего, чтобы плагин работал как обычно.

Примеры

#1 Возврат из PHP (echo)

Этот пример показывает, как в PHP функции обработчике мы можем просто вывести HTML на экран и JS его в результате получит...

<!-- HTML -->
<div class="contact"></div>
// JS
ajaxs( 'get_email', { email: 'foo@gmail.com' }, function( html ){
	$('.contact').html( html );
} );
<?php
function ajaxs_get_email( $jx ){
	?>
	<p class="myclass"><?php echo esc_html( $jx->email ) ?></p>
	<?php

	// одновременно выведем данные в консоль
	$jx->console( $jx->email );
}

#1.2 Возврат из PHP (return)

Допустим нам нужно обработать принятые данные в PHP и вернуть объект данных в JS:

<!-- HTML -->
<div class="my_form">
	<label><input type="checkbox" name="my_check" /> мой чекбокс </label>
	<select name="my_select">
		<option>Опция 1</option>
		<option>Опция 2</option>
	</select>
</div>
// JS
ajaxs( 'parse_form', $('.my_form'), function( data ){

	data.done;  //> true
	data.check; //> 'on' если чекбокс выделен
	data.sel;   //> 'Опция 1' или 'Опция 2'

} );
<?php
function ajaxs_parse_form( $jx ){
	return array(
		'check' => $jx->my_check,
		'sel'   => $jx->my_select,
		'done'  => true,
	);
}

Вернуть можно что угодно: объект/массив/число/строку/true/false. В этом примере возвращается массив.

#1.3 Возврат из PHP ($jx->success|error)

Методы $jx->success(), $jx->error() - отправляют объект и обрывают работу PHP. Это аналоги функций wp_send_json_success() и wp_send_json_error().

<!-- HTML -->
<div class="ajax-respond"></div>
// JS
ajaxs( 'my_function', function( res ){
	var $respond = jQuery('.ajax-respond');

	// УСПЕХ
	if( res.success ){
		// сработал метод $jx->success()
		$respond.html( 'УСПЕХ:' + res.data );
	}

	// ошибка
	if( ! res.success ) {
		// сработал метод $jx->error()
		$respond.html( 'ОШИБКА:' + res.data );
	}
} );
// PHP
// префикс 'ajaxs_priv_' означает что функця сработает только для авторизованного в WP пользователя
function ajaxs_priv_my_function( $jx ){
	// какие-либо првоерки
	if( условие не выполняется ){
		$jx->error( 'описание ошбики' );
	}

	if( дургое условие не выполняется ){
		$jx->error( 'описание ошбики' );
	}

	$jx->success( 'Все првоерки пройдены!' );

	// этот код выполнен не будет, потому что $jx->error() или $jx->success() обывают работу PHP.
	echo 'строка которая не будет выполнена';
}

#2 PHP функция-обработчик (function)

Этот пример показывает как указать какая функция PHP будет обрабатывать запрос.

// JS
ajaxs( 'my_function' );
// PHP

// вариант: префикс 'ajaxs_' - для всех юзеров
function ajaxs_my_function( $jx ){
	$jx->dumb( 'Сработал запрос с action = my_function' );
}

// вариант: префикс 'ajaxs_priv_' - только для авторизованных
function ajaxs_priv_my_function( $jx ){
	$jx->dumb( 'Сработал запрос с action = my_function' );
}

// вариант с хуком - как обычно в wordpress для обратной совместимосттю с WordPress
add_action( 'wp_ajax_my_function', 'ajax_handler_function' ); // для авторизованных
add_action( 'wp_ajax_nopriv_my_function', 'ajax_handler_function' ); // для неавторизованных
function ajax_handler_function( $jx ){
	$jx->dumb( 'Сработал запрос с action = my_function' );
}

Обратная совместимость в хуками WordPress дает возможность установить плагин и не переделывать уже написанный PHP код и при этом использовать функцию ajaxs() в JS. «Старый» PHP код будет работать как и до этого...

#2.2 PHP функция-обработчик (static method)

Этот пример показывает как указать статический метод класса, который будет обрабатывать запрос.

// JS
ajaxs( 'MY_Class::my_method' );
// PHP
class MY_Class {

	static function my_method( $jx ){
		$jx->console( 'Сработал метод: my_method' );
	}

}

#2.3 PHP функция-обработчик (public method)

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

Если экземпляр находится в глобальной переменной $my_class.

// JS
ajaxs( '$my_class->my_method' );
// PHP
class MY_Class {

	public function my_method( $jx ){
		$jx->console( 'Сработал метод: my_method' );
	}

}

global $my_class;
$my_class = new MY_Class(); // сохраним экземпляр, чтобы к нему был доступ

Если экземпляр возвращает функция my_class() или метод класса.

// JS

// так
ajaxs( 'my_class()->my_method' );

// или так
ajaxs( 'MY_Class::init()->my_method' );
// PHP
class MY_Class {

	static $instance;

	static function init(){
		is_null( self::$instance ) && self::$instance = new self;
		return self::$instance;
	}

	public function my_method( $jx ){
		$jx->console( 'Сработал метод: my_method' );
	}

}

function my_class(){
	return MY_Class::init();
}

#3 AJAX Загрузка файлов (single)

<!-- HTML -->
<div class="form">
	<input type="file" name="file_single" />
</div>
// JS
// вариант: передача всей формы
ajaxs( 'upload_image', jQuery('.form') );

// вариант: передача file поля
ajaxs( 'upload_image', jQuery('[input name="file_single"]') );

// вариант: передача значения поля
var file = jQuery('[input name="file_single"]')[0].files[0];
ajaxs( 'upload_image', { file_single: file } );
// PHP
function ajaxs_upload_image( $jx ){
	$file = $jx->file_single;
	/* $file будет содержать:
	Array (
		[name]     => Alex-Lynn.jpg
		[type]     => image/jpeg
		[tmp_name] => /home/server/userdata/temp/phpEB56.tmp
		[error]    => 0
		[size]     => 34986
	)
	*/

	// обрабатываем полученный файл
}

#3.2 AJAX Загрузка файлов (multiple)

Передать несколько файлов можно в одном поле file или в нескольких. Рассмотрим оба варианта в примере:

<!-- HTML -->
<div class="files-upload-form">
	<p><input type="file" multiple="multiple" name="file_multiple[]" /> - множественный выбор файлов</p>

	<p><input type="file" name="file_split_multiple[]" /> - выбор одного файла</p>
	<p><input type="file" name="file_split_multiple[]" /> - выбор одного файла</p>
</div>
// JS
ajaxs( 'upload_image', jQuery('.files-upload-form') );
// PHP
function ajaxs_upload_image( $jx ){

	// обе переменные будут содержать одинаковый формат - стандарт PHP
	$jx->file_multiple;
	$jx->file_split_multiple;

	/*
	Array (
		[name] => Array (
				[0] => Alex-Lynn.jpg
				[1] => caliyan.jpg
			)

		[type] => Array (
				[0] => image/jpeg
				[1] => image/jpeg
			)

		[tmp_name] => Array (
				[0] => /home/server/userdata/temp/phpBA7C.tmp
				[1] => /home/server/userdata/temp/phpBA8D.tmp
			)

		[error] => Array (
				[0] => 0
				[1] => 0
			)

		[size] => Array (
				[0] => 34986
				[1] => 178154
			)
	)
	*/

	// обрабатываем полученные файлы
}

#4 Использование $jx->html()

Допустим у нас есть контейнер, в который нужно вывести форму авторизации, такую форму легко получить с помощью функции wp_login_form().

<!-- HTML -->
<a class="auth_form_btn" href="#">Показать форму входа</a>
<div class="auth_form" style="display:none;"></div>
jQuery(function($){

	$('.auth_form_btn').click(function(ev){
		ev.preventDefault();

		ajaxs( 'show_auth_form' );
	});

});
function ajaxs_show_auth_form( $jx ){

	// добавим HTML в блок .auth_form
	$jx->html( '.auth_form', wp_login_form([ 'echo'=>false ]) );

	// покажем блок
	$jx->jseval( "jQuery('.auth_form').show();" );
}

Такая логика, делать что-то в JS из PHP мне не очень нравится, но иногда это очень удобно!

#5 Показ PHP ошибок

В WordPress показ ошибок для AJAX запросов полностью отключен и увидеть их можно только через лог файл. Это очень неудобно! Кто сталкивался, знает о чем я...

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

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

// JS
ajaxs( 'phpfunction' );
// PHP
function ajaxs_phpfunction( $jx ){
	// переменная, которой нет (ошибка уровня notice)
	$var['key'];

	// функция, которой нет в PHP (ошибка уровня fatal error)
	error_function_name();
}

В результате при AJAX запросе увидим ошибки в консоли браузера, а не будем гадать что же произошло и тратить свое время на поиск причины:

Тут важно отметить, что плагин ловит ошибки с ранней стадии - с момента как подключился его главный файл. Так допустим, если есть ошибка в functions.php он её тоже поймает и выведет в консоль...

В идеале плагин лучше ставить в MU плагины, правда там не будут работать автообновления...

Встраивание плагина в проект (не плагин)

В этом случае вы не будете получать автоматических обновлений и это единственный минус...

Чтобы встроить плагин в проект вам нужно скопировать папку плагина в папку, вашего плагина, темы или в папку MU плагинов. Куда нужно, туда копируем.

Затем просто подключаем главный файл плагина: ajax-simply.php в ваш проект:

require_once 'путь_к_плагину/ajax-simply.php';

Все!

Если плагин встраивается в тему

То еще нужно открыть файл ajax-simply.php и переопределить константу AJAXS_URL. В файле есть готовый код. В итоге должно выглядеть так:

# for plugin and must-use plugins
// define( 'AJAXS_URL',  plugin_dir_url(__FILE__) );
# for theme
define( 'AJAXS_URL', strtr( AJAXS_PATH, array( wp_normalize_path(get_template_directory()) => get_template_directory_uri() ) ) );

Скачать

Плагин платный, обновляется он также как плагины WordPress - автоматически по клику.

-

Успехов вам в разработке! Уверен, с AJAX Simply она станет намного проще!

AJAX Simply 2 комментария

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

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