Changeset 6573 for trunk/src/includes/users/functions.php

Timestamp:

06/16/2017 09:20:52 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Documentation: Remove all @uses usages.

Per the WordPress inline documentation standards:

the @uses tag is not recommended to be used to indicate a used-by relationship, as this information can be derived through other means. These tags also are very likely to become out-of-date as our functions change over time.

File:

• trunk/src/includes/users/functions.php (modified) (17 diffs)

trunk/src/includes/users/functions.php

@@ -19 +19 @@
  * @param string $raw_url Raw url
  * @param object $user User object
- * @uses is_wp_error() To check if the user param is a {@link WP_Error}
- * @uses admin_url() To get the admin url
- * @uses home_url() To get the home url
- * @uses esc_url() To escape the url
- * @uses bbp_redirect() To redirect
  */
 function bbp_redirect_login( $url = '', $raw_url = '', $user = '' ) {
@@ -49 +44 @@
  * @since 2.0.0 bbPress (r2688)
  *
- * @uses is_user_logged_in() Is the user logged in?
- * @uses bbp_allow_anonymous() Is anonymous posting allowed?
- * @uses apply_filters() Calls 'bbp_is_anonymous' with the return value
  * @return bool True if anonymous is allowed and user is not logged in, false if
  *               anonymous is not allowed or user is logged in
@@ -68 +60 @@
  *
  * @param string $key Which value to echo?
- * @uses bbp_get_current_anonymous_user_data() To get the current anonymous user
- *                                              data
  */
 function bbp_current_anonymous_user_data( $key = '' ) {
@@ -82 +72 @@
      * @param string $key Optional. Which value to get? If not given, then
      *                     an array is returned.
-     * @uses sanitize_comment_cookies() To sanitize the current poster data
-     * @uses wp_get_current_commenter() To get the current poster data   *
      * @return string|array Cookie(s) for current poster
      */
@@ -126 +114 @@
  *                              supply if supplying $author_id. Should be
  *                              sanitized (see {@link bbp_filter_anonymous_post_data()}
- * @uses apply_filters() Calls 'comment_cookie_lifetime' for cookie lifetime.
- *                        Defaults to 30000000.
  */
 function bbp_set_current_anonymous_user_data( $anonymous_data = array() ) {
@@ -193 +179 @@
  *
  * @param string $action The requested action to compare this function to
- * @uses is_multisite() To check if it's a multisite
- * @uses bbp_is_user_home() To check if the user is at home (the display page
- *                           is the one of the logged in user)
- * @uses get_option() To get the displayed user's new email id option
- * @uses wp_update_user() To update the user
- * @uses delete_option() To delete the displayed user's email id option
- * @uses bbp_get_user_profile_edit_url() To get the edit profile url
- * @uses bbp_redirect() To redirect to the url
- * @uses bbp_verify_nonce_request() To verify the nonce and check the request
- * @uses current_user_can() To check if the current user can edit the user
- * @uses do_action() Calls 'personal_options_update' or
- *                   'edit_user_options_update' (based on if it's the user home)
- *                   with the displayed user id
- * @uses edit_user() To edit the user based on the post data
- * @uses get_userdata() To get the user data
- * @uses is_email() To check if the string is an email id or not
- * @uses is_network_admin() To check if the user is the network admin
- * @uses revoke_super_admin() To revoke super admin privileges
- * @uses grant_super_admin() To grant super admin privileges
- * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
  */
 function bbp_edit_user_handler( $action = '' ) {
@@ -332 +298 @@
  *
  * @param string $action
- *
- * @uses bbp_is_user_home_edit()         To check if on the current users profile edit page
- * @uses bbp_get_displayed_user_id()     To get the ID of the user being edited
- * @uses bbp_get_user_profile_edit_url() To get the URL of the user being edited
- * @uses bbp_redirect()                  To redirect away from the current page
- * @uses hash_equals()                   To compare email hash to saved option hash
- * @uses email_exists()                  To check if user has email address already
- * @uses bbp_add_error()                 To add user feedback
- * @uses wp_update_user()                To update the user with their new email address
- * @uses bbp_verify_nonce_request()      To verify the intent of the user
  */
 function bbp_user_email_change_handler( $action = '' ) {
@@ -442 +398 @@
  *
  * @see send_confirmation_on_profile_email()
- *
- * @uses bbp_parse_args()                To parse the option arguments
- * @uses bbp_add_error()                 To provide feedback to user
- * @uses bbp_get_displayed_user_field()  To get the user_login
- * @uses bbp_get_user_profile_edit_url() To get the user profile edit link
- * @uses add_query_arg()                 To add arguments the link
- * @uses wp_mail()                       To send the notification
  */
 function bbp_edit_user_email_send_notification( $user_id = 0, $args = array() ) {
@@ -522 +471 @@
  *
  * @since 2.2.0 bbPress (r4273)
- *
- * @uses bbp_is_user_home_edit() To switch the action fired
- * @uses get_userdata() To get the current user's data
- * @uses bbp_get_displayed_user_id() To get the currently displayed user ID
  */
 function bbp_user_edit_after() {
@@ -541 +486 @@
  *
  * @param int $user_id Optional. User id
- * @uses bbp_get_user_id() To get the topic id
- * @uses bbp_has_topics() To get the topics created by the user
+ *
  * @return array|bool Results if the user has created topics, otherwise false
  */
@@ -568 +512 @@
  *
  * @param int $user_id Optional. User id
- * @uses bbp_get_user_id() To get the topic id
- * @uses bbp_has_replies() To get the topics created by the user
+ *
  * @return array|bool Results if the user has created topics, otherwise false
  */
@@ -674 +617 @@
  * @param int $user_id User ID to get count for
  *
- * @uses bbp_get_user_id()
- * @uses get_posts_by_author_sql()
- * @uses bbp_get_topic_post_type()
- * @uses apply_filters()
- *
  * @return int Raw DB count of topics
  */
@@ -701 +639 @@
  *
  * @param int $user_id User ID to get count for
- *
- * @uses bbp_get_user_id()
- * @uses get_posts_by_author_sql()
- * @uses bbp_get_reply_post_type()
- * @uses apply_filters()
  *
  * @return int Raw DB count of replies
@@ -759 +692 @@
  * @param int $user_id
  * @param int $difference
- * @uses bbp_get_user_topic_count() To get the users current topic count
- * @uses bbp_set_user_topic_count() To set the users new topic count
  */
 function bbp_bump_user_topic_count( $user_id = 0, $difference = 1 ) {
@@ -797 +728 @@
  * @param int $user_id
  * @param int $difference
- * @uses bbp_get_user_reply_count() To get the users current reply count
- * @uses bbp_set_user_reply_count() To set the users new reply count
  */
 function bbp_bump_user_reply_count( $user_id = 0, $difference = 1 ) {
@@ -900 +829 @@
  *
  * @since 2.1.0 bbPress (r3605)
- *
- * @uses bbp_is_single_user_edit()
- * @uses current_user_can()
- * @uses bbp_get_displayed_user_id()
- * @uses bbp_redirect()
- * @uses bbp_get_user_profile_url()
  */
 function bbp_check_user_edit() {
@@ -951 +874 @@
  *
  * @since 2.0.0 bbPress (r2996)
- *
- * @uses is_user_logged_in() To check if user is logged in
- * @uses bbp_is_user_keymaster() To check if user is a keymaster
- * @uses current_user_can() To check if the current user can spectate
- * @uses is_bbpress() To check if in a bbPress section of the site
- * @uses bbp_set_404() To set a 404 status
  */
 function bbp_forum_enforce_blocked() {