Docs: Make a few syntactical improvements to the DocBlock for _wp_get_current_user(), introduced in [36651].

Includes a cross reference from the DocBlock for `wp_get_current_user()`, which itself is pluggable, but the new internal function is not.

See #19615. See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@36705 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-02-25 05:06:39 +00:00
parent 4acfd64d93
commit f90a37805d
2 changed files with 5 additions and 4 deletions

View File

@ -60,6 +60,7 @@ if ( !function_exists('wp_get_current_user') ) :
* *
* @since 2.0.3 * @since 2.0.3
* *
* @see _wp_get_current_user()
* @global WP_User $current_user Checks if the current user is set. * @global WP_User $current_user Checks if the current user is set.
* *
* @return WP_User Current WP_User instance. * @return WP_User Current WP_User instance.

View File

@ -2408,19 +2408,19 @@ function wp_get_users_with_no_role() {
} }
/** /**
* Retrieve the current user object. * Retrieves the current user object.
* *
* Will set the current user, if the current user is not set. The current user * Will set the current user, if the current user is not set. The current user
* will be set to the logged-in person. If no user is logged-in, then it will * will be set to the logged-in person. If no user is logged-in, then it will
* set the current user to 0, which is invalid and won't have any permissions. * set the current user to 0, which is invalid and won't have any permissions.
* *
* This function is used by the pluggable functions {@see wp_get_current_user()} * This function is used by the pluggable functions wp_get_current_user() and
* and {@see get_currentuserinfo()}, which is deprecated, for backward compatibility. * get_currentuserinfo(), which is deprecated, for backward compatibility.
* *
* @since 4.5.0 * @since 4.5.0
* @access private * @access private
* *
* @see https://core.trac.wordpress.org/ticket/19615 * @see wp_get_current_user()
* @global WP_User $current_user Checks if the current user is set. * @global WP_User $current_user Checks if the current user is set.
* *
* @return WP_User Current WP_User instance. * @return WP_User Current WP_User instance.