From f90a37805d9b7b5bdf626fb2834f4f819cf92b92 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 25 Feb 2016 05:06:39 +0000 Subject: [PATCH] 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 --- src/wp-includes/pluggable.php | 1 + src/wp-includes/user.php | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php index 8784ed071f..5a3a526266 100644 --- a/src/wp-includes/pluggable.php +++ b/src/wp-includes/pluggable.php @@ -60,6 +60,7 @@ if ( !function_exists('wp_get_current_user') ) : * * @since 2.0.3 * + * @see _wp_get_current_user() * @global WP_User $current_user Checks if the current user is set. * * @return WP_User Current WP_User instance. diff --git a/src/wp-includes/user.php b/src/wp-includes/user.php index 64f256f570..c5c3bf2b89 100644 --- a/src/wp-includes/user.php +++ b/src/wp-includes/user.php @@ -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 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. * - * This function is used by the pluggable functions {@see wp_get_current_user()} - * and {@see get_currentuserinfo()}, which is deprecated, for backward compatibility. + * This function is used by the pluggable functions wp_get_current_user() and + * get_currentuserinfo(), which is deprecated, for backward compatibility. * * @since 4.5.0 * @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. * * @return WP_User Current WP_User instance.