Функция rest_url() в WordPress используется для получения URL REST API. Это полезно, когда вам нужно программно генерировать URL для запросов к REST API.
rest_url( $path = '', $scheme = 'rest' )Параметры
$path(строка) (необязательно) — Путь, который нужно добавить к базовому URL REST API. По умолчанию: пустая строка.$scheme(строка) (необязательно) — Схема, которая будет использоваться в URL. Возможные значения: ‘http’, ‘https’, ‘rest’, ‘relative’. По умолчанию: ‘rest’.
Возвращаемое значение
- Возвращает строку, содержащую URL REST API.
Пример 1: Получение базового URL REST API
Для получения базового URL REST API без дополнительных путей можно просто вызвать rest_url() без параметров:
$rest_api_url = rest_url();
echo $rest_api_url;Этот код выведет базовый URL REST API, например:
http://example.com/wp-json/Пример 2: Добавление пути к базовому URL REST API
Если вам нужно добавить путь к базовому URL REST API, вы можете передать его в качестве параметра:
$path = 'wp/v2/posts';
$rest_api_url = rest_url( $path );
echo $rest_api_url;Этот код выведет URL для получения всех постов через REST API:
http://example.com/wp-json/wp/v2/postsПример 3: Использование другой схемы URL
Если вам нужно использовать другую схему URL, например ‘https’, вы можете передать её в качестве второго параметра:
$path = '/foo';
$scheme = 'https';
$rest_api_url = rest_url( $path, $scheme );
echo $rest_api_url;Этот код выведет URL с использованием схемы ‘https’:
https://example.com/wp-json/fooПолезные советы
- Используйте
rest_url()для генерации URL, чтобы избежать ошибок при ручном составлении URL и обеспечить совместимость с различными конфигурациями сайта. - Функция полезна при разработке плагинов и тем, которые взаимодействуют с REST API.
Заключение
Функция rest_url() — это мощный инструмент для разработчиков WordPress, который позволяет легко и правильно генерировать URL для запросов к REST API. Использование этой функции обеспечивает надежность и совместимость вашего кода с различными конфигурациями WordPress.
Теперь вы знаете, как использовать rest_url() для получения URL REST API и как добавлять к нему пути и изменять схему URL. Это важная часть разработки на WordPress, особенно при работе с REST API.