Changeset 43642

Timestamp:

09/14/2018 01:34:50 PM (7 years ago)

Author:

johnbillion

Message:

Docs: Correct and improve some docblocks.

See #42505

Location:

trunk/src

Files:

• wp-admin/includes/media.php (modified) (1 diff)
• wp-includes/pluggable.php (modified) (3 diffs)

trunk/src/wp-admin/includes/media.php

@@ -171 +171 @@
  * @since 2.6.0
  *
- * @param string $html
- * @param integer $id
- * @param string $caption image caption
- * @param string $title image title attribute
- * @param string $align image css alignment property
- * @param string $url image src url
- * @param string $size image size (thumbnail, medium, large, full or added with add_image_size() )
- * @param string $alt image alt attribute
- * @return string
+ * @param string  $html    The image HTML markup to send.
+ * @param integer $id      Image attachment ID.
+ * @param string  $caption Image caption.
+ * @param string  $title   Image title attribute (not used).
+ * @param string  $align   Image CSS alignment property.
+ * @param string  $url     Image source URL (not used).
+ * @param string  $size    Image size (`thumbnail`, `medium`, `large`, `full`, or added with `add_image_size()`) (not used).
+ * @param string  $alt     Image `alt` attribute (not used).
+ * @return string The image HTML markup with caption shortcode.
  */
 function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $alt = '' ) {

trunk/src/wp-includes/pluggable.php

@@ -887 +887 @@
          * @since 4.9.0 The `$token` parameter was added.
          *
-         * @param string $auth_cookie Authentication cookie.
+         * @param string $auth_cookie Authentication cookie value.
          * @param int    $expire      The time the login grace period expires as a UNIX timestamp.
          *                            Default is 12 hours past the cookie's expiration time.
@@ -893 +893 @@
          *                            Default is 14 days from now.
          * @param int    $user_id     User ID.
-         * @param string $scheme      Authentication scheme. Values include 'auth', 'secure_auth', or 'logged_in'.
+         * @param string $scheme      Authentication scheme. Values include 'auth' or 'secure_auth'.
          * @param string $token       User's session token to use for this cookie.
          */
@@ -904 +904 @@
          * @since 4.9.0 The `$token` parameter was added.
          *
-         * @param string $logged_in_cookie The logged-in cookie.
+         * @param string $logged_in_cookie The logged-in cookie value.
          * @param int    $expire           The time the login grace period expires as a UNIX timestamp.
          *                                 Default is 12 hours past the cookie's expiration time.