From 8992656b133a672f90ab5da0adfa8f27ac8d6a0a Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Fri, 14 Sep 2018 13:35:25 +0000 Subject: [PATCH] Docs: Correct and improve some docblocks. See #42505 Built from https://develop.svn.wordpress.org/trunk@43642 git-svn-id: http://core.svn.wordpress.org/trunk@43471 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/media.php | 18 +++++++++--------- wp-includes/pluggable.php | 6 +++--- wp-includes/version.php | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php index e6fc3d558e..93eceeca3a 100644 --- a/wp-admin/includes/media.php +++ b/wp-admin/includes/media.php @@ -170,15 +170,15 @@ function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $re * * @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 = '' ) { diff --git a/wp-includes/pluggable.php b/wp-includes/pluggable.php index 58dd365146..703598bbb6 100644 --- a/wp-includes/pluggable.php +++ b/wp-includes/pluggable.php @@ -886,13 +886,13 @@ if ( ! function_exists( 'wp_set_auth_cookie' ) ) : * @since 2.5.0 * @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. * @param int $expiration The time when the authentication cookie expires as a UNIX timestamp. * 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. */ do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme, $token ); @@ -903,7 +903,7 @@ if ( ! function_exists( 'wp_set_auth_cookie' ) ) : * @since 2.6.0 * @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. * @param int $expiration The time when the logged-in authentication cookie expires as a UNIX timestamp. diff --git a/wp-includes/version.php b/wp-includes/version.php index 4b7bbdb212..6db9e89976 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '5.0-alpha-43641'; +$wp_version = '5.0-alpha-43642'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.