Changeset 9303 for trunk/src/bp-xprofile/bp-xprofile-functions.php

Timestamp:

01/06/2015 06:06:08 AM (12 years ago)

Author:

tw2113

Message:

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

See #5949.

File:

• trunk/src/bp-xprofile/bp-xprofile-functions.php (modified) (12 diffs)

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

@@ -33 +33 @@
         $groups = BP_XProfile_Group::get( $args );
 
+        /**
+         * Filters a set of field groups, populated with fields and field data.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param array $groups Array of field groups and field data.
+         * @param array $args   Array of arguments used to query for groups.
+         */
         return apply_filters( 'bp_xprofile_get_groups', $groups, $args );
 }
@@ -147 +155 @@
         );
 
-        // If you've added a custom field type in a plugin, register it with this filter.
+        /**
+         * Filters the list of all xprofile field types.
+         *
+         * If you've added a custom field type in a plugin, register it with this filter.
+         *
+         * @since BuddyPress (2.0.0)
+         *
+         * @param array $fields Array of field type/class name pairings.
+         */
         return apply_filters( 'bp_xprofile_get_field_types', $fields );
 }
@@ -331 +347 @@
                 $data = array();
                 foreach( (array) $values as $value ) {
+
+                        /**
+                         * Filters the field data value for a specific field for the user.
+                         *
+                         * @since BuddyPress (1.0.0)
+                         *
+                         * @param string $value    Value saved for the field.
+                         * @param int    $field_id ID of the field being displayed.
+                         * @param int    $user_id  ID of the user being displayed.
+                         */
                         $data[] = apply_filters( 'xprofile_get_field_data', $value, $field_id, $user_id );
                 }
@@ -338 +364 @@
                 }
         } else {
+                /** This filter is documented in bp-xprofile/bp-xprofile-functions.php */
                 $data = apply_filters( 'xprofile_get_field_data', $values, $field_id, $user_id );
         }
@@ -564 +591 @@
         }
 
+        /**
+         * Filters a random piece of profile data for the user.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param array $field_data Array holding random profile data.
+         */
         return apply_filters( 'xprofile_get_random_profile_data', $field_data );
 }
@@ -659 +693 @@
         $newsubdir = '/' . $directory. '/' . $user_id;
 
+        /**
+         * Filters the avatar upload directory for a user.
+         *
+         * @since BuddyPress (1.1.0)
+         *
+         * @param array $value Array containing the path, URL, and other helpful settings.
+         */
         return apply_filters( 'xprofile_avatar_upload_dir', array(
                 'path'    => $path,
@@ -959 +1000 @@
  *
  * @package BuddyPress
- * @since BuddyPress (1.5)
+ * @since BuddyPress (1.5.0)
  *
  * @return string The field name
  */
 function bp_xprofile_fullname_field_name() {
+
+        /**
+         * Filters the field name for the Full Name xprofile field.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param string BP_XPROFILE_FULLNAME_FIELD_NAME Full name field constant.
+         */
         return apply_filters( 'bp_xprofile_fullname_field_name', BP_XPROFILE_FULLNAME_FIELD_NAME );
 }
@@ -975 +1024 @@
         global $bp;
 
+        /**
+         * Filters the visibility levels out of the $bp global.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array $visibility_levels Array of visibility levels.
+         */
         return apply_filters( 'bp_xprofile_get_visibility_levels', $bp->profile->visibility_levels );
 }
@@ -986 +1042 @@
  * be excluded from the profile loop.
  *
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  * @see BP_XProfile_Group::get()
  * @uses apply_filters() Filter bp_xprofile_get_hidden_fields_for_user to modify visibility levels,
@@ -1012 +1068 @@
         $hidden_fields = bp_xprofile_get_fields_by_visibility_levels( $displayed_user_id, $hidden_levels );
 
+        /**
+         * Filters the ids of fields that are hidden for this displayed/loggedin user pair.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array $hidden_fields     Array of hidden fields for the displayed/logged in user.
+         * @param int   $displayed_user_id ID of the displayed user.
+         * @param int   $current_user_id   ID of the current user.
+         */
         return apply_filters( 'bp_xprofile_get_hidden_fields_for_user', $hidden_fields, $displayed_user_id, $current_user_id );
 }
@@ -1055 +1120 @@
         }
 
+        /**
+         * Filters the visibility levels that should be hidden for this user pair.
+         *
+         * @since BuddyPress (2.0.0)
+         *
+         * @param array $hidden_fields     Array of hidden fields for the displayed/logged in user.
+         * @param int   $displayed_user_id ID of the displayed user.
+         * @param int   $current_user_id   ID of the current user.
+         */
         return apply_filters( 'bp_xprofile_get_hidden_field_types_for_user', $hidden_levels, $displayed_user_id, $current_user_id );
 }
@@ -1061 +1135 @@
  * Fetch an array of the xprofile fields that a given user has marked with certain visibility levels
  *
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  * @see bp_xprofile_get_hidden_fields_for_user()
  *