rest_authentication_errors
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
apply_filters( 'rest_authentication_errors', WP_Error|null|true $errors )Описание
Используется для передачи WP_Error от метода аутентификации обратно в API.
Методы аутентификации должны сначала проверять, используются ли они, так как на сайте может быть включено несколько методов аутентификации (cookies, HTTP basic auth, OAuth). Если подключённый метод аутентификации фактически не применяется, следует вернуть null, чтобы указать, что проверку должен выполнить другой метод аутентификации. Аналогично, функции обратного вызова должны убедиться, что значение равно null, прежде чем проверять наличие ошибок.
При возникновении ошибки может быть возвращён экземпляр WP_Error, и он должен соответствовать формату, используемому методами API внутренне (то есть должны использоваться данные о статусе). Функция обратного вызова может вернуть true, чтобы указать, что метод аутентификации был использован и завершился успешно.
Оригинал (английский)
This is used to pass a WP_Error from an authentication method back to the API.
Authentication methods should check first if they’re being used, as multiple authentication methods can be enabled on a site (cookies, HTTP basic auth, OAuth). If the authentication method hooked in is not actually being attempted, null should be returned to indicate another authentication method should check instead. Similarly, callbacks should ensure the value is null before checking for errors.
A WP_Error instance can be returned if an error occurs, and this should match the format used by API methods internally (that is, the status data should be used). A callback can return true to indicate that the authentication method was used, and it succeeded.
Фильтруемое значение
Параметры
$errors
WP_Error|null|true
обязательный
Исходный код
wp-includes/rest-api/class-wp-rest-server.php:197
return apply_filters( 'rest_authentication_errors', null );История изменений
| Версия | Описание |
|---|---|
| 4.4.0 | Introduced. |
