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

Timestamp:

03/16/2020 06:38:03 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections and improvements.

See #49572

File:

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

trunk/src/wp-includes/formatting.php

@@ -3500 +3500 @@
 
 /**
- * Given a date in the timezone of the site, returns that date in UTC timezone.
+ * Given a date in the timezone of the site, returns that date in UTC.
  *
  * Requires and returns a date in the Y-m-d H:i:s format.
@@ -3509 +3509 @@
  * @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 Formatted version of the date, in UTC timezone.
+ * @return string Formatted version of the date, in UTC.
  */
 function get_gmt_from_date( $string, $format = 'Y-m-d H:i:s' ) {
@@ -3522 +3522 @@
 
 /**
- * Given a date in UTC timezone, returns that date in the timezone of the site.
+ * Given a date in UTC or GMT timezone, returns that date in the timezone of the site.
  *
  * Requires and returns a date in the Y-m-d H:i:s format.
@@ -3529 +3529 @@
  * @since 1.2.0
  *
- * @param string $string The date to be converted, in UTC timezone.
+ * @param string $string The date to be converted, in UTC or GMT timezone.
  * @param string $format The format string for the returned date. Default 'Y-m-d H:i:s'.
  * @return string Formatted version of the date, in the site's timezone.
@@ -3544 +3544 @@
 
 /**
- * Computes an offset in seconds from an iso8601 timezone.
+ * Given an ISO 8601 timezone, returns its UTC offset in seconds.
  *
  * @since 1.5.0
@@ -3565 +3565 @@
 
 /**
- * Converts an iso8601 (Ymd\TH:i:sO) date to MySQL DateTime (Y-m-d H:i:s) format used by post_date[_gmt].
+ * Given an ISO 8601 (Ymd\TH:i:sO) date, returns a MySQL DateTime (Y-m-d H:i:s) format used by post_date[_gmt].
  *
  * @since 1.5.0