X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/5964d2279dc52bdfe105f9bfa17e04337d47a3fa..caeaf8dc94b5e3f75dc98ec92dc7b76049cdddb6:/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 d24a5f2e..950b0d5a 100644 --- a/wp-includes/class-wp-customize-control.php +++ b/wp-includes/class-wp-customize-control.php @@ -7,6 +7,27 @@ * @since 3.4.0 */ class WP_Customize_Control { + + /** + * Incremented with each new class instantiation, then stored in $instance_number. + * + * Used when sorting two instances whose priorities are equal. + * + * @since 4.1.0 + * @access protected + * @var int + */ + protected static $instance_count = 0; + + /** + * Order in which this instance was created in relation to other instances. + * + * @since 4.1.0 + * @access public + * @var int + */ + public $instance_number; + /** * @access public * @var WP_Customize_Manager @@ -39,19 +60,25 @@ class WP_Customize_Control { * @access public * @var int */ - public $priority = 10; + public $priority = 10; /** * @access public * @var string */ - public $section = ''; + public $section = ''; /** * @access public * @var string */ - public $label = ''; + public $label = ''; + + /** + * @access public + * @var string + */ + public $description = ''; /** * @todo: Remove choices @@ -59,9 +86,16 @@ class WP_Customize_Control { * @access public * @var array */ - public $choices = array(); + public $choices = array(); + + /** + * @access public + * @var array + */ + public $input_attrs = array(); /** + * @deprecated It is better to just call the json() method * @access public * @var array */ @@ -73,10 +107,26 @@ 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. * + * Supplied $args override class property defaults. + * * If $args['settings'] is not defined, use the $id as the setting ID. * * @since 3.4.0 @@ -85,20 +135,26 @@ 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' ); + } + self::$instance_count += 1; + $this->instance_number = self::$instance_count; // Process settings. - if ( empty( $this->settings ) ) + if ( empty( $this->settings ) ) { $this->settings = $id; + } $settings = array(); if ( is_array( $this->settings ) ) { @@ -119,6 +175,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. @@ -130,8 +225,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(); + } } /** @@ -146,6 +242,25 @@ class WP_Customize_Control { } $this->json['type'] = $this->type; + $this->json['priority'] = $this->priority; + $this->json['active'] = $this->active(); + $this->json['section'] = $this->section; + $this->json['content'] = $this->get_content(); + $this->json['label'] = $this->label; + $this->json['description'] = $this->description; + $this->json['instanceNumber'] = $this->instance_number; + } + + /** + * Get the data to export to the client via JSON. + * + * @since 4.1.0 + * + * @return array Array of parameters passed to the JavaScript. + */ + public function json() { + $this->to_json(); + return $this->json; } /** @@ -168,6 +283,21 @@ class WP_Customize_Control { return true; } + /** + * Get the control's content for insertion into the Customizer pane. + * + * @since 4.1.0 + * + * @return string Contents of the control. + */ + public final function get_content() { + ob_start(); + $this->maybe_render(); + $template = trim( ob_get_contents() ); + ob_end_clean(); + return $template; + } + /** * Check capabilities and render the control. * @@ -178,14 +308,32 @@ class WP_Customize_Control { 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 {@see 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 */ @@ -199,7 +347,7 @@ class WP_Customize_Control { } /** - * Get the data link parameter for a setting. + * Get the data link attribute for a setting. * * @since 3.4.0 * @@ -214,7 +362,7 @@ class WP_Customize_Control { } /** - * Render the data link parameter for a setting + * Render the data link attribute for the control's input element. * * @since 3.4.0 * @uses WP_Customize_Control::get_link() @@ -225,28 +373,40 @@ 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. + * 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. + * + * Control content can alternately be rendered in JS. See {@see WP_Customize_Control::print_template()}. * * @since 3.4.0 */ protected function render_content() { switch( $this->type ) { - case 'text': - ?> - - id; - ?> - label ); ?> - label ) ) : ?> + label ); ?> + description ) ) : ?> + description ; ?> + choices as $value => $label ) : ?>