Changeset 46958 for trunk/src/wp-includes/formatting.php

Timestamp:

12/13/2019 09:43:06 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify descriptions for get_gmt_from_date() and get_date_from_gmt().

Props johnbillion, Rarst.
Fixes #48650.

File:

• trunk/src/wp-includes/formatting.php (modified) (4 diffs)

trunk/src/wp-includes/formatting.php

@@ -3498 +3498 @@
 
 /**
- * Returns a date in the GMT equivalent.
+ * Given a date in the timezone of the site, returns that date in UTC timezone.
  *
  * Requires and returns a date in the Y-m-d H:i:s format.
@@ -3505 +3505 @@
  * @since 1.2.0
  *
- * @param string $string The date to be converted.
+ * @param string $string The date to be converted, in the timezone of the site.
  * @param string $format The format string for the returned date. Default 'Y-m-d H:i:s'.
- * @return string GMT version of the date provided.
+ * @return string Formatted version of the date, in UTC timezone.
  */
 function get_gmt_from_date( $string, $format = 'Y-m-d H:i:s' ) {
@@ -3520 +3520 @@
 
 /**
- * Converts a GMT date into the correct format for the blog.
+ * Given a date in UTC timezone, returns that date in the timezone of the site.
  *
  * Requires and returns a date in the Y-m-d H:i:s format.
@@ -3527 +3527 @@
  * @since 1.2.0
  *
- * @param string $string The date to be converted.
+ * @param string $string The date to be converted, in UTC timezone.
  * @param string $format The format string for the returned date. Default 'Y-m-d H:i:s'.
- * @return string Formatted date relative to the timezone.
+ * @return string Formatted version of the date, in the site's timezone.
  */
 function get_date_from_gmt( $string, $format = 'Y-m-d H:i:s' ) {