AJAX в WordPress, с чего б начать?

Проводил опрос в своём телеграм канале относительно этого поста и выяснилсь, что большинству он всё-таки нужен, поэтому погнали.

Тут я буду рассчитывать на то, что вы базово знаете PHP, базово знаете jQuery. Если да, то трудностей этот урок вызвать не должен.

Если вы не знаете этих вещей, то сорян, вам тут вычитывать нечего. 🔫 Заглядывайте чуть попозже.

Если вы не уверены в своих силах, сначала просто неспеша вчитайтесь в эту статью, а только потом приступайте к действию. Всё у вас получится 🎉

Тут важно уточнить, что это именно урок для начинающих, тут мы не будем работать с типами данных json, выполнять nonce-проверки и пр.

0. Подготовка 

Как я уже говорил, я предполагаю, что вы базово знаете jQuery, поэтому подобная конструкция для вас ясна как день 🏞

jQuery(function($){ // есть разные варианты этой строчки, но такая мне нравится больше всего, т.к. всегда работает
	$('#misha_button').click(function(){ // при клике на элемент с id="misha_button" 
		alert('Если это работает, уже неплохо'); // выводим сообщение
	});
});

На всякий случай напомню, что должна быть подключена библиотека jQuery, а упомянутый выше код находиться после нее, сразу покажу, ок?

<script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
<script>
jQuery(function($){
	$('#misha_button').click(function(){
		alert('Если это работает, уже неплохо');
	});
});
</script>

Если применять это к правильному подключению JavaScript в WordPress, то в теме это вполне может выглядеть так:

<?php wp_footer() ?>
<script>
jQuery(function($){
	$('#misha_button').click(function(){
		alert('Если это работает, уже неплохо');
	});
});
</script>

То есть библиотека jQuery уже была подключена через wp_enqueue_script() либо в wp_head(), либо в wp_footer(), наша же задача закинуть наш собственный код jQuery после неё. Знаю, что мы можем сделать это через файл, мы можем сделать это через хук, а можно и просто в шаблоне вывести (у вас это возможно footer.php будет, но не факт).

В этом уроке для простоты понимания весь мой jQuery код будет находиться в файле footer.php темы.

Итак, прежде, чем переходить к следующему шагу, добейтесь вот этого 👇

Сообщение alert

1. Познакомимся с $.ajax 

В jQuery есть несколько способов отправки асинхронных запросов, сам я пользуюсь только $.ajax, так как он более универсален, остальные – лишь частные случаи из него. В общих чертах, учитывая всё необходимое, код будет выглядеть вот так👇

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
jQuery(function($){
	$('#misha_button').click(function(){
		$.ajax({
			url: 'https://misha.blog/myajax.php',
			type: 'POST',
			data: 'param1=2&param2=3', // можно также передать в виде объекта
			beforeSend: fucntion( xhr ) {
				$('#misha_button').text('Загрузка, 5 сек...');	
			},
			success: function( data ) {
				$('#misha_button').text('Отправить');	
				alert( data );
			}
		});
		// если элемент – ссылка, то не забываем:
		// return false;
	});
});

Го по строчкам прокомментирую:

  • 4 – абсолютный URL обработчика PHP, то есть ссылка на файл, например https://misha.blog/myajax.php
  • 5 – точно так же, как и с отправкой форм, если используете POST, то для получения переменных в PHP вам нужен массив $_POST, если используете GET, то тогда будете использовать массив $_GET
  • 6 – сами параметры, тут я их передал в виде урл-строки, но вы можете передавать их также в виде объекта, для объекта это будет выглядеть так:
    data: {
    	param1: 2,
    	param2: 3
    }

    И соответственно, вне зависимости от того, какой вариант указания параметров вы выберете, для нашего примера они будут доступны в PHP коде (я решил назвать файл myajax.php, помним да?) при помощи $_POST['param1'] и $_POST['param2'].

  • 7-9 – это функция, которая выполнится перед отправкой запроса, тут можно годно активировать всякие прелоадеры, я вот например изменил текст кнопки .
  • 11-14 – это функция запускается сразу после получения данных, а данные это… параметр этой функции конечно же, он может называться по-разному, у меня — data
  • У функции $.ajax есть много прикольных параметров, я рекомендую попрактиковаться с ними, документацию можете найти на официальном сайте.

Так, теперь самая важная часть – обработка запроса в PHP. У нас с вами есть файл myajax.php, который находится в корне сайта, пусть он сложит два параметра – param1 и param2 и возвратит нам их сумму. Ну изи же? 🙌

$summa = $_POST['param1'] + $_POST['param2'];
echo $summa; // то, что выводим, то и считается данными, возвращаемыми запросом

Прежде, чем перейти к следующему шагу, сделайте, чтобы при нажатии на кнопку у вас выводилась сумма двух параметров в alert().

Alert результат выполнения AJAX-запроса

Почему мы складываем числа в PHP, когда это можно сделать непосредственно в JavaScript на стороне клиента? Потому что мы учимся, Карл! Если слишком легко для тебя, отправляйся в пост посложнее или ещё сложнее.

2. Познакомимся со стандартным обработчиком асинронных запросов в WordPress – admin-ajax.php 

Сам код отправки асинхронного запроса изменится совсем чуть-чуть:

  • На 4й строчке мы указываем на путь на наш собственный файл-обработчик, а на стандартный вордпрессовский, он всегда находится в одном месте — https://misha.blog/wp-admin/admin-ajax.php (только домен моего сайта замените на свой, очень прошу). Так как я использую мой код в файле footer.php, в среде WordPress, то я могу получить путь к этому файлу динамически, например при помощи функции admin_url() или site_url().
  • На 6-й строке, там где передаются параметры, обязательно нужно указать параметр action с каким-нибудь произвольным значением, которое мы будем подцеплять чуть позже.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
jQuery(function($){
	$('#misha_button').click(function(){
		$.ajax({
			url: '<?php echo admin_url("admin-ajax.php") ?>',
			type: 'POST',
			data: 'action=misha&param1=2&param2=3', // можно также передать в виде массива или объекта
			beforeSend: fucntion( xhr ) {
				$('#misha_button').text('Загрузка, 5 сек...');	
			},
			success: function( data ) {
				$('#misha_button').text('Отправить');	
				alert( data );
			}
		});
		// если элемент – ссылка, то не забываем:
		// return false;
	});
});

И вторым шагом нужно будет создать функцию в functions.php и повесить её на два хука (если используете AJAX в админке, то только на один кстати).

add_action( 'wp_ajax_misha', 'test_function' ); // wp_ajax_{ЗНАЧЕНИЕ ПАРАМЕТРА ACTION!!}
add_action( 'wp_ajax_nopriv_misha', 'test_function' );  // wp_ajax_nopriv_{ЗНАЧЕНИЕ ACTION!!}
// первый хук для авторизованных, второй для не авторизованных пользователей
 
function test_function(){
 
	$summa = $_POST['param1'] + $_POST['param2'];
	echo $summa;
 
	die; // даём понять, что обработчик закончил выполнение
}

3. Распространённые косяки 

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

Ничего не происходит или страница перезагружается 😐

Скорее всего у вас синтаксическая ошибка в вашем JavaScript-коде, для этого мы открываем консоль браузера и смотрим, где она примерно находится и на что похожа, например:

Ошибка JavaScript в консоли хрома

То есть уже примерно понимаем, что к чему.

Выводится 0 вместо того, что я хочу 😨

Я вас поздравляю 🎉 — если вывелся 0, значит с вашим кодом jQuery всё прекрасно! Обычно 0 означает, что запрос к admin-ajax.php выполнился, но произошло несоответствие параметра action.

То есть в запросы вы передали одно его значение (или не передали вовсе), а в хуках wp_ajax_ и wp_ajax_nopriv_ указали другое (либо использовали не по назначению лишь один из хуков).

Асинхронный запрос выполняется, но вообще ничего не выводит 😥

Скорее всего ошибка в PHP-коде вашего обработчика PHP, если он — это функция в functions.php, то это вряд ли пропущенная точка с запятой (тогда бы полетел весь сайт), скорее всего это просто несуществующая функция или класс.

В консоли браузера в таких случаях ошибка 500.

Ошибка 500 в консоли браузера

Видеоурок обо всём этом 


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

Напоминаю, что на сайте нет и не будет рекламы, в качестве поддержки подписывайтесь на Telegram-канал или на Youtube-канал (на которых кстати также нет и не будет рекламы!).

Миша Рудрастых Разработчик WordPress WooCommerce

Миша Рудрастых

Впервые познакомился с WordPress в 2009 году, и после двух лет мучений с Joomla и самописными движками это был просто бальзам на душу. С 2014 года меня можно встретить на WordCamp — официальной конфе по WP в Москве, иногда там выступаю. Также в настоящее время веду курсы по WordPress в Epic Skills в Питере.

Всё получилось? Вот следующие уроки про AJAX в WordPress