X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/8f374b7233bc2815ccc387e448d208c5434eb961..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 5ded24ca..216ceafb 100644 --- a/wp-includes/class-wp-customize-control.php +++ b/wp-includes/class-wp-customize-control.php @@ -6,49 +6,131 @@ * @subpackage Customize * @since 3.4.0 */ - class WP_Customize_Control { + /** + * @access public + * @var WP_Customize_Manager + */ public $manager; + + /** + * @access public + * @var string + */ public $id; - // All settings tied to the control. + /** + * All settings tied to the control. + * + * @access public + * @var array + */ public $settings; - // The primary setting for the control (if there is one). + /** + * The primary setting for the control (if there is one). + * + * @access public + * @var string + */ public $setting = 'default'; - public $priority = 10; - public $section = ''; - public $label = ''; - // @todo: remove choices - public $choices = array(); + /** + * @access public + * @var int + */ + public $priority = 10; + + /** + * @access public + * @var string + */ + public $section = ''; + + /** + * @access public + * @var string + */ + public $label = ''; + /** + * @access public + * @var string + */ + public $description = ''; + + /** + * @todo: Remove choices + * + * @access public + * @var array + */ + public $choices = array(); + + /** + * @access public + * @var array + */ + public $input_attrs = array(); + + /** + * @access public + * @var array + */ public $json = array(); + /** + * @access public + * @var string + */ 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. * + * Supplied $args override class property defaults. + * * If $args['settings'] is not defined, use the $id as the setting ID. * * @since 3.4.0 + * + * @param WP_Customize_Manager $manager + * @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 ) ) { @@ -69,16 +151,59 @@ 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. * Grabs the main setting by default. * * @since 3.4.0 + * + * @param string $setting_key + * @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(); + } } /** @@ -93,6 +218,7 @@ class WP_Customize_Control { } $this->json['type'] = $this->type; + $this->json['active'] = $this->active(); } /** @@ -119,19 +245,38 @@ class WP_Customize_Control { * Check capabilities and render the control. * * @since 3.4.0 + * @uses WP_Customize_Control::render() */ public final function maybe_render() { if ( ! $this->check_capabilities() ) return; + /** + * Fires just before the current Customizer control is rendered. + * + * @since 3.4.0 + * + * @param WP_Customize_Control $this WP_Customize_Control instance. + */ do_action( 'customize_render_control', $this ); + + /** + * Fires just before a specific Customizer control is rendered. + * + * The dynamic portion of the hook name, $this->id, refers to + * the control ID. + * + * @since 3.4.0 + * + * @param WP_Customize_Control $this WP_Customize_Control instance. + */ do_action( 'customize_render_control_' . $this->id, $this ); $this->render(); } /** - * Render the control. Renders the control wrapper, then calls $this->render_content(). + * Renders the control wrapper and calls $this->render_content() for the internals. * * @since 3.4.0 */ @@ -144,6 +289,14 @@ class WP_Customize_Control { settings[ $setting_key ] ) ) return ''; @@ -151,32 +304,50 @@ class WP_Customize_Control { return 'data-customize-setting-link="' . esc_attr( $this->settings[ $setting_key ]->id ) . '"'; } + /** + * Render the data link attribute for the control's input element. + * + * @since 3.4.0 + * @uses WP_Customize_Control::get_link() + * + * @param string $setting_key + */ public function link( $setting_key = 'default' ) { 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. + * Allows the content to be overriden without having to rewrite the wrapper in $this->render(). + * + * 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 ) : ?>