Various inline documentation syntactical fixes in wp-includes/pluggable.php for 4.2 changes.

See #31888.

Built from https://develop.svn.wordpress.org/trunk@32045


git-svn-id: http://core.svn.wordpress.org/trunk@32024 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-04-05 16:46:26 +00:00
parent 156e3d14ed
commit 46cf634c90
2 changed files with 16 additions and 16 deletions

View File

@ -2123,7 +2123,7 @@ if ( !function_exists( 'get_avatar' ) ) :
* Retrieve the avatar `<img>` tag for a user, email address, MD5 hash, comment, or post. * Retrieve the avatar `<img>` tag for a user, email address, MD5 hash, comment, or post.
* *
* @since 2.5.0 * @since 2.5.0
* @since 4.2.0 Optional $args parameter added. * @since 4.2.0 Optional `$args` parameter added.
* *
* @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash, * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
* user email, WP_User object, WP_Post object, or comment object. * user email, WP_User object, WP_Post object, or comment object.
@ -2143,7 +2143,7 @@ if ( !function_exists( 'get_avatar' ) ) :
* @type bool $force_default Whether to always show the default image, never the Gravatar. Default false. * @type bool $force_default Whether to always show the default image, never the Gravatar. Default false.
* @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are * @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
* judged in that order. Default is the value of the 'avatar_rating' option. * judged in that order. Default is the value of the 'avatar_rating' option.
* @type string $scheme URL scheme to use. See {@see set_url_scheme()} for accepted values. * @type string $scheme URL scheme to use. See set_url_scheme() for accepted values.
* Default null. * Default null.
* @type array|string $class Array or string of additional classes to add to the &lt;img&gt; element. * @type array|string $class Array or string of additional classes to add to the &lt;img&gt; element.
* Default null. * Default null.
@ -2151,7 +2151,6 @@ if ( !function_exists( 'get_avatar' ) ) :
* Default false. * Default false.
* @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. Default empty. * @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
* } * }
*
* @return false|string `<img>` tag for the user's avatar. False on failure. * @return false|string `<img>` tag for the user's avatar. False on failure.
*/ */
function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args = null ) { function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args = null ) {
@ -2190,16 +2189,17 @@ function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args =
/** /**
* Filter whether to retrieve the avatar URL early. * Filter whether to retrieve the avatar URL early.
* *
* Passing a non-null value will effectively short-circuit {@see get_avatar()}, * Passing a non-null value will effectively short-circuit get_avatar(), passing
* passing the value through the 'pre_get_avatar' filter and returning early. * the value through the {@see 'pre_get_avatar'} filter and returning early.
* *
* @since 4.2.0 * @since 4.2.0
* *
* @param string $avatar HTML for the user's avatar. Default null. * @param string $avatar HTML for the user's avatar. Default null.
* @param int|object|string $id_or_email A user ID, email address, or comment object. * @param int|object|string $id_or_email A user ID, email address, or comment object.
* @param array $args Arguments passed to get_avatar_url(), after processing. * @param array $args Arguments passed to get_avatar_url(), after processing.
*/ */
$avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args ); $avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );
if ( ! is_null( $avatar ) ) { if ( ! is_null( $avatar ) ) {
/** This filter is documented in wp-includes/pluggable.php */ /** This filter is documented in wp-includes/pluggable.php */
return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args ); return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
@ -2248,14 +2248,14 @@ function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args =
* Filter the avatar to retrieve. * Filter the avatar to retrieve.
* *
* @since 2.5.0 * @since 2.5.0
* @since 4.2.0 $args parameter added * @since 4.2.0 The `$args` parameter was added.
* *
* @param string $avatar &lt;img&gt; tag for the user's avatar. * @param string $avatar &lt;img&gt; tag for the user's avatar.
* @param int|object|string $id_or_email A user ID, email address, or comment object. * @param int|object|string $id_or_email A user ID, email address, or comment object.
* @param int $size Square avatar width and height in pixels to retrieve. * @param int $size Square avatar width and height in pixels to retrieve.
* @param string $alt Alternative text to use in the avatar image tag. * @param string $alt Alternative text to use in the avatar image tag.
* Default empty. * Default empty.
* @param array $args Arguments passed to get_avatar_data(), after processing. * @param array $args Arguments passed to get_avatar_data(), after processing.
*/ */
return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args ); return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
} }

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.2-beta4-32044'; $wp_version = '4.2-beta4-32045';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.