WordPress.org

Make WordPress Core

Changeset 43642


Ignore:
Timestamp:
09/14/2018 01:34:50 PM (3 years ago)
Author:
johnbillion
Message:

Docs: Correct and improve some docblocks.

See #42505

Location:
trunk/src
Files:
2 edited

Legend:

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

    r43571 r43642  
    171171 * @since 2.6.0
    172172 *
    173  * @param string $html
    174  * @param integer $id
    175  * @param string $caption image caption
    176  * @param string $title image title attribute
    177  * @param string $align image css alignment property
    178  * @param string $url image src url
    179  * @param string $size image size (thumbnail, medium, large, full or added with add_image_size() )
    180  * @param string $alt image alt attribute
    181  * @return string
     173 * @param string  $html    The image HTML markup to send.
     174 * @param integer $id      Image attachment ID.
     175 * @param string  $caption Image caption.
     176 * @param string  $title   Image title attribute (not used).
     177 * @param string  $align   Image CSS alignment property.
     178 * @param string  $url     Image source URL (not used).
     179 * @param string  $size    Image size (`thumbnail`, `medium`, `large`, `full`, or added with `add_image_size()`) (not used).
     180 * @param string  $alt     Image `alt` attribute (not used).
     181 * @return string The image HTML markup with caption shortcode.
    182182 */
    183183function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $alt = '' ) {
  • trunk/src/wp-includes/pluggable.php

    r43571 r43642  
    887887         * @since 4.9.0 The `$token` parameter was added.
    888888         *
    889          * @param string $auth_cookie Authentication cookie.
     889         * @param string $auth_cookie Authentication cookie value.
    890890         * @param int    $expire      The time the login grace period expires as a UNIX timestamp.
    891891         *                            Default is 12 hours past the cookie's expiration time.
     
    893893         *                            Default is 14 days from now.
    894894         * @param int    $user_id     User ID.
    895          * @param string $scheme      Authentication scheme. Values include 'auth', 'secure_auth', or 'logged_in'.
     895         * @param string $scheme      Authentication scheme. Values include 'auth' or 'secure_auth'.
    896896         * @param string $token       User's session token to use for this cookie.
    897897         */
     
    904904         * @since 4.9.0 The `$token` parameter was added.
    905905         *
    906          * @param string $logged_in_cookie The logged-in cookie.
     906         * @param string $logged_in_cookie The logged-in cookie value.
    907907         * @param int    $expire           The time the login grace period expires as a UNIX timestamp.
    908908         *                                 Default is 12 hours past the cookie's expiration time.
Note: See TracChangeset for help on using the changeset viewer.