vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Various docblock corrections and improvements.

Browse Source 
See #49572

git-svn-id: https://develop.svn.wordpress.org/trunk@47461 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2020-03-16 18:38:03 +00:00
parent 0bed3c251a
commit c8d918e476
6 changed files with 30 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/wp-includes/formatting.php
View File

@@ -3499,7 +3499,7 @@ function _wp_iso_convert( $match ) {
}
/**
* 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.
* Return format can be overridden using the $format parameter.
@@ -3508,7 +3508,7 @@ function _wp_iso_convert( $match ) {
*
* @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' ) {
$datetime = date_create( $string, wp_timezone() );
@@ -3521,14 +3521,14 @@ function get_gmt_from_date( $string, $format = 'Y-m-d H:i:s' ) {
}
/**
* 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.
* Return format can be overridden using the $format parameter.
*
* @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.
*/
@@ -3543,7 +3543,7 @@ function get_date_from_gmt( $string, $format = 'Y-m-d H:i:s' ) {
}
/**
* Computes an offset in seconds from an iso8601 timezone.
* Given an ISO 8601 timezone, returns its UTC offset in seconds.
*
* @since 1.5.0
*
@@ -3564,7 +3564,7 @@ function iso8601_timezone_to_offset( $timezone ) {
}
/**
* 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
*