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

Timestamp:

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

Author:

tw2113

Message:

First pass of documentation cleanup for the XProfile Component.

See #6406.

File:

• trunk/src/bp-xprofile/bp-xprofile-settings.php (modified) (4 diffs)

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

@@ -11 +11 @@
 
 /**
- * Query all profile fields and their visibility data for display in settings
+ * Query all profile fields and their visibility data for display in settings.
  *
  * @since 2.0.0
  *
- * @param array $args
+ * @param array|string $args Array of args for the settings fields.
  *
  * @return array
@@ -21 +21 @@
 function bp_xprofile_get_settings_fields( $args = '' ) {
 
-    // Parse the possible arguments
+    // Parse the possible arguments.
     $r = bp_parse_args( $args, array(
         'user_id'                => bp_displayed_user_id(),
@@ -38 +38 @@
 
 /**
- * Adds feedback messages when successfully saving profile field settings
+ * Adds feedback messages when successfully saving profile field settings.
  *
  * @since 2.0.0
@@ -47 +47 @@
 function bp_xprofile_settings_add_feedback_message() {
 
-    // Default message type is success
+    // Default message type is success.
     $type    = 'success';
     $message = __( 'Your profile settings have been saved.',        'buddypress' );
 
-    // Community moderator editing another user's settings
+    // Community moderator editing another user's settings.
     if ( ! bp_is_my_profile() && bp_core_can_edit_settings() ) {
         $message = __( "This member's profile settings have been saved.", 'buddypress' );
     }
 
-    // Add the message
+    // Add the message.
     bp_core_add_message( $message, $type );
 }