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

Timestamp:

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

Author:

tw2113

Message:

Standardizing our @since tags for the XProfile component.

See #6576.

File:

• trunk/src/bp-xprofile/bp-xprofile-filters.php (modified) (14 diffs)

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

@@ -1 +1 @@
 <?php
-
-/**
- * BuddyPress XProfile Filters
- *
- * Apply WordPress defined filters
+/**
+ * BuddyPress XProfile Filters.
+ *
+ * Apply WordPress defined filters.
  *
  * @package BuddyPress
@@ -10 +9 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -77 +76 @@
  * Sanitize each field option name for saving to the database
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  *
  * @param  mixed $field_options
@@ -93 +92 @@
  * Sanitize each field option default for saving to the database
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  *
  * @param  mixed $field_default
@@ -124 +123 @@
      * Filters the allowed tags for use within xprofile_filter_kses().
      *
-     * @since BuddyPress (1.5.0)
+     * @since 1.5.0
      *
      * @param array                   $xprofile_allowedtags Array of allowed tags for profile field values.
@@ -160 +159 @@
          * Filters the kses-filtered data before saving to database.
          *
-         * @since BuddyPress (1.5.0)
+         * @since 1.5.0
          *
          * @param string                  $filtered_field_value The filtered value.
@@ -193 +192 @@
  * Runs stripslashes on XProfile fields.
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
  *
  * @param string $field_value XProfile field_value to be filtered.
@@ -216 +215 @@
  * Apply display_filter() filters as defined by the BP_XProfile_Field_Type classes, when fetched inside a bp_has_profile() loop.
  *
- * @since BuddyPress (2.1.0)
+ * @since 2.1.0
  *
  * @param mixed $field_value Field value.
@@ -239 +238 @@
  * Apply display_filter() filters as defined by the BP_XProfile_Field_Type classes, when fetched by xprofile_get_field_data().
  *
- * @since BuddyPress (2.1.0)
+ * @since 2.1.0
  *
  * @param mixed $field_value Field value.
@@ -252 +251 @@
  * Apply pre_validate_filter() filters as defined by the BP_XProfile_Field_Type classes before validating.
  *
- * @since BuddyPress (2.1.0)
+ * @since 2.1.0
  *
  * @param mixed $value Value passed to the bp_xprofile_set_field_data_pre_validate
@@ -277 +276 @@
  * - To disable: remove_filter( 'bp_get_the_profile_field_value', 'xprofile_filter_link_profile_data', 9, 2 );
  *
- * @since BuddyPress (1.1.0)
+ * @since 1.1.0
  *
  * @param string $field_value
@@ -371 +370 @@
  * Filter BP_User_Query::populate_extras to override each queries users fullname
  *
- * @since BuddyPress (1.7.0)
+ * @since 1.7.0
  *
  * @param BP_User_Query $user_query
@@ -396 +395 @@
  * Parse 'xprofile_query' argument passed to BP_User_Query.
  *
- * @since BuddyPress (2.2.0)
+ * @since 2.2.0
  *
  * @param BP_User_Query User query object.
@@ -420 +419 @@
  * Filter meta queries to modify for the xprofile data schema.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @access private Do not use.