Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-23 01:27:36 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
Props coffee2code for the initial patch.
See #28841.

Built from https://develop.svn.wordpress.org/trunk@29107


git-svn-id: http://core.svn.wordpress.org/trunk@28893 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-07-11 22:50:15 +00:00
parent e3c39d02cf
commit cf17bd6e5e
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1770,21 +1770,21 @@ class WP_Http_Cookie {
* The parameter $data should be either an associative array containing the indices names below * The parameter $data should be either an associative array containing the indices names below
* or a header string detailing it. * 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>
*
* @access public
* @since 2.8.0 * @since 2.8.0
* @access public
* *
* @param string|array $data Raw cookie data. * @param string|array $data {
* @param string $requested_url The URL which the cookie was set on, used for default 'domain' and 'port' values * 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 = '' ) { public function __construct( $data, $requested_url = '' ) {
if ( $requested_url ) if ( $requested_url )