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

# Функция WP_REMOTE_HEAD()

Функция wp_remote_head() позволяет получить ответ от HTTP-запроса, используя метод HEAD.

## Назначение

Данная функция используется для извлечения заголовков ответа от удалённого сервера, не загружая его содержимое.

### Возвращаемое значение

Функция возвращает массив с данными или объект типа WP_Error в случае ошибки. Для получения информации о возвращаемом значении смотрите WP_Http::request().

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

```php
wp_remote_head( $url, $args );
  • $url (строка) — обязательный параметр, URL-адрес, который нужно запросить.
  • $args (массив) — аргументы запроса. Для получения информации о допустимых аргументах смотрите WP_Http::request(). По умолчанию — пустой массив.

Примеры

Пример 1: Получение заголовков ответа HTTP API

$response = wp_remote_head( 'https://api.github.com/users/erusev' );
print_r( $response );

/* на выходе получится:
Array
(
    [headers] => Array
        (
            [server] => GitHub.com
            [date] => Thu, 10 Dec 2015 10:53:23 GMT
            [content-type] => application/json; charset=utf-8
            [connection] => close
            [status] => 200 OK
            [x-ratelimit-limit] => 60
            [x-ratelimit-remaining] => 54
            [x-ratelimit-reset] => 1449746444
            [cache-control] => public, max-age=60, s-maxage=60
            [last-modified] => Mon, 23 Nov 2015 13:19:37 GMT
            [etag] => W/"c8dad0c81351ce6451a9b7de7f7f0d8b"
            [vary] => Array
                (
                    [0] => Accept
                    [1] => Accept-Encoding
                )

            [x-github-media-type] => github.v3
            [x-xss-protection] => 1; mode=block
            [x-frame-options] => deny
            [content-security-policy] => default-src 'none'
            [access-control-allow-credentials] => true
            [access-control-expose-headers] => ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
            [access-control-allow-origin] => *
            [strict-transport-security] => max-age=31536000; includeSubdomains; preload
            [x-content-type-options] => nosniff
            [x-served-by] => 139317cebd6caf9cd03889139437f00b
            [content-encoding] => gzip
            [x-github-request-id] => 05659C50:A398:252770C:566959A3
        )

    [body] => (всегда пустой)
    [response] => Array
        (
             => 200
            [message] => OK
        )

    [cookies] => Array
        (
        )

    [filename] => 
)
*/

Примечания

  • Для получения более подробной информации о формате массива ответа смотрите wp_remote_request().
  • Для информации о стандартных аргументах смотрите WP_Http::request().

Изменения

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

Исходный код функции

function wp_remote_head( $url, $args = array() ) {
    $http = _wp_http_get_object();
    return $http->head( $url, $args );
}

Сопутствующие функции

  • status_header()
  • wp_get_http_headers()
  • wp_http_validate_url()
  • wp_remote_get()
  • wp_remote_post()
  • wp_remote_request()
  • wp_remote_retrieve_body()
  • wp_remote_retrieve_cookie()
  • wp_remote_retrieve_cookie_value()
  • wp_remote_retrieve_cookies()
  • wp_remote_retrieve_header()
  • wp_remote_retrieve_headers()
  • wp_remote_retrieve_response_code()
  • wp_remote_retrieve_response_message()
  • wp_safe_remote_request()

Leave a Reply

Ваш адрес email не будет опубликован. Обязательные поля помечены *