Changeset 52441

Timestamp:

01/04/2022 06:52:43 PM (21 months ago)

Author:

davidbaumwald

Message:

HTTP API: Improve docs for wp_remote_retrieve_header function return value.

This change updates the @return docs for wp_remote_retrieve_header to specify that an array can also be returned if the requested header key has multiple values.

Props robtarr, johnjamesjacoby, felipeelia, hellofromTonya, costdev.
Fixes #51736.

File:

• trunk/src/wp-includes/http.php (modified) (1 diff)

trunk/src/wp-includes/http.php

@@ -223 +223 @@
  * @param array|WP_Error $response HTTP response.
  * @param string         $header   Header name to retrieve value from.
- * @return string The header value. Empty string on if incorrect parameter given, or if the header doesn't exist.
+ * @return array|string The header(s) value(s). Array if multiple headers with the same name are retrieved.
+ *                      Empty string if incorrect parameter given, or if the header doesn't exist.
  */
 function wp_remote_retrieve_header( $response, $header ) {