Make WordPress Core


Ignore:
Timestamp:
02/07/2023 09:19:46 PM (15 months ago)
Author:
johnbillion
Message:

Docs: Miscellaneous improvements and corrections to docblocks.

See #56792

File:
1 edited

Legend:

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

    r55104 r55293  
    12931293 * @param string $date   RFC3339 timestamp.
    12941294 * @param bool   $is_utc Whether the provided date should be interpreted as UTC. Default false.
    1295  * @return array|null Local and UTC datetime strings, in MySQL datetime format (Y-m-d H:i:s),
    1296  *                    null on failure.
     1295 * @return array|null {
     1296 *     Local and UTC datetime strings, in MySQL datetime format (Y-m-d H:i:s),
     1297 *     null on failure.
     1298 *
     1299 *     @type string $0 Local datetime string.
     1300 *     @type string $1 UTC datetime string.
     1301 * }
    12971302 */
    12981303function rest_get_date_with_gmt( $date, $is_utc = false ) {
     
    15501555
    15511556/**
    1552  * Converts an object-like value to an object.
     1557 * Converts an object-like value to an array.
    15531558 *
    15541559 * @since 5.5.0
    15551560 *
    15561561 * @param mixed $maybe_object The value being evaluated.
    1557  * @return array Returns the object extracted from the value.
     1562 * @return array Returns the object extracted from the value as an associative array.
    15581563 */
    15591564function rest_sanitize_object( $maybe_object ) {
     
    15821587 * @since 5.5.0
    15831588 *
    1584  * @param mixed $value The value to check.
    1585  * @param array $types The list of possible types.
     1589 * @param mixed    $value The value to check.
     1590 * @param string[] $types The list of possible types.
    15861591 * @return string The best matching type, an empty string if no types match.
    15871592 */
Note: See TracChangeset for help on using the changeset viewer.