Changeset 9215 for trunk/src/bp-settings/bp-settings-actions.php

Timestamp:

12/06/2014 09:19:03 PM (12 years ago)

Author:

tw2113

Message:

Add hook documentation for the Settings component.

Fixes #5947

File:

• trunk/src/bp-settings/bp-settings-actions.php (modified) (6 diffs)

trunk/src/bp-settings/bp-settings-actions.php

@@ -129 +129 @@
                                          * @since BuddyPress (2.1.0)
                                          *
-                                         * @param string $email_text Text of the email.
-                                         * @param string $new_user_email New user email that
-                                         *        the current user has changed to.
-                                         * @param string $old_user_email Existing email addres
-                                         *        for the current user.
-                                         * @param object $update_user Userdata for the current user.
+                                         * @param string  $email_text     Text of the email.
+                                         * @param string  $new_user_email New user email that the
+                                         *                                current user has changed to.
+                                         * @param string  $old_user_email Existing email address
+                                         *                                for the current user.
+                                         * @param WP_User $update_user    Userdata object for the current user.
                                          */
                                         $content = apply_filters( 'bp_new_user_email_content', $email_text, $user_email, $old_user_email, $update_user );
@@ -258 +258 @@
         bp_core_add_message( implode( '</p><p>', $feedback ), $feedback_type );
 
-        // Execute additional code
+        /**
+         * Fires after the general settings have been saved, and before redirect.
+         *
+         * @since BuddyPress (1.5.0)
+         */
         do_action( 'bp_core_general_settings_after_save' );
 
@@ -304 +308 @@
         }
 
+        /**
+         * Fires after the notificaton settings have been saved, and before redirect.
+         *
+         * @since BuddyPress (1.5.0)
+         */
         do_action( 'bp_core_notification_settings_after_save' );
 
@@ -342 +351 @@
         check_admin_referer( 'capabilities' );
 
+        /**
+         * Fires before the capabilities settings have been saved.
+         *
+         * @since BuddyPress (1.6.0)
+         */
         do_action( 'bp_settings_capabilities_before_save' );
 
@@ -351 +365 @@
                 $status = ( true == $is_spammer ) ? 'spam' : 'ham';
                 bp_core_process_spammer_status( bp_displayed_user_id(), $status );
+
+                /**
+                 * Fires after processing a user as a spammer.
+                 *
+                 * @since BuddyPress (1.1.0)
+                 *
+                 * @param int    $value  ID of the currently displayed user.
+                 * @param string $status Determined status of "spam" or "ham" for the displayed user.
+                 */
                 do_action( 'bp_core_action_set_spammer_status', bp_displayed_user_id(), $status );
         }
@@ -356 +379 @@
         /** Other *************************************************************/
 
+        /**
+         * Fires after the capabilities settings have been saved and before redirect.
+         *
+         * @since BuddyPress (1.6.0)
+         */
         do_action( 'bp_settings_capabilities_after_save' );