Changeset 45748

Timestamp:

08/05/2019 07:55:15 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct @type annotation for WP_HTTP_Cookie::$expires.

Props diddledan.
Fixes #46859.

File:

• trunk/src/wp-includes/class-wp-http-cookie.php (modified) (3 diffs)

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

@@ -38 +38 @@
 
     /**
-     * When the cookie expires.
-     *
-     * @since 2.8.0
-     * @var string
+     * When the cookie expires. Unix timestamp or formatted date.
+     *
+     * @since 2.8.0
+     * @var string|int|null
      */
     public $expires;
@@ -81 +81 @@
      *     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.
-     *     @type bool       $host_only Optional. host-only storage flag. Default true.
+     *     @type string          $name      Cookie name.
+     *     @type mixed           $value     Value. Should NOT already be urlencoded.
+     *     @type string|int|null $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.
+     *     @type bool            $host_only Optional. host-only storage flag. Default true.
      * }
      * @param string       $requested_url The URL which the cookie was set on, used for default $domain
@@ -247 +247 @@
      *    List of attributes.
      *
-     *    @type string $expires When the cookie expires.
-     *    @type string $path    Cookie URL path.
-     *    @type string $domain  Cookie domain.
+     *    @type string|int|null $expires When the cookie expires. Unix timestamp or formatted date.
+     *    @type string          $path    Cookie URL path.
+     *    @type string          $domain  Cookie domain.
      * }
      */