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

Timestamp:

12/29/2014 06:16:40 AM (10 years ago)

Author:

tw2113

Message:

Add hook docs and fix version numbers for bp-xprofile-cssjs.php and bp-xprofile-filters.php.

See #5949.

File:

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

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

@@ -71 +71 @@
     $xprofile_allowedtags['a']['rel'] = array();
 
+    /**
+     * Filters the allowed tags for use within xprofile_filter_kses().
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param array                   $xprofile_allowedtags Array of allowed tags for profile field values.
+     * @param BP_XProfile_ProfileData $data_obj             The BP_XProfile_ProfileData object.
+     */
     $xprofile_allowedtags = apply_filters( 'xprofile_allowed_tags', $xprofile_allowedtags, $data_obj );
     return wp_kses( $content, $xprofile_allowedtags );
@@ -98 +106 @@
         $kses_field_value     = xprofile_filter_kses( $field_value, $data_obj );
         $filtered_field_value = wp_rel_nofollow( force_balance_tags( $kses_field_value ) );
+
+        /**
+         * Filters the kses-filtered data before saving to database.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param string                  $filtered_field_value The filtered value.
+         * @param string                  $field_value          The original value before filtering.
+         * @param BP_XProfile_ProfileData $data_obj             The BP_XProfile_ProfileData object.
+         */
         $filtered_field_value = apply_filters( 'xprofile_filtered_data_value_before_save', $filtered_field_value, $field_value, $data_obj );
 
@@ -106 +124 @@
             $kses_field_value       = xprofile_filter_kses( $value, $data_obj );
             $filtered_value     = wp_rel_nofollow( force_balance_tags( $kses_field_value ) );
+
+            /** This filter is documented in bp-xprofile/bp-xprofile-filters.php */
             $filtered_values[] = apply_filters( 'xprofile_filtered_data_value_before_save', $filtered_value, $value, $data_obj );
 
@@ -201 +221 @@
  * Filter an Extended Profile field value, and attempt to make clickable links
  * to members search results out of them.
- * 
+ *
  * - Not run on datebox field types
  * - Not run on values without commas with less than 5 words
@@ -207 +227 @@
  * - To disable: remove_filter( 'bp_get_the_profile_field_value', 'xprofile_filter_link_profile_data', 9, 2 );
  *
- * @since BuddyPress (1.1)
+ * @since BuddyPress (1.1.0)
  *
  * @param string $field_value
@@ -301 +321 @@
  * Filter BP_User_Query::populate_extras to override each queries users fullname
  *
- * @since BuddyPress (1.7)
+ * @since BuddyPress (1.7.0)
  *
  * @param BP_User_Query $user_query