mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-02-13 19:25:20 +01:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Docs: Improve documentation for WP_Http::processHeaders().

Browse Source 
Document the `@return` value using hash notation.

Props marekdedic, valchovski, davidbaumwald, deepaklalwani, thimalw, SergeyBiryukov.
Fixes #48350.

git-svn-id: https://develop.svn.wordpress.org/trunk@48630 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-07-26 22:43:47 +00:00
parent 10563ae9e7
commit a1c40b346c
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/wp-includes/class-http.php
View File

@ -667,17 +667,27 @@ class WP_Http {
}
/**
* Transform header string into an array.
*
* If an array is given, then it is assumed to be raw header data with numeric keys with the
* headers as the values. No headers must be passed that were already processed.
* Transforms header string into an array.
*
* @since 2.7.0
*
* @param string|array $headers
* @param string $url The URL that was requested.
* @return array Processed string headers. If duplicate headers are encountered,
* then a numbered array is returned as the value of that header-key.
* @param string|array $headers The original headers. If a string is passed, it will be converted
* to an array. If an array is passed, then it is assumed to be
* raw header data with numeric keys with the headers as the values.
* No headers must be passed that were already processed.
* @param string $url Optional. The URL that was requested. Default empty.
* @return array {
* Processed string headers. If duplicate headers are encountered,
* then a numbered array is returned as the value of that header-key.
*
* @type array $response {
* @type int $code The response status code. Default 0.
* @type string $message The response message. Default empty.
* }
* @type array $newheaders The processed header data as a multidimensional array.
* @type WP_Http_Cookie[] $cookies If the original headers contain the 'Set-Cookie' key,
* an array containing `WP_Http_Cookie` objects is returned.
* }
*/
public static function processHeaders( $headers, $url = '' ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
// Split headers, one per array element.