Changeset 30287

Timestamp:

11/08/2014 09:07:46 PM (10 years ago)

Author:

DrewAPicture

Message:

Fix incorrect documentation in the DocBlocks for get_lastpostmodified() and _get_last_post_time().

Props ericlewis for the initial patch.
Fixes #30249.

File:

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

trunk/src/wp-includes/post.php

@@ -5328 +5328 @@
 
 /**
- * Retrieve last post modified date depending on timezone.
+ * Get the timestamp of the last time any post was modified.
  *
  * The server timezone is the default and is the difference between GMT and
@@ -5336 +5336 @@
  * @since 1.2.0
  *
- * @param string $timezone The location to get the time. Accepts 'gmt', 'blog', or 'server'.
+ * @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.
  *                         Default 'server'.
- * @return string The date the post was last modified.
+ * @return string The timestamp.
  */
 function get_lastpostmodified( $timezone = 'server' ) {
@@ -5354 +5357 @@
      * @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.
      */
     return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone );
@@ -5359 +5363 @@
 
 /**
- * Retrieve latest post date data based on timezone.
- *
+ * Get the timestamp of the last time any post was modified or published.
+ *
+ * @since 3.1.0
  * @access private
- * @since 3.1.0
- *
- * @param string $timezone The location to get the time. Accepts 'gmt', 'blog', or 'server'.
- * @param string $field Field to check. Can be 'date' or 'modified'.
- * @return string The date.
+ *
+ * @param string $timezone The timezone for the timestamp. See {@see get_lastpostmodified()}
+ *                         for information on accepted values.
+ * @param string $field    Post field to check. Accepts 'date' or 'modified'.
+ * @return string The timestamp.
  */
 function _get_last_post_time( $timezone, $field ) {