Changeset 29107

Timestamp:

07/11/2014 10:49:50 PM (12 years ago)

Author:

DrewAPicture

Message:

Convert default arguments documentation for WP_Http_Cookie::construct() into a hash notation.

Props coffee2code for the initial patch.
See #28841.

File:

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

trunk/src/wp-includes/class-http.php

@@ -1771 +1771 @@
          * or a header string detailing it.
          *
-         * If it's an array, it should include the following elements:
-         * <ol>
-         * <li>Name</li>
-         * <li>Value - should NOT be urlencoded already.</li>
-         * <li>Expires - (optional) String or int (UNIX timestamp).</li>
-         * <li>Path (optional)</li>
-         * <li>Domain (optional)</li>
-         * <li>Port (optional)</li>
-         * </ol>
-         *
+         * @since 2.8.0
          * @access public
-         * @since 2.8.0
-         *
-         * @param string|array $data Raw cookie data.
-         * @param string $requested_url The URL which the cookie was set on, used for default 'domain' and 'port' values
+         *
+         * @param string|array $data {
+         *     Raw cookie data as header string or data array.
+         *
+         *     @type string     $name    Cookie name.
+         *     @type mixed      $value   Value. Should NOT already be urlencoded.
+         *     @type string|int $expires Optional. Unix timestamp or formatted date. Default null.
+         *     @type string     $path    Optional. Path. Default '/'.
+         *     @type string     $domain  Optional. Domain. Default host of parsed $requested_url.
+         *     @type int        $port    Optional. Port. Default null.
+         * }
+         * @param string       $requested_url The URL which the cookie was set on, used for default $domain
+         *                                    and $port values.
          */
         public function __construct( $data, $requested_url = '' ) {