Changeset 46973

Timestamp:

12/17/2019 08:24:46 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify that get_lastpostdate() and get_lastpostmodified() can return false on failure.

The both use _get_last_post_time() internally.

Props Rarst.
See #48957.

File:

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

trunk/src/wp-includes/post.php

@@ -6393 +6393 @@
  *                          Default 'server'.
  * @param string $post_type Optional. The post type to check. Default 'any'.
- * @return string The date of the last post.
+ * @return string The date of the last post, or false on failure.
  */
 function get_lastpostdate( $timezone = 'server', $post_type = 'any' ) {
@@ -6401 +6401 @@
      * @since 2.3.0
      *
-     * @param string $date     Date the last post was published.
-     * @param string $timezone Location to use for getting the post published date.
-     *                         See get_lastpostdate() for accepted `$timezone` values.
+     * @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.
      */
     return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date', $post_type ), $timezone );
@@ -6422 +6422 @@
  *                          Default 'server'.
  * @param string $post_type Optional. The post type to check. Default 'any'.
- * @return string The timestamp in 'Y-m-d H:i:s' format.
+ * @return string The timestamp in 'Y-m-d H:i:s' format, or false on failure.
  */
 function get_lastpostmodified( $timezone = 'server', $post_type = 'any' ) {
@@ -6453 +6453 @@
      * @since 2.3.0
      *
-     * @param string $lastpostmodified The most recent time that a post was modified, in 'Y-m-d H:i:s' format.
-     * @param string $timezone         Location to use for getting the post modified date.
-     *                                 See get_lastpostdate() for accepted `$timezone` values.
+     * @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.
      */
     return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone );
@@ -6473 +6474 @@
  * @param string $field     Post field to check. Accepts 'date' or 'modified'.
  * @param string $post_type Optional. The post type to check. Default 'any'.
- * @return string|false The timestamp in 'Y-m-d H:i:s' format, or false on error.
+ * @return string|false The timestamp in 'Y-m-d H:i:s' format, or false on failure.
  */
 function _get_last_post_time( $timezone, $field, $post_type = 'any' ) {