WordPress.org

Make WordPress Core

Changeset 47461


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

Docs: Various docblock corrections and improvements.

See #49572

Location:
trunk/src
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-custom-image-header.php

    r47219 r47461  
    12451245     *
    12461246     * @param array  $object  Attachment object.
    1247      * @param string $cropped Cropped image URL.
     1247     * @param string $cropped File path to cropped image.
    12481248     * @return int Attachment ID.
    12491249     */
  • trunk/src/wp-admin/includes/image.php

    r47287 r47461  
    534534                 * @param array $image_attachment An array of parameters to create the thumbnail.
    535535                 * @param array $metadata         Current attachment metadata.
    536                  * @param array $uploaded         An array containing the thumbnail path and url.
     536                 * @param array $uploaded         {
     537                 *     Information about the newly-uploaded file.
     538                 *
     539                 *     @type string $file  Filename of the newly-uploaded file.
     540                 *     @type string $url   URL of the uploaded file.
     541                 *     @type string $type  File type.
     542                 * }
    537543                 */
    538544                $image_attachment = apply_filters( 'attachment_thumbnail_args', $image_attachment, $metadata, $uploaded );
  • 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
  • trunk/src/wp-includes/functions.php

    r47454 r47461  
    26172617 * @param string       $bits       File content
    26182618 * @param string       $time       Optional. Time formatted in 'yyyy/mm'. Default null.
    2619  * @return array
     2619 * @return array {
     2620 *     Information about the newly-uploaded file.
     2621 *
     2622 *     @type string       $file  Filename of the newly-uploaded file.
     2623 *     @type string       $url   URL of the uploaded file.
     2624 *     @type string       $type  File type.
     2625 *     @type string|false $error Error message, if there has been an error.
     2626 * }
    26202627 */
    26212628function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
  • trunk/src/wp-includes/pluggable.php

    r47398 r47461  
    26442644
    26452645        /**
    2646          * Filters whether to retrieve the avatar URL early.
     2646         * Allows the HTML for a user's avatar to be returned early.
    26472647         *
    26482648         * Passing a non-null value will effectively short-circuit get_avatar(), passing
     
    26522652         *
    26532653         * @param string|null $avatar      HTML for the user's avatar. Default null.
    2654          * @param mixed       $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
     2654         * @param mixed       $id_or_email The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
    26552655         *                                 user email, WP_User object, WP_Post object, or WP_Comment object.
    26562656         * @param array       $args        Arguments passed to get_avatar_url(), after processing.
     
    27032703
    27042704        /**
    2705          * Filters the avatar to retrieve.
     2705         * Filters the HTML for a user's avatar.
    27062706         *
    27072707         * @since 2.5.0
    27082708         * @since 4.2.0 The `$args` parameter was added.
    27092709         *
    2710          * @param string $avatar      <img> tag for the user's avatar.
    2711          * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
     2710         * @param string $avatar      HTML for the user's avatar.
     2711         * @param mixed  $id_or_email The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
    27122712         *                            user email, WP_User object, WP_Post object, or WP_Comment object.
    27132713         * @param int    $size        Square avatar width and height in pixels to retrieve.
    27142714         * @param string $default     URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
    2715          *                            'wavatar', 'indenticon','mystery' (or 'mm', or 'mysteryman'), 'blank', or 'gravatar_default'.
     2715         *                            'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'.
    27162716         *                            Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.
    27172717         * @param string $alt         Alternative text to use in the avatar image tag. Default empty.
  • trunk/src/wp-includes/post.php

    r47448 r47461  
    516516     * @since 2.1.0
    517517     *
    518      * @param string $file          Path to attached file.
    519      * @param int    $attachment_id Attachment ID.
     518     * @param string|false $file          The file path to where the attached file should be, false otherwise.
     519     * @param int          $attachment_id Attachment ID.
    520520     */
    521521    return apply_filters( 'get_attached_file', $file, $attachment_id );
Note: See TracChangeset for help on using the changeset viewer.