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

Timestamp:

08/30/2016 03:17:16 PM (9 years ago)

Author:

boonebgorges

Message:

XProfile: Introduce new settings for Datebox field type.

These new settings are designed to make it easier for site administrators
to decide how date-based data will be collected and displayed.

• "Date format" allows the admin to select how dates will be displayed on public profiles. A number of default custom date formats are included. Admins may also enter a custom date format, or opt to display time elapsed ("4 years ago", etc).
• "Range" allows the admin to set the start and end values for the Year dropdown. There are two ways to configure the range. The first is by defining a specific set of start and end years. The second is to define a relative range: *from* a certain number of years ago (or in the future) *to* a certain number of years ago (or in the future).

Props abwebstudio, abweb, sooskriszta, boonebgorges, DJPaul, mercime.

See #5500.

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type.php (modified) (3 diffs)

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

@@ -81 +81 @@
      */
     public $supports_richtext = false;
+
+    /**
+     * If the field type has a type-specific settings section on the Edit Field panel.
+     *
+     * @since 2.7.0
+     * @var bool|null Boolean if set explicitly by the type object, otherwise null.
+     */
+    protected $do_settings_section = null;
 
     /**
@@ -227 +235 @@
          */
         return (bool) apply_filters( 'bp_xprofile_field_type_is_valid', $validated, $values, $this );
+    }
+
+    /**
+     * Check whether the current field type should have a settings ("options") section on the Edit Field panel.
+     *
+     * Falls back on `supports_options` if no value is set by the field type.
+     *
+     * @since 2.7.0
+     *
+     * @return bool
+     */
+    public function do_settings_section() {
+        if ( null === $this->do_settings_section ) {
+            $this->do_settings_section = $this->supports_options;
+        }
+
+        return (bool) $this->do_settings_section;
     }
 
@@ -452 +477 @@
     }
 
+    /**
+     * Save miscellaneous settings related to this field type.
+     *
+     * Override in a specific field type if it requires an admin save routine.
+     *
+     * @since 2.7.0
+     *
+     * @param int   $field_id Field ID.
+     * @param array $settings Array of settings.
+     */
+    public function admin_save_settings( $field_id, $settings ) {}
+
     /** Protected *************************************************************/