sergiotarxz/Wordpress
sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Correct and improve some docblocks.

Browse Source 
See #42505


git-svn-id: https://develop.svn.wordpress.org/trunk@43642 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2018-09-14 13:34:50 +00:00
parent ffa16fa771
commit b2374bf1ad
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/wp-admin/includes/media.php
View File

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

6
src/wp-includes/pluggable.php
View File

@ -886,13 +886,13 @@ if ( ! function_exists( 'wp_set_auth_cookie' ) ) :
* @since 2.5.0 * @since 2.5.0
* @since 4.9.0 The `$token` parameter was added. * @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. * @param int $expire The time the login grace period expires as a UNIX timestamp.
* Default is 12 hours past the cookie's expiration time. * Default is 12 hours past the cookie's expiration time.
* @param int $expiration The time when the authentication cookie expires as a UNIX timestamp. * @param int $expiration The time when the authentication cookie expires as a UNIX timestamp.
* Default is 14 days from now. * Default is 14 days from now.
* @param int $user_id User ID. * @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. * @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 ); 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 2.6.0
* @since 4.9.0 The `$token` parameter was added. * @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. * @param int $expire The time the login grace period expires as a UNIX timestamp.
* Default is 12 hours past the cookie's expiration time. * 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. * @param int $expiration The time when the logged-in authentication cookie expires as a UNIX timestamp.