Changeset 46424 for trunk/src/wp-includes/http.php

Timestamp:

10/07/2019 07:06:41 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous inline docs corrections and improvements.

See #47110

File:

• trunk/src/wp-includes/http.php (modified) (9 diffs)

trunk/src/wp-includes/http.php

@@ -155 +155 @@
 
 /**
- * Retrieve the raw response from the HTTP request using the GET method.
+ * Performs an HTTP request using the GET method and returns its response.
  *
  * @since 2.7.0
@@ -172 +172 @@
 
 /**
- * Retrieve the raw response from the HTTP request using the POST method.
+ * Performs an HTTP request using the POST method and returns its response.
  *
  * @since 2.7.0
@@ -189 +189 @@
 
 /**
- * Retrieve the raw response from the HTTP request using the HEAD method.
+ * Performs an HTTP request using the HEAD method and returns its response.
  *
  * @since 2.7.0
@@ -418 +418 @@
  * @since 3.4.0
  *
- * @return array Array of origin URLs.
+ * @return string[] Array of origin URLs.
  */
 function get_allowed_http_origins() {
@@ -439 +439 @@
      * @since 3.4.0
      *
-     * @param array $allowed_origins {
-     *     Default allowed HTTP origins.
-     *     @type string Non-secure URL for admin origin.
-     *     @type string Secure URL for admin origin.
-     *     @type string Non-secure URL for home origin.
-     *     @type string Secure URL for home origin.
+     * @param string[] $allowed_origins {
+     *     Array of default allowed HTTP origins.
+     *
+     *     @type string $0 Non-secure URL for admin origin.
+     *     @type string $1 Secure URL for admin origin.
+     *     @type string $2 Non-secure URL for home origin.
+     *     @type string $3 Secure URL for home origin.
      * }
      */
@@ -518 +519 @@
  * @since 3.5.2
  *
- * @param string $url
+ * @param string $url Request URL.
  * @return false|string URL or false on failure.
  */
@@ -573 +574 @@
                  * @since 3.6.0
                  *
-                 * @param bool   false Whether HTTP request is external or not.
-                 * @param string $host IP of the requested host.
-                 * @param string $url  URL of the requested host.
+                 * @param bool   $external Whether HTTP request is external or not.
+                 * @param string $host     Host name of the requested URL.
+                 * @param string $url      Requested URL.
                  */
                 if ( ! apply_filters( 'http_request_host_is_external', false, $host, $url ) ) {
@@ -716 +717 @@
  *
  * @param array|false $url_parts The parsed URL. Can be false if the URL failed to parse.
- * @param int    $component The specific component to retrieve. Use one of the PHP
- *                          predefined constants to specify which one.
- *                          Defaults to -1 (= return all parts as an array).
+ * @param int         $component The specific component to retrieve. Use one of the PHP
+ *                               predefined constants to specify which one.
+ *                               Defaults to -1 (= return all parts as an array).
  * @return mixed False on parse failure; Array of URL components on success;
  *               When a specific component has been requested: null if the component
@@ -748 +749 @@
  *
  * @param int $constant PHP_URL_* constant.
- * @return string|bool The named key or false.
+ * @return string|false The named key or false.
  */
 function _wp_translate_php_url_constant_to_key( $constant ) {