类文档

Requests

💡 云策文档标注

概述

Requests 是一个用于 PHP 的 HTTP 请求库,灵感来源于 Python 的 Requests,基于 SimplePie_File、RequestCore 和 WP_Http 的概念。它是一个静态类,不应被实例化。

关键要点

  • Requests 是一个静态类,提供多种 HTTP 请求方法,如 GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH 和 TRACE。
  • 支持请求传输注册、默认选项设置、证书路径管理、响应解析和压缩解压功能。
  • 包含已弃用的方法,如 autoloader 和 register_autoloader,建议使用 WpOrgRequestsAutoload 替代。
  • 提供 request 和 request_multiple 方法作为主要接口,用于发送单个或多个 HTTP 请求。

代码示例

public static function autoloader($class) {
    if (class_exists('WpOrgRequestsAutoload') === false) {
        require_once __DIR__ . '/Requests/src/Autoload.php';
    }

    return WpOrgRequestsAutoload::load($class);
}

注意事项

  • autoloader 和 register_autoloader 方法已弃用,从版本 6.2.0 起,应使用 WpOrgRequestsAutoload 类进行自动加载。
  • Requests 类不应被实例化,所有方法均为静态调用。

📄 原文内容

Requests for PHP

Description

Inspired by Requests for Python.

Based on concepts from SimplePie_File, RequestCore and WP_Http.

Methods

Name Description
Requests::__construct This is a static class, do not instantiate it
Requests::add_transport Register a transport
Requests::autoloader Deprecated autoloader for Requests. — deprecated
Requests::compatible_gzinflate Decompression of deflated string while staying compatible with the majority of servers.
Requests::decode_chunked Decoded a chunked body as per RFC 2616
Requests::decompress Decompress an encoded body
Requests::delete Send a DELETE request
Requests::flatten Convert a key => value array to a ‘key: value’ array for headers
Requests::flattern Convert a key => value array to a ‘key: value’ array for headers — deprecated
Requests::get Send a GET request
Requests::get_certificate_path Get default certificate path.
Requests::get_default_options Get the default options
Requests::get_transport Get a working transport
Requests::head Send a HEAD request
Requests::match_domain
Requests::options Send an OPTIONS request
Requests::parse_multiple Callback for `transport.internal.parse_response`
Requests::parse_response HTTP response parser
Requests::patch Send a PATCH request
Requests::post Send a POST request
Requests::put Send a PUT request
Requests::register_autoloader Register the built-in autoloader — deprecated
Requests::request Main interface for HTTP requests
Requests::request_multiple Send multiple HTTP requests simultaneously
Requests::set_certificate_path Set default certificate path.
Requests::set_defaults Set the default values
Requests::trace Send a TRACE request

Source

class Requests extends WpOrgRequestsRequests {

	/**
	 * Deprecated autoloader for Requests.
	 *
	 * @deprecated 6.2.0 Use the `WpOrgRequestsAutoload::load()` method instead.
	 *
	 * @codeCoverageIgnore
	 *
	 * @param string $class Class name to load
	 */
	public static function autoloader($class) {
		if (class_exists('WpOrgRequestsAutoload') === false) {
			require_once __DIR__ . '/Requests/src/Autoload.php';
		}

		return WpOrgRequestsAutoload::load($class);
	}

	/**
	 * Register the built-in autoloader
	 *
	 * @deprecated 6.2.0 Include the `WpOrgRequestsAutoload` class and
	 *                   call `WpOrgRequestsAutoload::register()` instead.
	 *
	 * @codeCoverageIgnore
	 */
	public static function register_autoloader() {
		require_once __DIR__ . '/Requests/src/Autoload.php';
		WpOrgRequestsAutoload::register();
	}
}

Changelog

Version Description
6.2.0 Introduced.