Changeset 60119

Timestamp:

04/01/2025 04:41:05 PM (3 months ago)

Author:

SergeyBiryukov

Message:

Docs: Correct documentation for current_time(), date_i18n(), and wp_date().

Includes:

• Standardizing on the bool type for the $gmt parameter between current_time() and date_i18n().
• Documenting null as an acceptable value for $timestamp and $timezone parameters in wp_date().
• Removing a redundant note on the $gmt parameter for the date_i18n filter, as defaults are normally only documented for function parameters.

Follow-up to [1001], [9616], [28109], [45901].

Props dilipbheda.
Fixes #63207.

File:

• trunk/src/wp-includes/functions.php (modified) (3 diffs)

trunk/src/wp-includes/functions.php

@@ -71 +71 @@
  * @since 5.3.0 Now returns an integer if `$type` is 'U'. Previously a string was returned.
  *
- * @param string   $type Type of time to retrieve. Accepts 'mysql', 'timestamp', 'U',
- *                       or PHP date format string (e.g. 'Y-m-d').
- * @param int|bool $gmt  Optional. Whether to use GMT timezone. Default false.
+ * @param string $type Type of time to retrieve. Accepts 'mysql', 'timestamp', 'U',
+ *                     or PHP date format string (e.g. 'Y-m-d').
+ * @param bool   $gmt  Optional. Whether to use GMT timezone. Default false.
  * @return int|string Integer if `$type` is 'timestamp' or 'U', string otherwise.
  */
-function current_time( $type, $gmt = 0 ) {
+function current_time( $type, $gmt = false ) {
     // Don't use non-GMT timestamp, unless you know the difference and really need to.
     if ( 'timestamp' === $type || 'U' === $type ) {
@@ -217 +217 @@
      *                          Might be without offset if input omitted timestamp but requested GMT.
      * @param bool   $gmt       Whether to use GMT timezone. Only applies if timestamp was not provided.
-     *                          Default false.
      */
     $date = apply_filters( 'date_i18n', $date, $format, $timestamp, $gmt );
@@ -236 +235 @@
  * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
- * @param string       $format    PHP date format.
- * @param int          $timestamp Optional. Unix timestamp. Defaults to current time.
- * @param DateTimeZone $timezone  Optional. Timezone to output result in. Defaults to timezone
- *                                from site settings.
+ * @param string            $format    PHP date format.
+ * @param int|null          $timestamp Optional. Unix timestamp. Defaults to current time.
+ * @param DateTimeZone|null $timezone  Optional. Timezone to output result in. Defaults to timezone
+ *                                     from site settings.
  * @return string|false The date, translated if locale specifies it. False on invalid timestamp input.
  */