Changeset 43380 for trunk/src/wp-includes/functions.php

Timestamp:

06/26/2018 01:18:13 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for date_i18n()'s second argument.

Despite previously being labeled as a Unix timestamp, in reality it's a sum of Unix timestamp and timezone offset in seconds.

Props Rarst.
See #38771.

File:

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

trunk/src/wp-includes/functions.php

@@ -75 +75 @@
 
 /**
- * Retrieve the date in localized format, based on timestamp.
+ * Retrieve the date in localized format, based on a sum of Unix timestamp and
+ * timezone offset in seconds.
  *
  * If the locale specifies the locale month and weekday, then the locale will
@@ -85 +86 @@
  * @global WP_Locale $wp_locale
  *
- * @param string   $dateformatstring Format to display the date.
- * @param bool|int $unixtimestamp    Optional. Unix timestamp. Default false.
- * @param bool     $gmt              Optional. Whether to use GMT timezone. Default false.
+ * @param string   $dateformatstring      Format to display the date.
+ * @param int|bool $timestamp_with_offset Optional. A sum of Unix timestamp and timezone offset in seconds.
+ *                                        Default false.
+ * @param bool     $gmt                   Optional. Whether to use GMT timezone. Default false.
  *
  * @return string The date, translated if locale specifies it.
  */
-function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
+function date_i18n( $dateformatstring, $timestamp_with_offset = false, $gmt = false ) {
     global $wp_locale;
-    $i = $unixtimestamp;
+    $i = $timestamp_with_offset;
 
     if ( false === $i ) {
@@ -148 +150 @@
      * @param string $j          Formatted date string.
      * @param string $req_format Format to display the date.
-     * @param int    $i          Unix timestamp.
+     * @param int    $i          A sum of Unix timestamp and timezone offset in seconds.
      * @param bool   $gmt        Whether to convert to GMT for time. Default false.
      */