Docs: Correct description for the_time(), get_the_time(), and get_post_time().
Some checks are pending
Cleanup Pull Requests / Clean up pull requests (push) Waiting to run
Coding Standards / PHP coding standards (push) Waiting to run
Coding Standards / JavaScript coding standards (push) Waiting to run
Coding Standards / Slack Notifications (push) Blocked by required conditions
Coding Standards / Failed workflow tasks (push) Blocked by required conditions
End-to-end Tests / Test with SCRIPT_DEBUG disabled (push) Waiting to run
End-to-end Tests / Test with SCRIPT_DEBUG enabled (push) Waiting to run
End-to-end Tests / Slack Notifications (push) Blocked by required conditions
End-to-end Tests / Failed workflow tasks (push) Blocked by required conditions
JavaScript Tests / QUnit Tests (push) Waiting to run
JavaScript Tests / Slack Notifications (push) Blocked by required conditions
JavaScript Tests / Failed workflow tasks (push) Blocked by required conditions
Performance Tests / Single site (push) Waiting to run
Performance Tests / Multisite (push) Waiting to run
Performance Tests / Slack Notifications (push) Blocked by required conditions
Performance Tests / Failed workflow tasks (push) Blocked by required conditions
PHP Compatibility / Check PHP compatibility (push) Waiting to run
PHP Compatibility / Slack Notifications (push) Blocked by required conditions
PHP Compatibility / Failed workflow tasks (push) Blocked by required conditions
PHPUnit Tests / PHP 7.2 (push) Waiting to run
PHPUnit Tests / PHP 7.3 (push) Waiting to run
PHPUnit Tests / PHP 7.4 (push) Waiting to run
PHPUnit Tests / PHP 8.0 (push) Waiting to run
PHPUnit Tests / PHP 8.1 (push) Waiting to run
PHPUnit Tests / PHP 8.2 (push) Waiting to run
PHPUnit Tests / PHP 8.3 (push) Waiting to run
PHPUnit Tests / PHP 8.4 (push) Waiting to run
PHPUnit Tests / html-api-html5lib-tests (push) Waiting to run
PHPUnit Tests / Slack Notifications (push) Blocked by required conditions
PHPUnit Tests / Failed workflow tasks (push) Blocked by required conditions
Test Build Processes / Core running from build (push) Waiting to run
Test Build Processes / Core running from src (push) Waiting to run
Test Build Processes / Gutenberg running from build (push) Waiting to run
Test Build Processes / Gutenberg running from src (push) Waiting to run
Test Build Processes / Slack Notifications (push) Blocked by required conditions
Test Build Processes / Failed workflow tasks (push) Blocked by required conditions

This aims to avoid confusion with `the_date()` and `get_the_date()`.

Includes synchronizing the description for `the_weekday()` and `the_weekday_date()`, which have very similar functionality, except that the latter will only output the weekday if the current post's weekday is different from the previous one output.

Follow-up to [59691].

See #51289.

git-svn-id: https://develop.svn.wordpress.org/trunk@59692 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2025-01-23 00:45:34 +00:00
parent 0cad2168b0
commit 4a991830e2

View File

@ -2672,7 +2672,7 @@ function get_the_modified_date( $format = '', $post = null ) {
}
/**
* Displays the date of the post.
* Displays the time of the post.
*
* @since 0.71
*
@ -2682,7 +2682,7 @@ function get_the_modified_date( $format = '', $post = null ) {
*/
function the_time( $format = '' ) {
/**
* Filters the date of the post, for display.
* Filters the time of the post, for display.
*
* @since 0.71
*
@ -2694,7 +2694,7 @@ function the_time( $format = '' ) {
}
/**
* Retrieves the date of the post.
* Retrieves the time of the post.
*
* @since 1.5.0
*
@ -2717,7 +2717,7 @@ function get_the_time( $format = '', $post = null ) {
$the_time = get_post_time( $_format, false, $post, true );
/**
* Filters the date of the post.
* Filters the time of the post.
*
* @since 1.5.0
*
@ -2730,7 +2730,7 @@ function get_the_time( $format = '', $post = null ) {
}
/**
* Retrieves the localized date of the post.
* Retrieves the localized time of the post.
*
* @since 2.0.0
*
@ -2774,7 +2774,7 @@ function get_post_time( $format = 'U', $gmt = false, $post = null, $translate =
}
/**
* Filters the localized date of the post.
* Filters the localized time of the post.
*
* @since 2.6.0
*
@ -2976,7 +2976,7 @@ function get_post_modified_time( $format = 'U', $gmt = false, $post = null, $tra
}
/**
* Displays the weekday for the post.
* Displays the localized weekday for the post.
*
* @since 0.71
*
@ -2994,7 +2994,7 @@ function the_weekday() {
$the_weekday = $wp_locale->get_weekday( get_post_time( 'w', false, $post ) );
/**
* Filters the weekday of the post, for display.
* Filters the localized weekday of the post, for display.
*
* @since 0.71
*
@ -3004,7 +3004,7 @@ function the_weekday() {
}
/**
* Displays the localized weekday date for the post
* Displays the localized weekday for the post.
*
* Will only output the weekday if the current post's weekday is different from
* the previous one output.
@ -3037,7 +3037,7 @@ function the_weekday_date( $before = '', $after = '' ) {
}
/**
* Filters the localized weekday date of the post, for display.
* Filters the localized weekday of the post, for display.
*
* @since 0.71
*