Make WordPress Core


Ignore:
Timestamp:
11/14/2020 04:33:52 PM (3 years ago)
Author:
johnbillion
Message:

Docs: Various docblock corrections and improvements.

See #50768

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/general-template.php

    r49355 r49597  
    25862586 * @param string      $format Optional. PHP date format. Defaults to the 'date_format' option.
    25872587 * @param int|WP_Post $post   Optional. Post ID or WP_Post object. Default current post.
    2588  * @return string|false Date the current post was modified. False on failure.
     2588 * @return string|int|false Date the current post was modified. False on failure.
    25892589 */
    25902590function get_the_modified_date( $format = '', $post = null ) {
     
    26062606     * @since 4.6.0 Added the `$post` parameter.
    26072607     *
    2608      * @param string|false $the_time The formatted date or false if no post is found.
    2609      * @param string       $format   PHP date format.
    2610      * @param WP_Post|null $post     WP_Post object or null if no post is found.
     2608     * @param string|int|false $the_time The formatted date or false if no post is found.
     2609     * @param string           $format   PHP date format.
     2610     * @param WP_Post|null     $post     WP_Post object or null if no post is found.
    26112611     */
    26122612    return apply_filters( 'get_the_modified_date', $the_time, $format, $post );
     
    28322832 *                            Defaults to the 'time_format' option.
    28332833 * @param int|WP_Post $post   Optional. Post ID or WP_Post object. Default current post.
    2834  * @return string|false Formatted date string or Unix timestamp. False on failure.
     2834 * @return string|int|false Formatted date string or Unix timestamp. False on failure.
    28352835 */
    28362836function get_the_modified_time( $format = '', $post = null ) {
     
    28522852     * @since 4.6.0 Added the `$post` parameter.
    28532853     *
    2854      * @param string|false $the_time The formatted time or false if no post is found.
    2855      * @param string       $format   Format to use for retrieving the time the post
    2856      *                               was modified. Accepts 'G', 'U', or PHP date format.
    2857      * @param WP_Post|null $post     WP_Post object or null if no post is found.
     2854     * @param string|int|false $the_time The formatted time or false if no post is found.
     2855     * @param string           $format   Format to use for retrieving the time the post
     2856     *                                   was modified. Accepts 'G', 'U', or PHP date format.
     2857     * @param WP_Post|null     $post     WP_Post object or null if no post is found.
    28582858     */
    28592859    return apply_filters( 'get_the_modified_time', $the_time, $format, $post );
     
    29092909     * @since 2.8.0
    29102910     *
    2911      * @param string $time   The formatted time.
    2912      * @param string $format Format to use for retrieving the time the post was modified.
    2913      *                       Accepts 'G', 'U', or PHP date format. Default 'U'.
    2914      * @param bool   $gmt    Whether to retrieve the GMT time. Default false.
     2911     * @param string|int $time   Formatted date string or Unix timestamp if `$format` is 'U' or 'G'.
     2912     * @param string     $format Format to use for retrieving the time the post was modified.
     2913     *                           Accepts 'G', 'U', or PHP date format. Default 'U'.
     2914     * @param bool       $gmt    Whether to retrieve the GMT time. Default false.
    29152915     */
    29162916    return apply_filters( 'get_post_modified_time', $time, $format, $gmt );
Note: See TracChangeset for help on using the changeset viewer.