Changeset 34240

Timestamp:

09/16/2015 03:28:12 PM (10 years ago)

Author:

SergeyBiryukov

Message:

Docs: Synchronize the $timezone parameter description between get_lastpostdate(), get_lastpostmodified(), and _get_last_post_time().

See #17455.

File:

• trunk/src/wp-includes/post-functions.php (modified) (5 diffs)

trunk/src/wp-includes/post-functions.php

@@ -5233 +5233 @@
  * @since 4.4.0 The `$post_type` argument was added.
  *
- * @param string $timezone  Optional. The location to get the time. Accepts 'gmt', 'blog',
- *                          or 'server'. Default 'server'.
+ * @param string $timezone  Optional. The timezone for the timestamp. Accepts 'server', 'blog', or 'gmt'.
+ *                          'server' uses the server's internal timezone.
+ *                          'blog' uses the `post_modified` field, which proxies to the timezone set for the site.
+ *                          'gmt' uses the `post_modified_gmt` field.
+ *                          Default 'server'.
  * @param string $post_type Optional. The post type to check. Default 'any'.
  * @return string The date of the last post.
@@ -5244 +5247 @@
      * @since 2.3.0
      *
-     * @param string $date     Date the last post was published. Likely values are 'gmt',
-     *                         'blog', or 'server'.
+     * @param string $date     Date the last post was published.
      * @param string $timezone Location to use for getting the post published date.
+     *                         See {@see get_lastpostdate()} for accepted `$timezone` values.
      */
     return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date', $post_type ), $timezone );
@@ -5261 +5264 @@
  * @since 4.4.0 The `$post_type` argument was added.
  *
- * @param string $timezone  Optional. The timezone for the timestamp. Uses the server's internal timezone.
- *                          Accepts 'server', 'blog', 'gmt'. or 'server'. 'server' uses the server's
- *                          internal timezone. 'blog' uses the `post_modified` field, which proxies
- *                          to the timezone set for the site. 'gmt' uses the `post_modified_gmt` field.
+ * @param string $timezone  Optional. The timezone for the timestamp. See {@see get_lastpostdate()}
+ *                          for information on accepted values.
  *                          Default 'server'.
  * @param string $post_type Optional. The post type to check. Default 'any'.
@@ -5284 +5285 @@
      * @param string $lastpostmodified Date the last post was modified.
      * @param string $timezone         Location to use for getting the post modified date.
-     *                                 See {@see get_lastpostmodified()} for accepted `$timezone` values.
+     *                                 See {@see get_lastpostdate()} for accepted `$timezone` values.
      */
     return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone );
@@ -5298 +5299 @@
  * @global wpdb $wpdb
  *
- * @param string $timezone  The timezone for the timestamp. See {@see get_lastpostmodified()}
+ * @param string $timezone  The timezone for the timestamp. See {@see get_lastpostdate()}
  *                          for information on accepted values.
  * @param string $field     Post field to check. Accepts 'date' or 'modified'.