Changeset 10203

Timestamp:

10/07/2015 03:34:32 PM (9 years ago)

Author:

boonebgorges

Message:

Pass field ID to xprofile field type filter methods.

display_filter() and pre_validate_filter() are more useful if they receive
the field ID. So we pass it, when available.

See #5625.

Location:

trunk/src/bp-xprofile

Files:

• bp-xprofile-filters.php (modified) (4 diffs)
• classes/class-bp-xprofile-field-type-datebox.php (modified) (1 diff)
• classes/class-bp-xprofile-field-type-url.php (modified) (2 diffs)
• classes/class-bp-xprofile-field-type.php (modified) (2 diffs)

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

@@ -27 +27 @@
 add_filter( 'bp_get_the_profile_field_value',           'convert_smilies', 9 );
 add_filter( 'bp_get_the_profile_field_value',           'xprofile_filter_format_field_value',         1, 2 );
-add_filter( 'bp_get_the_profile_field_value',           'xprofile_filter_format_field_value_by_type', 8, 2 );
-add_filter( 'bp_get_the_profile_field_value',           'xprofile_filter_link_profile_data',          9, 2 );
+add_filter( 'bp_get_the_profile_field_value',           'xprofile_filter_format_field_value_by_type', 8, 3 );
+add_filter( 'bp_get_the_profile_field_value',           'xprofile_filter_link_profile_data',          9, 3 );
 
 add_filter( 'bp_get_the_profile_field_edit_value',      'force_balance_tags' );
@@ -216 +216 @@
 
 /**
- * Apply display_filter() filters as defined by the BP_XProfile_Field_Type classes, when fetched inside
- * a bp_has_profile() loop.
+ * Apply display_filter() filters as defined by BP_XProfile_Field_Type classes, when inside a bp_has_profile() loop.
  *
  * @since 2.1.0
+ * @since 2.4.0 Added `$field_id` parameter.
  *
  * @param mixed  $field_value Field value.
  * @param string $field_type  Field type.
+ * @param int    $field_id    Optional. ID of the field.
  *
  * @return mixed
  */
-function xprofile_filter_format_field_value_by_type( $field_value, $field_type = '' ) {
+function xprofile_filter_format_field_value_by_type( $field_value, $field_type = '', $field_id = '' ) {
     foreach ( bp_xprofile_get_field_types() as $type => $class ) {
         if ( $type !== $field_type ) {
@@ -233 +234 @@
 
         if ( method_exists( $class, 'display_filter' ) ) {
-            $field_value = call_user_func( array( $class, 'display_filter' ), $field_value );
+            $field_value = call_user_func( array( $class, 'display_filter' ), $field_value, $field_id );
         }
     }
@@ -253 +254 @@
 function xprofile_filter_format_field_value_by_field_id( $field_value, $field_id ) {
     $field = xprofile_get_field( $field_id );
-    return xprofile_filter_format_field_value_by_type( $field_value, $field->type );
+    return xprofile_filter_format_field_value_by_type( $field_value, $field->type, $field_id );
 }
 

trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-datebox.php

@@ -302 +302 @@
      *
      * @since 2.1.0
-     *
-     * @param string $field_value The date value, as saved in the database.
-     *                            Typically, this is a MySQL-formatted date
-     *                            string (Y-m-d H:i:s).
+     * @since 2.4.0 Added the `$field_id` parameter.
+     *
+     * @param string $field_value The date value, as saved in the database. Typically, this is a MySQL-formatted
+     *                            date string (Y-m-d H:i:s).
+     * @param int    $field_id    Optional. ID of the field.
      *
      * @return string Date formatted by bp_format_time().
      */
-    public static function display_filter( $field_value ) {
+    public static function display_filter( $field_value, $field_id = '' ) {
 
         // If Unix timestamp.

trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-url.php

@@ -125 +125 @@
      *
      * @since 2.1.0
+     * @since 2.4.0 Added the `$field_id` parameter.
      *
      * @param string $submitted_value Raw value submitted by the user.
+     * @param int    $field_id        Optional. ID of the field.
      *
      * @return string
      */
-    public static function pre_validate_filter( $submitted_value = '' ) {
+    public static function pre_validate_filter( $submitted_value = '', $field_id = '' ) {
 
         // Allow empty URL values.
@@ -153 +155 @@
      *
      * @since 2.1.0
+     * @since 2.4.0 Added the `$field_id` parameter.
      *
      * @param string $field_value The URL value, as saved in the database.
+     * @param int    $field_id    Optional. ID of the field.
      *
      * @return string URL converted to a link.
      */
-    public static function display_filter( $field_value ) {
+    public static function display_filter( $field_value, $field_id = '' ) {
         $link      = strip_tags( $field_value );
         $no_scheme = preg_replace( '#^https?://#', '', rtrim( $link, '/' ) );

trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type.php

@@ -408 +408 @@
      *
      * @since 2.1.0
+     * @since 2.4.0 Added the `$field_id` parameter.
      *
      * @param mixed $field_value Submitted field value.
+     * @param int   $field_id    Optional. ID of the field.
      *
      * @return mixed
      */
-    public static function pre_validate_filter( $field_value ) {
+    public static function pre_validate_filter( $field_value, $field_id = '' ) {
         return $field_value;
     }
@@ -425 +427 @@
      *
      * @since 2.1.0
+     * @since 2.4.0 Added `$field_id` parameter.
      *
      * @param mixed $field_value Field value.
+     * @param int   $field_id    ID of the field.
      *
      * @return mixed
      */
-    public static function display_filter( $field_value ) {
+    public static function display_filter( $field_value, $field_id = '' ) {
         return $field_value;
     }