Changeset 40946

Timestamp:

06/25/2017 09:49:27 PM (7 years ago)

Author:

DrewAPicture

Message:

Docs: Clarify that the $post parameters for the get_the_modified_date and get_the_modified_time filters can also be of type null.

Props dlh.
Fixes #40845.

File:

• trunk/src/wp-includes/general-template.php (modified) (2 diffs)

trunk/src/wp-includes/general-template.php

@@ -2314 +2314 @@
      * @since 4.6.0 Added the `$post` parameter.
      *
-     * @param string  $the_time The formatted date.
-     * @param string  $d        PHP date format. Defaults to value specified in
-     *                          'date_format' option.
-     * @param WP_Post $post     WP_Post object.
+     * @param string|bool  $the_time The formatted date or false if no post is found.
+     * @param string       $d        PHP date format. Defaults to value specified in
+     *                               'date_format' option.
+     * @param WP_Post|null $post     WP_Post object or null if no post is found.
      */
     return apply_filters( 'get_the_modified_date', $the_time, $d, $post );
@@ -2469 +2469 @@
      * @since 4.6.0 Added the `$post` parameter.
      *
-     * @param string $the_time The formatted time.
-     * @param string $d        Format to use for retrieving the time the post was
-     *                         written. Accepts 'G', 'U', or php date format. Defaults
-     *                         to value specified in 'time_format' option.
-     * @param WP_Post $post    WP_Post object.
+     * @param string|bool  $the_time The formatted time or false if no post is found.
+     * @param string       $d        Format to use for retrieving the time the post was
+     *                               written. Accepts 'G', 'U', or php date format. Defaults
+     *                               to value specified in 'time_format' option.
+     * @param WP_Post|null $post     WP_Post object or null if no post is found.
      */
     return apply_filters( 'get_the_modified_time', $the_time, $d, $post );