Функция REST_URL() в WordPress: описание, примеры, изменения

# Функция REST_URL() │ WP 4.4.0

Функция REST_URL() используется для получения URL-адреса REST-эндпоинта (интерфейса для общения с приложением по сети).

**Примечание:** Возвращаемый URL **не экранируется**, то есть он может быть использован напрямую в коде.

## Используемые функции
- get_rest_url() — получает базовый URL для REST API.
- rest_get_url_prefix() — возвращает префикс URL для REST API.

### Время работы
- 1 раз: 0.0041261 сек (очень медленно)
- 50000 раз: 8.83 сек (быстро)

**Не имеет хуков.**

## Возвращаемое значение
Строка. Полный URL к эндпоинту.

## Использование

Формат использования функции:

```php
rest_url( $path, $scheme );

Где:

• $path (строка) — маршрут REST. По умолчанию: '' (пустая строка).
• $scheme (строка) — схема безопасности. По умолчанию: 'rest'.

Примеры использования

Примеры получения URL различных REST-эндпоинтов:

echo rest_url();                  //> http://example.com/wp-json/
echo rest_url('/foo');           //> http://example.com/wp-json/foo
echo rest_url('/foo', 'https');  //> https://example.com/wp-json/foo

Изменения

• С версии 4.4.0 — функция была введена.

Код функции REST_URL

Функция REST_URL() в файле wp-includes/rest-api.php выглядит следующим образом:

function rest_url( $path = '', $scheme = 'rest' ) {
    return get_rest_url( null, $path, $scheme );
}

Связанные функции

• REST API
  • get_rest_url() — получает базовый URL.
  • register_rest_field() — регистрирует новое поле для REST API.
  • register_rest_route() — регистрирует новый маршрут.
  • rest_ensure_response() — гарантирует, что ответ является корректным.
  • rest_is_boolean() — проверяет, является ли значение логическим значением.
  • rest_output_link_wp_head() — выводит ссылки в заголовок под привычные для WP.
  • rest_sanitize_array() — очищает массив данных.
  • rest_stabilize_value() — стабилизирует значение.

Также существуют методы для работы с паролями приложений в WordPress, чтобы обеспечить безопасность при взаимодействии с REST API.