Changeset 10163 for trunk/src/bp-xprofile/bp-xprofile-actions.php

Timestamp:

10/01/2015 04:18:13 AM (10 years ago)

Author:

tw2113

Message:

First pass of documentation cleanup for the XProfile Component.

See #6406.

File:

• trunk/src/bp-xprofile/bp-xprofile-actions.php (modified) (8 diffs)

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

@@ -20 +20 @@
  * The function will delete the active avatar for a user.
  *
- * @package BuddyPress Xprofile
  * @uses bp_core_delete_avatar() Deletes the active avatar for the logged in user.
  * @uses add_action() Runs a specific function for an action when it fires.
@@ -30 +29 @@
     }
 
-    // Check the nonce
+    // Check the nonce.
     check_admin_referer( 'bp_delete_avatar_link' );
 
@@ -48 +47 @@
 
 /**
- * Handles the saving of xprofile field visibilities
+ * Handles the saving of xprofile field visibilities.
  *
  * @since 1.9.0
@@ -54 +53 @@
 function bp_xprofile_action_settings() {
 
-    // Bail if not a POST action
+    // Bail if not a POST action.
     if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
         return;
     }
 
-    // Bail if no submit action
+    // Bail if no submit action.
     if ( ! isset( $_POST['xprofile-settings-submit'] ) ) {
         return;
     }
 
-    // Bail if not in settings
+    // Bail if not in settings.
     if ( ! bp_is_user_settings_profile() ) {
         return;
@@ -75 +74 @@
     }
 
-    // Nonce check
+    // Nonce check.
     check_admin_referer( 'bp_xprofile_settings' );
 
@@ -87 +86 @@
     /** Save ******************************************************************/
 
-    // Only save if there are field ID's being posted
+    // Only save if there are field ID's being posted.
     if ( ! empty( $_POST['field_ids'] ) ) {
 
-        // Get the POST'ed field ID's
+        // Get the POST'ed field ID's.
         $posted_field_ids = explode( ',', $_POST['field_ids'] );
 
@@ -104 +103 @@
         }
 
-        // Save the visibility settings
+        // Save the visibility settings.
         foreach ( $posted_field_ids as $field_id ) {
 
@@ -126 +125 @@
     do_action( 'bp_xprofile_settings_after_save' );
 
-    // Redirect to the root domain
+    // Redirect to the root domain.
     bp_core_redirect( bp_displayed_user_domain() . bp_get_settings_slug() . '/profile' );
 }