Ticket #5944: bp-members-admin-5944.diff

src/bp-members/bp-members-admin.php

@@ -552 +552 @@
 
                 $min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
                 $css = $this->css_url . "admin{$min}.css";
+
+                /**
+                 * Filters the css url to enqueue in the Members admin area.
+                 *
+                 * This filter is a variable filter that is dependent on if SCRIPT_DEBUG
+                 * is defined and set to true. If not, the css file will have '.min' in
+                 * the file name.
+                 *
+                 * @since BuddyPress (2.0.0)
+                 *
+                 * @param string $css URL to the CSS admin file to load.
+                 */
                 $css = apply_filters( 'bp_members_admin_css', $css );
 
                 wp_enqueue_style( 'bp-members-css', $css, array(), bp_get_version() );
@@ -564 +576 @@
                 // Only load javascript for BuddyPress profile
                 if ( get_current_screen()->id == $this->user_page ) {
                         $js = $this->js_url . "admin{$min}.js";
+
+                        /**
+                         * Filters the js url to enqueue in the Members admin area.
+                         *
+                         * This filter is a variable filter that is dependent on if SCRIPT_DEBUG
+                         * is defined and set to true. If not, the js file will have '.min' in
+                         * the file name.
+                         *
+                         * @since BuddyPress (2.0.0)
+                         *
+                         * @param string $js URL to the JavaScript admin file to load.
+                         */
                         $js = apply_filters( 'bp_members_admin_js', $js );
                         wp_enqueue_script( 'bp-members-js', $js, array( 'jquery' ), bp_get_version(), true );
                 }
 
-                // Plugins may want to hook here to load some css/js
+                /**
+                 * Fires after all of the members javascript and css is enqueued.
+                 *
+                 * @since BuddyPress (2.0.0)
+                 *
+                 * @param string $id        ID of the current screen.
+                 * @param array  $screen_id Array of allowed screens to add scripts and styles to.
+                 */
                 do_action( 'bp_members_admin_enqueue_scripts', get_current_screen()->id, $this->screen_id );
         }
 
@@ -659 +690 @@
                         }
                 }
 
-                // Call an action for plugins to hook in early
+                /**
+                 * Fires at the start of the signups admin load.
+                 *
+                 * @since BuddyPress (2.0.0)
+                 *
+                 * @param string $doaction Current bulk action being processed.
+                 * @param array  $_REQUEST Current $_REQUEST global.
+                 */
                 do_action_ref_array( 'bp_members_admin_load', array( $doaction, $_REQUEST ) );
 
-                // Allowed actions
+                /**
+                 * Filters the allowed actions for use in the user admin page.
+                 *
+                 * @since BuddyPress (2.0.0)
+                 *
+                 * @param array $value Array of allowed actions to use.
+                 */
                 $allowed_actions = apply_filters( 'bp_members_admin_allowed_actions', array( 'update', 'delete_avatar', 'spam', 'ham' ) );
 
                 // Prepare the display of the Community Profile screen
@@ -700 +744 @@
                         $this->stats_metabox->priority = 'core';
 
                         /**
-                         * xProfile Hooks to load the profile fields if component is active
-                         * Plugins should not use this hook, please use 'bp_members_admin_user_metaboxes' instead
+                         * Fires before loading the profile fields if component is active.
+                         *
+                         * Plugins should not use this hook, please use 'bp_members_admin_user_metaboxes' instead.
+                         *
+                         * @since BuddyPress (2.0.0)
+                         *
+                         * @param int    $user_id       Current user ID for the screen.
+                         * @param string $id            Current screen ID.
+                         * @param object $stats_metabox Object holding position data for use with the stats metabox.
                          */
                         do_action_ref_array( 'bp_members_admin_xprofile_metabox', array( $user_id, get_current_screen()->id, $this->stats_metabox ) );
 
@@ -736 +787 @@
                         }
 
                         /**
-                         * Custom metabox ?
-                         * Plugins can restrict metabox to "bp_moderate" admins checking
-                         * the first argument ($this->is_self_profile) is false in their hook
-                         * They can also restruct their metabox to self profile editing
-                         * by cheking it set to true.
+                         * Fires at the end of the Community Profile screen.
+                         *
+                         * Plugins can restrict metabox to "bp_moderate" admins by checking if
+                         * the first argument ($this->is_self_profile) is false in their callback.
+                         * They can also restrict their metabox to self profile editing
+                         * by setting it to true.
+                         *
+                         * @since BuddyPress (2.0.0)
+                         *
+                         * @param bool $is_self_profile Whether or not it is the current user's profile.
+                         * @param int  $user_id         Current user ID.
                          */
                         do_action( 'bp_members_admin_user_metaboxes', $this->is_self_profile, $user_id );
 
@@ -765 +822 @@
                 } else {
                         $this->redirect = $redirect_to;
 
+                        /**
+                         * Fires at the end of the user profile admin load if the doaction
+                         * does not match any available actions.
+                         *
+                         * @since BuddyPress (2.0.0)
+                         *
+                         * @param string $doaction Current bulk action being processed.
+                         * @param int    $user_id  Current user ID.
+                         * @param array  $_REQUEST Current $_REQUEST global.
+                         * @param string $redirect Determined redirect url to send user to.
+                         */
                         do_action_ref_array( 'bp_members_admin_update_user', array( $doaction, $user_id, $_REQUEST, $this->redirect ) );
 
                         bp_core_redirect( $this->redirect );
@@ -1005 +1073 @@
                         <?php
                         // Loading other stats only if user has activated their account
                         if ( empty( $user->user_status ) ) {
+
+                                /**
+                                 * Fires in the user stats metabox if the user has activated their account.
+
+                                 * @since BuddyPress (2.0.0)
+                                 *
+                                 * @param array  $value Array holding the user ID.
+                                 * @param object $user  Current displayed user object.
+                                 */
                                 do_action( 'bp_members_admin_user_stats', array( 'user_id' => $user->ID ), $user );
                         }
                         ?>
@@ -1315 +1392 @@
                 $redirect_to = remove_query_arg( array( 'action', 'error', 'updated', 'activated', 'notactivated', 'deleted', 'notdeleted', 'resent', 'notresent', 'do_delete', 'do_resend', 'do_activate', '_wpnonce', 'signup_ids' ), $_SERVER['REQUEST_URI'] );
                 $doaction    = bp_admin_list_table_current_bulk_action();
 
-                // Call an action for plugins to hook in early
+                /**
+                 * Fires at the start of the signups admin load.
+                 *
+                 * @since BuddyPress (2.0.0)
+                 *
+                 * @param string $doaction Current bulk action being processed.
+                 * @param array  $_REQUEST Current $_REQUEST global.
+                 */
                 do_action( 'bp_signups_admin_load', $doaction, $_REQUEST );
 
-                // Allowed actions
+                /**
+                 * Filters the allowed actions for use in the user signups admin page.
+                 *
+                 * @since BuddyPress (2.0.0)
+                 *
+                 * @param array $value Array of allowed actions to use.
+                 */
                 $allowed_actions = apply_filters( 'bp_signups_admin_allowed_actions', array( 'do_delete', 'do_activate', 'do_resend' ) );
 
                 // Prepare the display of the Community Profile screen
@@ -1449 +1539 @@
                         } else {
                                 $this->redirect = $redirect_to;
 
+                                /**
+                                 * Fires at the end of the signups admin load if the doaction
+                                 * does not match any actions.
+                                 *
+                                 * @since BuddyPress (2.0.0)
+                                 *
+                                 * @param string $doaction Current bulk action being processed.
+                                 * @param array  $_REQUEST Current $_REQUEST global.
+                                 * @param string $redirect Determined redirect url to send user to.
+                                 */
                                 do_action( 'bp_members_admin_update_signups', $doaction, $_REQUEST, $this->redirect );
 
                                 bp_core_redirect( $this->redirect );