Docs: Various docblock corrections and improvements.

See #50768


git-svn-id: https://develop.svn.wordpress.org/trunk@49597 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2020-11-14 16:33:52 +00:00
parent 36f47ff751
commit c19f56747f
8 changed files with 36 additions and 35 deletions

View File

@@ -2585,7 +2585,7 @@ function the_modified_date( $format = '', $before = '', $after = '', $echo = tru
*
* @param string $format Optional. PHP date format. Defaults to the 'date_format' option.
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
* @return string|false Date the current post was modified. False on failure.
* @return string|int|false Date the current post was modified. False on failure.
*/
function get_the_modified_date( $format = '', $post = null ) {
$post = get_post( $post );
@@ -2605,9 +2605,9 @@ function get_the_modified_date( $format = '', $post = null ) {
* @since 2.1.0
* @since 4.6.0 Added the `$post` parameter.
*
* @param string|false $the_time The formatted date or false if no post is found.
* @param string $format PHP date format.
* @param WP_Post|null $post WP_Post object or null if no post is found.
* @param string|int|false $the_time The formatted date or false if no post is found.
* @param string $format PHP date format.
* @param WP_Post|null $post WP_Post object or null if no post is found.
*/
return apply_filters( 'get_the_modified_date', $the_time, $format, $post );
}
@@ -2831,7 +2831,7 @@ function the_modified_time( $format = '' ) {
* was modified. Accepts 'G', 'U', or PHP date format.
* Defaults to the 'time_format' option.
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
* @return string|false Formatted date string or Unix timestamp. False on failure.
* @return string|int|false Formatted date string or Unix timestamp. False on failure.
*/
function get_the_modified_time( $format = '', $post = null ) {
$post = get_post( $post );
@@ -2851,10 +2851,10 @@ function get_the_modified_time( $format = '', $post = null ) {
* @since 2.0.0
* @since 4.6.0 Added the `$post` parameter.
*
* @param string|false $the_time The formatted time or false if no post is found.
* @param string $format Format to use for retrieving the time the post
* was modified. Accepts 'G', 'U', or PHP date format.
* @param WP_Post|null $post WP_Post object or null if no post is found.
* @param string|int|false $the_time The formatted time or false if no post is found.
* @param string $format Format to use for retrieving the time the post
* was modified. Accepts 'G', 'U', or PHP date format.
* @param WP_Post|null $post WP_Post object or null if no post is found.
*/
return apply_filters( 'get_the_modified_time', $the_time, $format, $post );
}
@@ -2908,10 +2908,10 @@ function get_post_modified_time( $format = 'U', $gmt = false, $post = null, $tra
*
* @since 2.8.0
*
* @param string $time The formatted time.
* @param string $format Format to use for retrieving the time the post was modified.
* Accepts 'G', 'U', or PHP date format. Default 'U'.
* @param bool $gmt Whether to retrieve the GMT time. Default false.
* @param string|int $time Formatted date string or Unix timestamp if `$format` is 'U' or 'G'.
* @param string $format Format to use for retrieving the time the post was modified.
* Accepts 'G', 'U', or PHP date format. Default 'U'.
* @param bool $gmt Whether to retrieve the GMT time. Default false.
*/
return apply_filters( 'get_post_modified_time', $time, $format, $gmt );
}