Changeset 8547 for trunk/src/bp-xprofile/bp-xprofile-classes.php

Timestamp:

06/25/2014 01:36:44 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce BP_XProfile_Field_Type::display_filter(), and implement in BP_XProfile_Field_Type_Datebox.

The new display_filter() method makes it easy for field types to customize the
appearance of its values. In the case of Datebox fields, this means formatting
the MySQL- or UNIX-formatted date in the format of bp_format_time().

Fixes #5630

File:

• trunk/src/bp-xprofile/bp-xprofile-classes.php (modified) (2 diffs)

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

@@ -1696 +1696 @@
      */
     public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
+
+    /**
+     * Format Date values for display.
+     *
+     * @since BuddyPress (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).
+     * @return string Date formatted by bp_format_time().
+     */
+    public static function display_filter( $field_value ) {
+        // If Unix timestamp
+        if ( is_numeric( $field_value ) ) {
+            $field_value = bp_format_time( $field_value, true, false );
+
+        // If MySQL timestamp
+        } else {
+            $field_value = bp_format_time( strtotime( $field_value ), true, false );
+        }
+
+        return $field_value;
+    }
 }
 
@@ -2852 +2874 @@
     }
 
+    /**
+     * Allow field types to modify the appearance of their values.
+     *
+     * By default, this is a pass-through method that does nothing. Only
+     * override in your own field type if you need to provide custom
+     * filtering for output values.
+     *
+     * @since BuddyPress (2.1.0)
+     *
+     * @param mixed $field_value Field value.
+     * @return mixed
+     */
+    public static function display_filter( $field_value ) {
+        return $field_value;
+    }
 
     /**