X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f:/wp-includes/class-wp-customize-control.php diff --git a/wp-includes/class-wp-customize-control.php b/wp-includes/class-wp-customize-control.php index df440744..216ceafb 100644 --- a/wp-includes/class-wp-customize-control.php +++ b/wp-includes/class-wp-customize-control.php @@ -53,6 +53,12 @@ class WP_Customize_Control { */ public $label = ''; + /** + * @access public + * @var string + */ + public $description = ''; + /** * @todo: Remove choices * @@ -61,6 +67,12 @@ class WP_Customize_Control { */ public $choices = array(); + /** + * @access public + * @var array + */ + public $input_attrs = array(); + /** * @access public * @var array @@ -73,6 +85,20 @@ class WP_Customize_Control { */ public $type = 'text'; + /** + * Callback. + * + * @since 4.0.0 + * @access public + * + * @see WP_Customize_Control::active() + * + * @var callable Callback is called with one argument, the instance of + * WP_Customize_Control, and returns bool to indicate whether + * the control is active (such as it relates to the URL + * currently being previewed). + */ + public $active_callback = ''; /** * Constructor. @@ -87,19 +113,24 @@ class WP_Customize_Control { * @param string $id * @param array $args */ - function __construct( $manager, $id, $args = array() ) { + public function __construct( $manager, $id, $args = array() ) { $keys = array_keys( get_object_vars( $this ) ); foreach ( $keys as $key ) { - if ( isset( $args[ $key ] ) ) + if ( isset( $args[ $key ] ) ) { $this->$key = $args[ $key ]; + } } $this->manager = $manager; $this->id = $id; + if ( empty( $this->active_callback ) ) { + $this->active_callback = array( $this, 'active_callback' ); + } // Process settings. - if ( empty( $this->settings ) ) + if ( empty( $this->settings ) ) { $this->settings = $id; + } $settings = array(); if ( is_array( $this->settings ) ) { @@ -120,6 +151,45 @@ class WP_Customize_Control { */ public function enqueue() {} + /** + * Check whether control is active to current customizer preview. + * + * @since 4.0.0 + * @access public + * + * @return bool Whether the control is active to the current preview. + */ + public final function active() { + $control = $this; + $active = call_user_func( $this->active_callback, $this ); + + /** + * Filter response of WP_Customize_Control::active(). + * + * @since 4.0.0 + * + * @param bool $active Whether the Customizer control is active. + * @param WP_Customize_Control $control WP_Customize_Control instance. + */ + $active = apply_filters( 'customize_control_active', $active, $control ); + + return $active; + } + + /** + * Default callback used when invoking WP_Customize_Control::active(). + * + * Subclasses can override this with their specific logic, or they may + * provide an 'active_callback' argument to the constructor. + * + * @since 4.0.0 + * @access public + * + * @return bool Always true. + */ + public function active_callback() { + return true; + } /** * Fetch a setting's value. @@ -131,8 +201,9 @@ class WP_Customize_Control { * @return mixed The requested setting's value, if the setting exists. */ public final function value( $setting_key = 'default' ) { - if ( isset( $this->settings[ $setting_key ] ) ) + if ( isset( $this->settings[ $setting_key ] ) ) { return $this->settings[ $setting_key ]->value(); + } } /** @@ -147,6 +218,7 @@ class WP_Customize_Control { } $this->json['type'] = $this->type; + $this->json['active'] = $this->active(); } /** @@ -244,30 +316,38 @@ class WP_Customize_Control { echo $this->get_link( $setting_key ); } + /** + * Render the custom attributes for the control's input element. + * + * @since 4.0.0 + * @access public + */ + public function input_attrs() { + foreach( $this->input_attrs as $attr => $value ) { + echo $attr . '="' . esc_attr( $value ) . '" '; + } + } + /** * Render the control's content. * * Allows the content to be overriden without having to rewrite the wrapper in $this->render(). * - * Supports basic input types `text`, `checkbox`, `radio`, `select` and `dropdown-pages`. + * Supports basic input types `text`, `checkbox`, `textarea`, `radio`, `select` and `dropdown-pages`. + * Additional input types such as `email`, `url`, `number`, `hidden` and `date` are supported implicitly. * * @since 3.4.0 */ protected function render_content() { switch( $this->type ) { - case 'text': - ?> - - id; - ?> - label ); ?> - label ) ) : ?> + label ); ?> + description ) ) : ?> + description ; ?> + choices as $value => $label ) : ?>