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

Timestamp:

09/25/2015 12:18:18 AM (9 years ago)

Author:

tw2113

Message:

Standardizing our @since tags for the XProfile component.

See #6576.

File:

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

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

@@ -1 +1 @@
 <?php
-
-/**
- * BuddyPress XProfile Filters
+/**
+ * BuddyPress XProfile Filters.
  *
  * Business functions are where all the magic happens in BuddyPress. They will
@@ -10 +9 @@
  *
  * @package BuddyPress
- * @subpackage XProfileFilters
- */
-
-// Exit if accessed directly
+ * @subpackage XProfileFunctions
+ */
+
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -23 +22 @@
  * Procedural wrapper for BP_XProfile_Group::get() method.
  *
- * @since BuddyPress (2.1.0)
+ * @since 2.1.0
  *
  * @param array $args See {@link BP_XProfile_Group::get()} for description of
@@ -36 +35 @@
      * Filters a set of field groups, populated with fields and field data.
      *
-     * @since BuddyPress (2.1.0)
+     * @since 2.1.0
      *
      * @param array $groups Array of field groups and field data.
@@ -47 +46 @@
  * Insert a new profile field group
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @param type $args
@@ -79 +78 @@
  * Get a specific profile field group
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @param int $field_group_id
@@ -101 +100 @@
  * Delete a specific profile field group
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @param int $field_group_id
@@ -123 +122 @@
  * Update the position of a specific profile field group
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @param int $field_group_id
@@ -140 +139 @@
  *
  * @return array Key/value pairs (field type => class name).
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  */
 function bp_xprofile_get_field_types() {
@@ -160 +159 @@
      * If you've added a custom field type in a plugin, register it with this filter.
      *
-     * @since BuddyPress (2.0.0)
+     * @since 2.0.0
      *
      * @param array $fields Array of field type/class name pairings.
@@ -172 +171 @@
  * @param string $type Type of profile field to create. See {@link bp_xprofile_get_field_types()} for default core values.
  * @return object If field type unknown, returns BP_XProfile_Field_Type_Textarea. Otherwise returns an instance of the relevant child class of BP_XProfile_Field_Type.
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  */
 function bp_xprofile_create_field_type( $type ) {
@@ -324 +323 @@
              * Filters the field data value for a specific field for the user.
              *
-             * @since BuddyPress (1.0.0)
+             * @since 1.0.0
              *
              * @param string $value    Value saved for the field.
@@ -377 +376 @@
      * doing field-type-specific validation.
      *
-     * @since BuddyPress (2.1.0)
+     * @since 2.1.0
      *
      * @param mixed $value Value passed to xprofile_set_field_data()
@@ -458 +457 @@
  * Get the visibility level for a field.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @param int $field_id The ID of the xprofile field.
@@ -567 +566 @@
      * Filters a random piece of profile data for the user.
      *
-     * @since BuddyPress (1.0.0)
+     * @since 1.0.0
      *
      * @param array $field_data Array holding random profile data.
@@ -613 +612 @@
  * globals before attempting any overrides.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  */
 function xprofile_override_user_fullnames() {
@@ -634 +633 @@
  * Setup the avatar upload directory for a user.
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @package BuddyPress Core
@@ -664 +663 @@
      * Filters the avatar upload directory for a user.
      *
-     * @since BuddyPress (1.1.0)
+     * @since 1.1.0
      *
      * @param array $value Array containing the path, URL, and other helpful settings.
@@ -681 +680 @@
  * When search_terms are passed to BP_User_Query, search against xprofile fields.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @param array $sql Clauses in the user_id SQL query.
@@ -771 +770 @@
  * Syncs the standard built in WordPress profile data to XProfile.
  *
- * @since BuddyPress (1.2.4)
+ * @since 1.2.4
  * @package BuddyPress Core
  */
@@ -909 +908 @@
  * Add a piece of xprofile metadata.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @param int $object_id ID of the object the metadata belongs to.
@@ -945 +944 @@
  * Return the field ID for the Full Name xprofile field.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @return int Field ID.
@@ -968 +967 @@
  *
  * @package BuddyPress
- * @since BuddyPress (1.5.0)
+ * @since 1.5.0
  *
  * @return string The field name
@@ -977 +976 @@
      * Filters the field name for the Full Name xprofile field.
      *
-     * @since BuddyPress (1.5.0)
+     * @since 1.5.0
      *
      * @param string BP_XPROFILE_FULLNAME_FIELD_NAME Full name field constant.
@@ -994 +993 @@
      * Filters the visibility levels out of the $bp global.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param array $visibility_levels Array of visibility levels.
@@ -1009 +1008 @@
  * be excluded from the profile loop.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  * @see BP_XProfile_Group::get()
  * @uses apply_filters() Filter bp_xprofile_get_hidden_fields_for_user to modify visibility levels,
@@ -1038 +1037 @@
      * Filters the ids of fields that are hidden for this displayed/loggedin user pair.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param array $hidden_fields     Array of hidden fields for the displayed/logged in user.
@@ -1056 +1055 @@
  * that should be hidden for the current user pair.
  *
- * @since BuddyPress (1.8.2)
+ * @since 1.8.2
  * @see bp_xprofile_get_hidden_fields_for_user()
  *
@@ -1090 +1089 @@
      * Filters the visibility levels that should be hidden for this user pair.
      *
-     * @since BuddyPress (2.0.0)
+     * @since 2.0.0
      *
      * @param array $hidden_fields     Array of hidden fields for the displayed/logged in user.
@@ -1102 +1101 @@
  * Fetch an array of the xprofile fields that a given user has marked with certain visibility levels
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  * @see bp_xprofile_get_hidden_fields_for_user()
  *