WordPress как на ладони
Шаблоны, плагины и темы для настоящих поклонников Elementor. От TemplateMonster.com wordpress jino

REST API в WordPress

WordPress REST API (или коротко WP API) позволяет пользователям (HTTP Клиентам) удаленно взаимодействовать с сайтом: отправлять запросы и получать ответы. Ответы приходят в JSON формате. Так, например, можно получить посты, рубрики, комменты сайта и т.д. Кроме того, такие данные можно создавать/изменять/удалять. Делается все это через URL запросы, так называемые «маршруты».

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

REST API полноценно был добавлен в ядро WordPress в версии 4.7.

Этот раздел создавался на базе официального руководства: REST API Handbook (англ). Однако тут мы по возможности упрощаем/уточняем/дорабатываем/реструктурируем контент, приводим примеры и в итоге стараемся подать информацию более понятно.

Коротко о REST API (WP API)

WordPress REST API (далее просто REST API или WP API) разработан на базе технологии REST, чтобы иметь понятные URL-адреса и использовать коды HTTP ответов для указания успехов или ошибок. Использует встроенные функции HTTP, такие как http-аутентификация и http-команды (GET, POST), которые могут быть поняты многими HTTP-клиентами. WP API позволяет удобно и безопасно работать с WordPress из клиентского приложения.

REST API:

  • Предоставляет структурированный, расширяемый и простой способ получить или передать данные в WordPress.

  • Использует json в качестве формата запроса и ответа, включая ответы на ошибки.

  • Предоставляет разные данные: публичные и личные (доступны только после аутентификации). После аутентификации rest API позволяет управлять контентом сайта.

  • Позволяет работать с любым языком программирования, который может обрабатывать HTTP-запросы и интерпретировать JSON, например Node.js или Java.

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

  • Может заменить способ обработки ajax запросов. Смотрите: admin-ajax API.

При всей своей простоте, REST API может показаться сложным, поэтому изучение этой темы будет разбито на логические части, так будет проще освоить материал. В основном сложность заключается в новой терминологии — это всякие там ресурсы, эндпоинты, маршруты. Они нужны для создания и применения стандартов, но для понимания того, как это работает все эти вещи совсем не обязательны. Для понимания работы REST API достаточно изучить всего одну функцию register_rest_route(), ознакомится с маршрутами WP и научится пользоваться каким-нибудь Клиентом (например Postman для общения с WP API.

Ключевые понятия REST API

Смотрите в разделе Базовый знания REST API. Нужно разобраться в каждом понятии, чтобы понимать что написано и о чем идет речь в этом руководстве!

Как отключить REST API?

На этот вопрос я уже отвечал.

Однако разработчики WordPress настоятельно рекомендует НЕ отключать REST API, потому что это поломает будущую работоспособность WordPress — WP планирует использовать REST API в админке с 5 версии.

Чтобы оставить REST API работоспособным, но при этом закрыть все маршруты от публичного доступа, используйте следующий код:

add_filter( 'rest_authentication_errors', function( $result ) {
	if( empty( $result ) && ! current_user_can('edit_others_posts') ){
		return new WP_Error( 'rest_not_logged_in', 'You are not currently logged in.', array( 'status' => 401 ) );
	}

	return $result;
});

Код можно вставить в файл темы functions.php или куда-либо еще.

Этот код разрешает доступ к REST API только для авторизованных пользователей с правами редактора и выше.

Проверку ! current_user_can('edit_others_posts') можно заменить на более подходящую для вашего сайта. Например, её можно упростить и сделать доступным REST API для всех авторизованных пользователей, неважно какие у него права. Для этого нужно заменить проверку на ! is_user_logged_in().

Полезные ссылки

2 коммента
Здравствуйте, !     Войти . Зарегистрироваться