From 9406ccb8c63c3adbb8474521ee036eba26ce3e82 Mon Sep 17 00:00:00 2001 From: "Drew Jaynes (DrewAPicture)" Date: Fri, 11 Jul 2014 22:49:50 +0000 Subject: [PATCH] Convert default arguments documentation for WP_Http_Cookie::__construct() into a hash notation. Props coffee2code for the initial patch. See #28841. git-svn-id: https://develop.svn.wordpress.org/trunk@29107 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-http.php | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/src/wp-includes/class-http.php b/src/wp-includes/class-http.php index 1f0420a934..64a7bab7bc 100644 --- a/src/wp-includes/class-http.php +++ b/src/wp-includes/class-http.php @@ -1770,21 +1770,21 @@ class WP_Http_Cookie { * The parameter $data should be either an associative array containing the indices names below * or a header string detailing it. * - * If it's an array, it should include the following elements: - *
    - *
  1. Name
  2. - *
  3. Value - should NOT be urlencoded already.
  4. - *
  5. Expires - (optional) String or int (UNIX timestamp).
  6. - *
  7. Path (optional)
  8. - *
  9. Domain (optional)
  10. - *
  11. Port (optional)
  12. - *
- * - * @access public * @since 2.8.0 + * @access public * - * @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 = '' ) { if ( $requested_url )