WordPress.org

Make WordPress Core


Ignore:
Timestamp:
03/16/2020 06:38:03 PM (18 months ago)
Author:
johnbillion
Message:

Docs: Various docblock corrections and improvements.

See #49572

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/formatting.php

    r47400 r47461  
    35003500
    35013501/**
    3502  * Given a date in the timezone of the site, returns that date in UTC timezone.
     3502 * Given a date in the timezone of the site, returns that date in UTC.
    35033503 *
    35043504 * Requires and returns a date in the Y-m-d H:i:s format.
     
    35093509 * @param string $string The date to be converted, in the timezone of the site.
    35103510 * @param string $format The format string for the returned date. Default 'Y-m-d H:i:s'.
    3511  * @return string Formatted version of the date, in UTC timezone.
     3511 * @return string Formatted version of the date, in UTC.
    35123512 */
    35133513function get_gmt_from_date( $string, $format = 'Y-m-d H:i:s' ) {
     
    35223522
    35233523/**
    3524  * Given a date in UTC timezone, returns that date in the timezone of the site.
     3524 * Given a date in UTC or GMT timezone, returns that date in the timezone of the site.
    35253525 *
    35263526 * Requires and returns a date in the Y-m-d H:i:s format.
     
    35293529 * @since 1.2.0
    35303530 *
    3531  * @param string $string The date to be converted, in UTC timezone.
     3531 * @param string $string The date to be converted, in UTC or GMT timezone.
    35323532 * @param string $format The format string for the returned date. Default 'Y-m-d H:i:s'.
    35333533 * @return string Formatted version of the date, in the site's timezone.
     
    35443544
    35453545/**
    3546  * Computes an offset in seconds from an iso8601 timezone.
     3546 * Given an ISO 8601 timezone, returns its UTC offset in seconds.
    35473547 *
    35483548 * @since 1.5.0
     
    35653565
    35663566/**
    3567  * Converts an iso8601 (Ymd\TH:i:sO) date to MySQL DateTime (Y-m-d H:i:s) format used by post_date[_gmt].
     3567 * 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].
    35683568 *
    35693569 * @since 1.5.0
Note: See TracChangeset for help on using the changeset viewer.