Changeset 9290

Timestamp:

12/29/2014 10:28:28 PM (12 years ago)

Author:

tw2113

Message:

Add hooks docs to bp-xprofile-screens.php.

See #5949.

File:

• trunk/src/bp-xprofile/bp-xprofile-screens.php (modified) (6 diffs)

trunk/src/bp-xprofile/bp-xprofile-screens.php

@@ -24 +24 @@
         $new = isset( $_GET['new'] ) ? $_GET['new'] : '';
 
+        /**
+         * Fires right before the loading of the XProfile screen template file.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $new $_GET parameter holding the "new" parameter.
+         */
         do_action( 'xprofile_screen_display_profile', $new );
+
+        /**
+         * Filters the template to load for the XProfile screen.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $template Path to the XProfile template to load.
+         */
         bp_core_load_template( apply_filters( 'xprofile_template_display_profile', 'members/single/home' ) );
 }
@@ -132 +147 @@
                                         $errors = true;
                                 } else {
+
+                                        /**
+                                         * Fires on each iteration of an XProfile field being saved with no error.
+                                         *
+                                         * @since BuddyPress (1.1.0)
+                                         *
+                                         * @param int    $field_id ID of the field that was saved.
+                                         * @param string $value    Value that was saved to the field.
+                                         */
                                         do_action( 'xprofile_profile_field_data_updated', $field_id, $value );
                                 }
                         }
 
+                        /**
+                         * Fires after all XProfile fields have been saved for the current profile.
+                         *
+                         * @since BuddyPress (1.0.0)
+                         *
+                         * @param int   $value            Displayed user ID.
+                         * @param array $posted_field_ids Array of field IDs that were edited.
+                         * @param bool  $errors           Whether or not any errors occurred.
+                         * @param array $old_values       Array of original values before updated.
+                         * @param array $new_values       Array of newly saved values after update.
+                         */
                         do_action( 'xprofile_updated_profile', bp_displayed_user_id(), $posted_field_ids, $errors, $old_values, $new_values );
 
@@ -150 +185 @@
         }
 
+        /**
+         * Fires right before the loading of the XProfile edit screen template file.
+         *
+         * @since BuddyPress (1.0.0)
+         */
         do_action( 'xprofile_screen_edit_profile' );
+
+        /**
+         * Filters the template to load for the XProfile edit screen.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $template Path to the XProfile edit template to load.
+         */
         bp_core_load_template( apply_filters( 'xprofile_template_edit_profile', 'members/single/home' ) );
 }
@@ -212 +260 @@
                         bp_core_add_message( __( 'There was a problem cropping your profile photo.', 'buddypress' ), 'error' );
                 } else {
+
+                        /**
+                         * Fires right before the redirect, after processing a new avatar.
+                         *
+                         * @since BuddyPress (1.1.0)
+                         */
                         do_action( 'xprofile_avatar_uploaded' );
                         bp_core_add_message( __( 'Your new profile photo was uploaded successfully.', 'buddypress' ) );
@@ -218 +272 @@
         }
 
+        /**
+         * Fires right before the loading of the XProfile change avatar screen template file.
+         *
+         * @since BuddyPress (1.0.0)
+         */
         do_action( 'xprofile_screen_change_avatar' );
 
+        /**
+         * Filters the template to load for the XProfile change avatar screen.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $template Path to the XProfile change avatar template to load.
+         */
         bp_core_load_template( apply_filters( 'xprofile_template_change_avatar', 'members/single/home' ) );
 }
@@ -236 +302 @@
         }
 
-        // Load the template
+        /**
+         * Filters the template to load for the XProfile settings screen.
+         *
+         * @since BuddyPress (2.0.0)
+         *
+         * @param string $template Path to the XProfile change avatar template to load.
+         */
         bp_core_load_template( apply_filters( 'bp_settings_screen_xprofile', '/members/single/settings/profile' ) );
 }