X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..607b7e02d77e7326161e8ec15639052d2040f745:/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..1920140f 100644 --- a/wp-includes/class-wp-customize-control.php +++ b/wp-includes/class-wp-customize-control.php @@ -1,12 +1,41 @@ $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 ( ! isset( $this->settings ) ) { $this->settings = $id; + } $settings = array(); if ( is_array( $this->settings ) ) { foreach ( $this->settings as $key => $setting ) { $settings[ $key ] = $this->manager->get_setting( $setting ); } - } else { + } else if ( is_string( $this->settings ) ) { $this->setting = $this->manager->get_setting( $this->settings ); $settings['default'] = $this->setting; } @@ -120,6 +222,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. + */ + final public function active() { + $control = $this; + $active = call_user_func( $this->active_callback, $this ); + + /** + * Filters 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 true Always true. + */ + public function active_callback() { + return true; + } /** * Fetch a setting's value. @@ -130,9 +271,10 @@ class WP_Customize_Control { * @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 ] ) ) + final public function value( $setting_key = 'default' ) { + if ( isset( $this->settings[ $setting_key ] ) ) { return $this->settings[ $setting_key ]->value(); + } } /** @@ -147,35 +289,78 @@ 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; } /** - * Check if the theme supports the control and check user capabilities. + * 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; + } + + /** + * Checks if the user can use this control. + * + * Returns false if the user cannot manipulate one of the associated settings, + * or if one of the associated settings does not exist. Also returns false if + * the associated section does not exist or if its capability check returns + * false. * * @since 3.4.0 * * @return bool False if theme doesn't support the control or user doesn't have the required permissions, otherwise true. */ - public final function check_capabilities() { + final public function check_capabilities() { + if ( ! empty( $this->capability ) && ! current_user_can( $this->capability ) ) { + return false; + } + foreach ( $this->settings as $setting ) { - if ( ! $setting->check_capabilities() ) + if ( ! $setting || ! $setting->check_capabilities() ) { return false; + } } $section = $this->manager->get_section( $this->section ); - if ( isset( $section ) && ! $section->check_capabilities() ) + if ( isset( $section ) && ! $section->check_capabilities() ) { return false; + } return true; } + /** + * Get the control's content for insertion into the Customizer pane. + * + * @since 4.1.0 + * + * @return string Contents of the control. + */ + final public function get_content() { + ob_start(); + $this->maybe_render(); + return trim( ob_get_clean() ); + } + /** * Check capabilities and render the control. * * @since 3.4.0 * @uses WP_Customize_Control::render() */ - public final function maybe_render() { + final public function maybe_render() { if ( ! $this->check_capabilities() ) return; @@ -191,7 +376,7 @@ class WP_Customize_Control { /** * Fires just before a specific Customizer control is rendered. * - * The dynamic portion of the hook name, $this->id, refers to + * The dynamic portion of the hook name, `$this->id`, refers to * the control ID. * * @since 3.4.0 @@ -209,7 +394,7 @@ class WP_Customize_Control { * @since 3.4.0 */ protected function render() { - $id = 'customize-control-' . str_replace( '[', '-', str_replace( ']', '', $this->id ) ); + $id = 'customize-control-' . str_replace( array( '[', ']' ), array( '-', '' ), $this->id ); $class = 'customize-control customize-control-' . $this->type; ?>
  • @@ -244,30 +429,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 in $this->render(). + * 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. + * + * Control content can alternately be rendered in JS. 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 ) : ?>