Changeset 48634 for trunk/src/wp-includes/post.php

Timestamp:

07/27/2020 11:15:44 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Synchronize documentation for get_lastpostdate() and get_lastpostmodified().

See #49572.

File:

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

trunk/src/wp-includes/post.php

@@ -6606 +6606 @@
  *
  * The server timezone is the default and is the difference between GMT and
- * server time. The 'blog' value is the date when the last post was posted. The
- * 'gmt' is when the last post was posted in GMT formatted date.
+ * server time. The 'blog' value is the date when the last post was posted.
+ * The 'gmt' is when the last post was posted in GMT formatted date.
  *
  * @since 0.71
@@ -6621 +6621 @@
  */
 function get_lastpostdate( $timezone = 'server', $post_type = 'any' ) {
-    $date = _get_last_post_time( $timezone, 'date', $post_type );
+    $lastpostdate = _get_last_post_time( $timezone, 'date', $post_type );
 
     /**
@@ -6629 +6629 @@
      * @since 5.5.0 Added the `$post_type` parameter.
      *
-     * @param string|false $date      Date the last post was published. False on failure.
-     * @param string       $timezone  Location to use for getting the post published date.
-     *                                See get_lastpostdate() for accepted `$timezone` values.
-     * @param string       $post_type The post type to check.
+     * @param string|false $lastpostdate The most recent time that a post was published,
+     *                                   in 'Y-m-d H:i:s' format. False on failure.
+     * @param string       $timezone     Location to use for getting the post published date.
+     *                                   See get_lastpostdate() for accepted `$timezone` values.
+     * @param string       $post_type    The post type to check.
      */
     return apply_filters( 'get_lastpostdate', $date, $timezone, $post_type );
@@ -6641 +6642 @@
  *
  * The server timezone is the default and is the difference between GMT and
- * server time. The 'blog' value is just when the last post was modified. The
- * 'gmt' is when the last post was modified in GMT time.
+ * server time. The 'blog' value is just when the last post was modified.
+ * The 'gmt' is when the last post was modified in GMT time.
  *
  * @since 1.2.0
@@ -6659 +6660 @@
      * @since 4.4.0
      *
-     * @param string|false $lastpostmodified The most recent time that a post was modified, in 'Y-m-d H:i:s' format, or
-     *                                       false. Returning anything other than false will short-circuit the function.
+     * @param string|false $lastpostmodified The most recent time that a post was modified,
+     *                                       in 'Y-m-d H:i:s' format, or false. Returning anything
+     *                                       other than false will short-circuit the function.
      * @param string       $timezone         Location to use for getting the post modified date.
      *                                       See get_lastpostdate() for accepted `$timezone` values.
@@ -6679 +6681 @@
 
     /**
-     * Filters the most recent time that a post was modified.
+     * Filters the most recent time that a post on the site was modified.
      *
      * @since 2.3.0
      * @since 5.5.0 Added the `$post_type` parameter.
      *
-     * @param string|false $lastpostmodified The most recent time that a post was modified, in 'Y-m-d H:i:s' format.
-     *                                       False on failure.
+     * @param string|false $lastpostmodified The most recent time that a post was modified,
+     *                                       in 'Y-m-d H:i:s' format. False on failure.
      * @param string       $timezone         Location to use for getting the post modified date.
      *                                       See get_lastpostdate() for accepted `$timezone` values.