Changeset 9298

Timestamp:

01/06/2015 02:57:43 AM (12 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-xprofile-admin.php.

See #5949.

File:

• trunk/src/bp-xprofile/bp-xprofile-admin.php (modified) (13 diffs)

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

@@ -120 +120 @@
                                                                 <?php endif; ?>
 
-                                                                <?php do_action( 'xprofile_admin_group_action', $group ); ?>
+                                                                <?php
+
+                                                                /**
+                                                                 * Fires at end of action buttons in xprofile management admin.
+                                                                 *
+                                                                 * @since BuddyPress (2.2.0)
+                                                                 *
+                                                                 * @param BP_XProfile_Group $group BP_XProfile_Group object
+                                                                 *                                 for the current group.
+                                                                 */
+                                                                do_action( 'xprofile_admin_group_action', $group ); ?>
 
                                                         </div>
@@ -198 +208 @@
                                         bp_update_option( 'bp-xprofile-base-group-name', $group->name );
 
+                                /**
+                                 * Fires at the end of the group adding/saving process, if successful.
+                                 *
+                                 * @since BuddyPress (1.0.0)
+                                 *
+                                 * @param BP_XProfile_Group $group Current BP_XProfile_Group object.
+                                 */
                                 do_action( 'xprofile_groups_saved_group', $group );
                         }
@@ -227 +244 @@
                 $type    = 'success';
 
+                /**
+                 * Fires at the end of group deletion process, if successful.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param BP_XProfile_Group $group Current BP_XProfile_Group object.
+                 */
                 do_action( 'xprofile_groups_deleted_group', $group );
         }
@@ -288 +312 @@
                                 unset( $_GET['mode'] );
 
+                                /**
+                                 * Fires at the end of the process to save a field for a user, if successful.
+                                 *
+                                 * @since BuddyPress (1.0.0)
+                                 *
+                                 * @param BP_XProfile_Field $field Current BP_XProfile_Field object.
+                                 */
                                 do_action( 'xprofile_fields_saved_field', $field );
 
@@ -304 +335 @@
  * Handles the deletion of a profile field (or field option)
  *
- * @since BuddyPress (1.0)
+ * @since BuddyPress (1.0.0)
  * @global string $message The feedback message to show
  * @global $type The type of feedback message to show
@@ -326 +357 @@
                 $type    = 'success';
 
+                /**
+                 * Fires at the end of the field deletion process, if successful.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param BP_XProfile_Field $field Current BP_XProfile_Field object.
+                 */
                 do_action( 'xprofile_fields_deleted_field', $field );
         }
@@ -387 +425 @@
                                 <?php if ( ! $field->can_delete ) : ?> <?php _e( '(Primary)', 'buddypress' ); endif; ?>
                                 <?php if ( bp_get_the_profile_field_is_required() ) : ?><?php _e( '(Required)', 'buddypress' ) ?><?php endif; ?>
-                                <?php do_action( 'xprofile_admin_field_name_legend', $field ); ?>
+                                <?php
+
+                                /**
+                                 * Fires at end of legend above the name field in base xprofile group.
+                                 *
+                                 * @since BuddyPress (2.2.0)
+                                 *
+                                 * @param BP_XProfile_Field $field Current BP_XProfile_Field
+                                 *                                 object being rendered.
+                                 */
+                                do_action( 'xprofile_admin_field_name_legend', $field ); ?>
                         </span>
                 </legend>
@@ -396 +444 @@
                                 $field_type = bp_xprofile_create_field_type( $field->type );
                                 $field_type->admin_field_html();
-
                         } else {
+
+                                /**
+                                 * Fires after the input if the current field is not in default field types.
+                                 *
+                                 * @since BuddyPress (1.5.0)
+                                 *
+                                 * @param BP_XProfile_Field $field Current BP_XProfile_Field
+                                 *                                 object being rendered.
+                                 * @param int               $value Integer 1.
+                                 */
                                 do_action( 'xprofile_admin_field', $field, 1 );
                         }
@@ -419 +476 @@
                                 <?php endif; ?>
 
-                                <?php do_action( 'xprofile_admin_field_action', $field ); ?>
+                                <?php
+
+                                /**
+                                 * Fires at end of field management links in xprofile management admin.
+                                 *
+                                 * @since BuddyPress (2.2.0)
+                                 *
+                                 * @param BP_XProfile_Group $group BP_XProfile_Group object
+                                 *                                 for the current group.
+                                 */
+                                do_action( 'xprofile_admin_field_action', $field ); ?>
 
                         </div>
@@ -695 +762 @@
                                         $errors = true;
                                 } else {
+
+                                        /**
+                                         * Fires after the saving of each profile field, if successful.
+                                         *
+                                         * @since BuddyPress (1.1.0)
+                                         *
+                                         * @param int    $field_id ID of the field being updated.
+                                         * @param string $value    Value that was saved to the field.
+                                         */
                                         do_action( 'xprofile_profile_field_data_updated', $field_id, $value );
                                 }
@@ -703 +779 @@
                         }
 
+                        /**
+                         * Fires after all of the profile fields have been saved.
+                         *
+                         * @since BuddyPress (1.0.0)
+                         *
+                         * @param int   $user_id          ID of the user whose data is being saved.
+                         * @param array $posted_field_ids IDs of the fields that were submitted.
+                         * @param bool  $errors           Whether or not errors occurred during saving.
+                         */
                         do_action( 'xprofile_updated_profile', $user_id, $posted_field_ids, $errors );
 
@@ -772 +857 @@
                                         <?php endif;
 
+                                        /**
+                                         * Fires before display of visibility form elements for profile metaboxes.
+                                         *
+                                         * @since BuddyPress (1.7.0)
+                                         */
                                         do_action( 'bp_custom_profile_edit_fields_pre_visibility' );
 
@@ -801 +891 @@
                                         <?php endif; ?>
 
-                                        <?php do_action( 'bp_custom_profile_edit_fields' ); ?>
+                                        <?php
+
+                                        /**
+                                         * Fires at end of custom profile field items on your xprofile screen tab.
+                                         *
+                                         * @since BuddyPress (1.1.0)
+                                         */
+                                        do_action( 'bp_custom_profile_edit_fields' ); ?>
 
                                 </div>