X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/61343b82c4f0da4c68e4c6373daafff4a81efdd1..refs/tags/wordpress-4.4:/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 fde85615..3027a7b5 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 ( empty( $this->settings ) ) {
$this->settings = $id;
+ }
$settings = array();
if ( is_array( $this->settings ) ) {
@@ -119,6 +183,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 );
+
+ /**
+ * 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 true Always true.
+ */
+ public function active_callback() {
+ return true;
+ }
/**
* Fetch a setting's value.
@@ -129,9 +232,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();
+ }
}
/**
@@ -146,6 +250,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;
}
/**
@@ -155,7 +278,7 @@ class WP_Customize_Control {
*
* @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() {
foreach ( $this->settings as $setting ) {
if ( ! $setting->check_capabilities() )
return false;
@@ -168,29 +291,60 @@ 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.
+ */
+ 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;
+ /**
+ * 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
*/
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;
?>
@@ -199,7 +353,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 +368,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 +379,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 ) :
?>