<?php
/**
- * Customize Control Class
+ * WordPress Customize Control classes
*
* @package WordPress
* @subpackage Customize
* @since 3.4.0
*/
+
+/**
+ * Customize Control class.
+ *
+ * @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
+ *
+ * @static
+ * @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
*/
public $setting = 'default';
+ /**
+ * Capability required to use this control.
+ *
+ * Normally this is empty and the capability is derived from the capabilities
+ * of the associated `$settings`.
+ *
+ * @since 4.5.0
+ * @access public
+ * @var string
+ */
+ public $capability;
+
/**
* @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
* @access public
* @var array
*/
- public $choices = array();
+ public $choices = array();
+
+ /**
+ * @access public
+ * @var array
+ */
+ public $input_attrs = array();
/**
+ * Show UI for adding new content, currently only used for the dropdown-pages control.
+ *
+ * @since 4.7.0
+ * @access public
+ * @var bool
+ */
+ public $allow_addition = false;
+
+ /**
+ * @deprecated It is better to just call the json() method
* @access public
* @var array
*/
*/
public $type = 'text';
-
/**
- * Constructor.
+ * Callback.
*
- * If $args['settings'] is not defined, use the $id as the setting ID.
+ * @since 4.0.0
+ * @access public
*
- * @since 3.4.0
+ * @see WP_Customize_Control::active()
*
- * @param WP_Customize_Manager $manager
- * @param string $id
- * @param array $args
+ * @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).
*/
- function __construct( $manager, $id, $args = array() ) {
+ 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 Customizer bootstrap instance.
+ * @param string $id Control ID.
+ * @param array $args {
+ * Optional. Arguments to override class property defaults.
+ *
+ * @type int $instance_number Order in which this instance was created in relation
+ * to other instances.
+ * @type WP_Customize_Manager $manager Customizer bootstrap instance.
+ * @type string $id Control ID.
+ * @type array $settings All settings tied to the control. If undefined, `$id` will
+ * be used.
+ * @type string $setting The primary setting for the control (if there is one).
+ * Default 'default'.
+ * @type int $priority Order priority to load the control. Default 10.
+ * @type string $section Section the control belongs to. Default empty.
+ * @type string $label Label for the control. Default empty.
+ * @type string $description Description for the control. Default empty.
+ * @type array $choices List of choices for 'radio' or 'select' type controls, where
+ * values are the keys, and labels are the values.
+ * Default empty array.
+ * @type array $input_attrs List of custom input attributes for control output, where
+ * attribute names are the keys and values are the values. Not
+ * used for 'checkbox', 'radio', 'select', 'textarea', or
+ * 'dropdown-pages' control types. Default empty array.
+ * @type array $json Deprecated. Use WP_Customize_Control::json() instead.
+ * @type string $type Control type. Core controls include 'text', 'checkbox',
+ * 'textarea', 'radio', 'select', and 'dropdown-pages'. Additional
+ * input types such as 'email', 'url', 'number', 'hidden', and
+ * 'date' are supported implicitly. Default 'text'.
+ * }
+ */
+ 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 ( ! 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;
}
*/
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.
* @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();
+ }
}
/**
}
$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;
+
+ if ( 'dropdown-pages' === $this->type ) {
+ $this->json['allow_addition'] = $this->allow_addition;
+ }
+ }
+
+ /**
+ * 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;
}
/**
- * Check if the theme supports the control and check user capabilities.
+ * 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;
+ /**
+ * 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 );
- do_action( 'customize_render_control_' . $this->id, $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
*/
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;
?><li id="<?php echo esc_attr( $id ); ?>" class="<?php echo esc_attr( $class ); ?>">
}
/**
- * Get the data link parameter for a setting.
+ * Get the data link attribute for a setting.
*
* @since 3.4.0
*
}
/**
- * 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()
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 overridden 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 WP_Customize_Control::print_template().
*
* @since 3.4.0
*/
protected function render_content() {
switch( $this->type ) {
- case 'text':
- ?>
- <label>
- <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
- <input type="text" value="<?php echo esc_attr( $this->value() ); ?>" <?php $this->link(); ?> />
- </label>
- <?php
- break;
case 'checkbox':
?>
<label>
<input type="checkbox" value="<?php echo esc_attr( $this->value() ); ?>" <?php $this->link(); checked( $this->value() ); ?> />
<?php echo esc_html( $this->label ); ?>
+ <?php if ( ! empty( $this->description ) ) : ?>
+ <span class="description customize-control-description"><?php echo $this->description; ?></span>
+ <?php endif; ?>
</label>
<?php
break;
$name = '_customize-radio-' . $this->id;
- ?>
- <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
- <?php
+ if ( ! empty( $this->label ) ) : ?>
+ <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
+ <?php endif;
+ if ( ! empty( $this->description ) ) : ?>
+ <span class="description customize-control-description"><?php echo $this->description ; ?></span>
+ <?php endif;
+
foreach ( $this->choices as $value => $label ) :
?>
<label>
?>
<label>
- <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
+ <?php if ( ! empty( $this->label ) ) : ?>
+ <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
+ <?php endif;
+ if ( ! empty( $this->description ) ) : ?>
+ <span class="description customize-control-description"><?php echo $this->description; ?></span>
+ <?php endif; ?>
+
<select <?php $this->link(); ?>>
<?php
foreach ( $this->choices as $value => $label )
</label>
<?php
break;
+ case 'textarea':
+ ?>
+ <label>
+ <?php if ( ! empty( $this->label ) ) : ?>
+ <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
+ <?php endif;
+ if ( ! empty( $this->description ) ) : ?>
+ <span class="description customize-control-description"><?php echo $this->description; ?></span>
+ <?php endif; ?>
+ <textarea rows="5" <?php $this->input_attrs(); ?> <?php $this->link(); ?>><?php echo esc_textarea( $this->value() ); ?></textarea>
+ </label>
+ <?php
+ break;
case 'dropdown-pages':
+ ?>
+ <label>
+ <?php if ( ! empty( $this->label ) ) : ?>
+ <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
+ <?php endif;
+ if ( ! empty( $this->description ) ) : ?>
+ <span class="description customize-control-description"><?php echo $this->description; ?></span>
+ <?php endif; ?>
+
+ <?php
+ $dropdown_name = '_customize-dropdown-pages-' . $this->id;
+ $show_option_none = __( '— Select —' );
+ $option_none_value = '0';
$dropdown = wp_dropdown_pages(
array(
- 'name' => '_customize-dropdown-pages-' . $this->id,
+ 'name' => $dropdown_name,
'echo' => 0,
- 'show_option_none' => __( '— Select —' ),
- 'option_none_value' => '0',
+ 'show_option_none' => $show_option_none,
+ 'option_none_value' => $option_none_value,
'selected' => $this->value(),
)
);
+ if ( empty( $dropdown ) ) {
+ $dropdown = sprintf( '<select id="%1$s" name="%1$s">', esc_attr( $dropdown_name ) );
+ $dropdown .= sprintf( '<option value="%1$s">%2$s</option>', esc_attr( $option_none_value ), esc_html( $show_option_none ) );
+ $dropdown .= '</select>';
+ }
// Hackily add in the data link parameter.
$dropdown = str_replace( '<select', '<select ' . $this->get_link(), $dropdown );
- printf(
- '<label class="customize-control-select"><span class="customize-control-title">%s</span> %s</label>',
- $this->label,
- $dropdown
- );
+ // Even more hacikly add auto-draft page stubs.
+ // @todo Eventually this should be removed in favor of the pages being injected into the underlying get_pages() call. See <https://github.com/xwp/wp-customize-posts/pull/250>.
+ $nav_menus_created_posts_setting = $this->manager->get_setting( 'nav_menus_created_posts' );
+ if ( $nav_menus_created_posts_setting && current_user_can( 'publish_pages' ) ) {
+ $auto_draft_page_options = '';
+ foreach ( $nav_menus_created_posts_setting->value() as $auto_draft_page_id ) {
+ $post = get_post( $auto_draft_page_id );
+ if ( $post && 'page' === $post->post_type ) {
+ $auto_draft_page_options .= sprintf( '<option value="%1$s">%2$s</option>', esc_attr( $post->ID ), esc_html( $post->post_title ) );
+ }
+ }
+ if ( $auto_draft_page_options ) {
+ $dropdown = str_replace( '</select>', $auto_draft_page_options . '</select>', $dropdown );
+ }
+ }
+
+ echo $dropdown;
+ ?>
+ </label>
+ <?php if ( $this->allow_addition && current_user_can( 'publish_pages' ) && current_user_can( 'edit_theme_options' ) ) : // Currently tied to menus functionality. ?>
+ <button type="button" class="button-link add-new-toggle"><?php
+ /* translators: %s: add new page label */
+ printf( __( '+ %s' ), get_post_type_object( 'page' )->labels->add_new_item );
+ ?></button>
+ <div class="new-content-item">
+ <label for="create-input-<?php echo $this->id; ?>"><span class="screen-reader-text"><?php _e( 'New page title' ); ?></span></label>
+ <input type="text" id="create-input-<?php echo $this->id; ?>" class="create-item-input" placeholder="<?php esc_attr_e( 'New page title…' ); ?>">
+ <button type="button" class="button add-content"><?php _e( 'Add' ); ?></button>
+ </div>
+ <?php endif;
+ break;
+ default:
+ ?>
+ <label>
+ <?php if ( ! empty( $this->label ) ) : ?>
+ <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
+ <?php endif;
+ if ( ! empty( $this->description ) ) : ?>
+ <span class="description customize-control-description"><?php echo $this->description; ?></span>
+ <?php endif; ?>
+ <input type="<?php echo esc_attr( $this->type ); ?>" <?php $this->input_attrs(); ?> value="<?php echo esc_attr( $this->value() ); ?>" <?php $this->link(); ?> />
+ </label>
+ <?php
break;
}
}
-}
-
-/**
- * Customize Color Control Class
- *
- * @package WordPress
- * @subpackage Customize
- * @since 3.4.0
- */
-class WP_Customize_Color_Control extends WP_Customize_Control {
- /**
- * @access public
- * @var string
- */
- public $type = 'color';
-
- /**
- * @access public
- * @var array
- */
- public $statuses;
-
- /**
- * Constructor.
- *
- * If $args['settings'] is not defined, use the $id as the setting ID.
- *
- * @since 3.4.0
- * @uses WP_Customize_Control::__construct()
- *
- * @param WP_Customize_Manager $manager
- * @param string $id
- * @param array $args
- */
- public function __construct( $manager, $id, $args = array() ) {
- $this->statuses = array( '' => __('Default') );
- parent::__construct( $manager, $id, $args );
- }
-
- /**
- * Enqueue control related scripts/styles.
- *
- * @since 3.4.0
- */
- public function enqueue() {
- wp_enqueue_script( 'wp-color-picker' );
- wp_enqueue_style( 'wp-color-picker' );
- }
-
- /**
- * Refresh the parameters passed to the JavaScript via JSON.
- *
- * @since 3.4.0
- * @uses WP_Customize_Control::to_json()
- */
- public function to_json() {
- parent::to_json();
- $this->json['statuses'] = $this->statuses;
- }
-
- /**
- * Render the control's content.
- *
- * @since 3.4.0
- */
- public function render_content() {
- $this_default = $this->setting->default;
- $default_attr = '';
- if ( $this_default ) {
- if ( false === strpos( $this_default, '#' ) )
- $this_default = '#' . $this_default;
- $default_attr = ' data-default-color="' . esc_attr( $this_default ) . '"';
- }
- // The input's value gets set by JS. Don't fill it.
- ?>
- <label>
- <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
- <div class="customize-control-content">
- <input class="color-picker-hex" type="text" maxlength="7" placeholder="<?php esc_attr_e( 'Hex Value' ); ?>"<?php echo $default_attr; ?> />
- </div>
- </label>
- <?php
- }
-}
-
-/**
- * Customize Upload Control Class
- *
- * @package WordPress
- * @subpackage Customize
- * @since 3.4.0
- */
-class WP_Customize_Upload_Control extends WP_Customize_Control {
- public $type = 'upload';
- public $removed = '';
- public $context;
- public $extensions = array();
-
- /**
- * Enqueue control related scripts/styles.
- *
- * @since 3.4.0
- */
- public function enqueue() {
- wp_enqueue_script( 'wp-plupload' );
- }
-
- /**
- * Refresh the parameters passed to the JavaScript via JSON.
- *
- * @since 3.4.0
- * @uses WP_Customize_Control::to_json()
- */
- public function to_json() {
- parent::to_json();
-
- $this->json['removed'] = $this->removed;
-
- if ( $this->context )
- $this->json['context'] = $this->context;
-
- if ( $this->extensions )
- $this->json['extensions'] = implode( ',', $this->extensions );
- }
-
- /**
- * Render the control's content.
- *
- * @since 3.4.0
- */
- public function render_content() {
- ?>
- <label>
- <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
- <div>
- <a href="#" class="button-secondary upload"><?php _e( 'Upload' ); ?></a>
- <a href="#" class="remove"><?php _e( 'Remove' ); ?></a>
- </div>
- </label>
- <?php
- }
-}
-
-/**
- * Customize Image Control Class
- *
- * @package WordPress
- * @subpackage Customize
- * @since 3.4.0
- */
-class WP_Customize_Image_Control extends WP_Customize_Upload_Control {
- public $type = 'image';
- public $get_url;
- public $statuses;
- public $extensions = array( 'jpg', 'jpeg', 'gif', 'png' );
-
- protected $tabs = array();
-
- /**
- * Constructor.
- *
- * If $args['settings'] is not defined, use the $id as the setting ID.
- *
- * @since 3.4.0
- * @uses WP_Customize_Upload_Control::__construct()
- *
- * @param WP_Customize_Manager $manager
- * @param string $id
- * @param array $args
- */
- public function __construct( $manager, $id, $args ) {
- $this->statuses = array( '' => __('No Image') );
-
- parent::__construct( $manager, $id, $args );
-
- $this->add_tab( 'upload-new', __('Upload New'), array( $this, 'tab_upload_new' ) );
- $this->add_tab( 'uploaded', __('Uploaded'), array( $this, 'tab_uploaded' ) );
-
- // Early priority to occur before $this->manager->prepare_controls();
- add_action( 'customize_controls_init', array( $this, 'prepare_control' ), 5 );
- }
/**
- * Prepares the control.
+ * Render the control's JS template.
*
- * If no tabs exist, removes the control from the manager.
- *
- * @since 3.4.2
- */
- public function prepare_control() {
- if ( ! $this->tabs )
- $this->manager->remove_control( $this->id );
- }
-
- /**
- * Refresh the parameters passed to the JavaScript via JSON.
+ * This function is only run for control types that have been registered with
+ * WP_Customize_Manager::register_control_type().
*
- * @since 3.4.0
- * @uses WP_Customize_Upload_Control::to_json()
- */
- public function to_json() {
- parent::to_json();
- $this->json['statuses'] = $this->statuses;
- }
-
- /**
- * Render the control's content.
+ * In the future, this will also print the template for the control's container
+ * element and be override-able.
*
- * @since 3.4.0
+ * @since 4.1.0
*/
- public function render_content() {
- $src = $this->value();
- if ( isset( $this->get_url ) )
- $src = call_user_func( $this->get_url, $src );
-
+ final public function print_template() {
?>
- <div class="customize-image-picker">
- <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
-
- <div class="customize-control-content">
- <div class="dropdown preview-thumbnail" tabindex="0">
- <div class="dropdown-content">
- <?php if ( empty( $src ) ): ?>
- <img style="display:none;" />
- <?php else: ?>
- <img src="<?php echo esc_url( set_url_scheme( $src ) ); ?>" />
- <?php endif; ?>
- <div class="dropdown-status"></div>
- </div>
- <div class="dropdown-arrow"></div>
- </div>
- </div>
-
- <div class="library">
- <ul>
- <?php foreach ( $this->tabs as $id => $tab ): ?>
- <li data-customize-tab='<?php echo esc_attr( $id ); ?>' tabindex='0'>
- <?php echo esc_html( $tab['label'] ); ?>
- </li>
- <?php endforeach; ?>
- </ul>
- <?php foreach ( $this->tabs as $id => $tab ): ?>
- <div class="library-content" data-customize-tab='<?php echo esc_attr( $id ); ?>'>
- <?php call_user_func( $tab['callback'] ); ?>
- </div>
- <?php endforeach; ?>
- </div>
-
- <div class="actions">
- <a href="#" class="remove"><?php _e( 'Remove Image' ); ?></a>
- </div>
- </div>
+ <script type="text/html" id="tmpl-customize-control-<?php echo $this->type; ?>-content">
+ <?php $this->content_template(); ?>
+ </script>
<?php
}
/**
- * Add a tab to the control.
+ * An Underscore (JS) template for this control's content (but not its container).
*
- * @since 3.4.0
- *
- * @param string $id
- * @param string $label
- * @param mixed $callback
- */
- public function add_tab( $id, $label, $callback ) {
- $this->tabs[ $id ] = array(
- 'label' => $label,
- 'callback' => $callback,
- );
- }
-
- /**
- * Remove a tab from the control.
+ * Class variables for this control class are available in the `data` JS object;
+ * export custom variables by overriding WP_Customize_Control::to_json().
*
- * @since 3.4.0
+ * @see WP_Customize_Control::print_template()
*
- * @param string $id
- */
- public function remove_tab( $id ) {
- unset( $this->tabs[ $id ] );
- }
-
- /**
- * @since 3.4.0
- */
- public function tab_upload_new() {
- if ( ! _device_can_upload() ) {
- echo '<p>' . sprintf( __('The web browser on your device cannot be used to upload files. You may be able to use the <a href="%s">native app for your device</a> instead.'), 'http://wordpress.org/mobile/' ) . '</p>';
- } else {
- ?>
- <div class="upload-dropzone">
- <?php _e('Drop a file here or <a href="#" class="upload">select a file</a>.'); ?>
- </div>
- <div class="upload-fallback">
- <span class="button-secondary"><?php _e('Select File'); ?></span>
- </div>
- <?php
- }
- }
-
- /**
- * @since 3.4.0
+ * @since 4.1.0
*/
- public function tab_uploaded() {
- ?>
- <div class="uploaded-target"></div>
- <?php
- }
+ protected function content_template() {}
- /**
- * @since 3.4.0
- *
- * @param string $url
- * @param string $thumbnail_url
- */
- public function print_tab_image( $url, $thumbnail_url = null ) {
- $url = set_url_scheme( $url );
- $thumbnail_url = ( $thumbnail_url ) ? set_url_scheme( $thumbnail_url ) : $url;
- ?>
- <a href="#" class="thumbnail" data-customize-image-value="<?php echo esc_url( $url ); ?>">
- <img src="<?php echo esc_url( $thumbnail_url ); ?>" />
- </a>
- <?php
- }
}
-/**
- * Customize Background Image Control Class
- *
- * @package WordPress
- * @subpackage Customize
- * @since 3.4.0
- */
-class WP_Customize_Background_Image_Control extends WP_Customize_Image_Control {
-
- /**
- * Constructor.
- *
- * @since 3.4.0
- * @uses WP_Customize_Image_Control::__construct()
- *
- * @param WP_Customize_Manager $manager
- */
- public function __construct( $manager ) {
- parent::__construct( $manager, 'background_image', array(
- 'label' => __( 'Background Image' ),
- 'section' => 'background_image',
- 'context' => 'custom-background',
- 'get_url' => 'get_background_image',
- ) );
-
- if ( $this->setting->default )
- $this->add_tab( 'default', __('Default'), array( $this, 'tab_default_background' ) );
- }
-
- /**
- * @since 3.4.0
- */
- public function tab_uploaded() {
- $backgrounds = get_posts( array(
- 'post_type' => 'attachment',
- 'meta_key' => '_wp_attachment_is_custom_background',
- 'meta_value' => $this->manager->get_stylesheet(),
- 'orderby' => 'none',
- 'nopaging' => true,
- ) );
-
- ?><div class="uploaded-target"></div><?php
-
- if ( empty( $backgrounds ) )
- return;
+/** WP_Customize_Color_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-color-control.php' );
- foreach ( (array) $backgrounds as $background )
- $this->print_tab_image( esc_url_raw( $background->guid ) );
- }
+/** WP_Customize_Media_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-media-control.php' );
- /**
- * @since 3.4.0
- * @uses WP_Customize_Image_Control::print_tab_image()
- */
- public function tab_default_background() {
- $this->print_tab_image( $this->setting->default );
- }
-}
+/** WP_Customize_Upload_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-upload-control.php' );
-/**
- * Customize Header Image Control Class
- *
- * @package WordPress
- * @subpackage Customize
- * @since 3.4.0
- */
-class WP_Customize_Header_Image_Control extends WP_Customize_Image_Control {
- /**
- * The processed default headers.
- * @since 3.4.2
- * @var array
- */
- protected $default_headers;
+/** WP_Customize_Image_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-image-control.php' );
- /**
- * The uploaded headers.
- * @since 3.4.2
- * @var array
- */
- protected $uploaded_headers;
+/** WP_Customize_Background_Image_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-control.php' );
- /**
- * Constructor.
- *
- * @since 3.4.0
- * @uses WP_Customize_Image_Control::__construct()
- * @uses WP_Customize_Image_Control::add_tab()
- *
- * @param WP_Customize_Manager $manager
- */
- public function __construct( $manager ) {
- parent::__construct( $manager, 'header_image', array(
- 'label' => __( 'Header Image' ),
- 'settings' => array(
- 'default' => 'header_image',
- 'data' => 'header_image_data',
- ),
- 'section' => 'header_image',
- 'context' => 'custom-header',
- 'removed' => 'remove-header',
- 'get_url' => 'get_header_image',
- 'statuses' => array(
- '' => __('Default'),
- 'remove-header' => __('No Image'),
- 'random-default-image' => __('Random Default Image'),
- 'random-uploaded-image' => __('Random Uploaded Image'),
- )
- ) );
-
- // Remove the upload tab.
- $this->remove_tab( 'upload-new' );
- }
+/** WP_Customize_Background_Position_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-position-control.php' );
- /**
- * Prepares the control.
- *
- * If no tabs exist, removes the control from the manager.
- *
- * @since 3.4.2
- */
- public function prepare_control() {
- global $custom_image_header;
- if ( empty( $custom_image_header ) )
- return parent::prepare_control();
+/** WP_Customize_Cropped_Image_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-cropped-image-control.php' );
- // Process default headers and uploaded headers.
- $custom_image_header->process_default_headers();
- $this->default_headers = $custom_image_header->default_headers;
- $this->uploaded_headers = get_uploaded_header_images();
+/** WP_Customize_Site_Icon_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-site-icon-control.php' );
- if ( $this->default_headers )
- $this->add_tab( 'default', __('Default'), array( $this, 'tab_default_headers' ) );
+/** WP_Customize_Header_Image_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-control.php' );
- if ( ! $this->uploaded_headers )
- $this->remove_tab( 'uploaded' );
+/** WP_Customize_Theme_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-theme-control.php' );
- return parent::prepare_control();
- }
+/** WP_Widget_Area_Customize_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-widget-area-customize-control.php' );
- /**
- * @since 3.4.0
- *
- * @param mixed $choice Which header image to select. (@see Custom_Image_Header::get_header_image() )
- * @param array $header
- */
- public function print_header_image( $choice, $header ) {
- $header['url'] = set_url_scheme( $header['url'] );
- $header['thumbnail_url'] = set_url_scheme( $header['thumbnail_url'] );
+/** WP_Widget_Form_Customize_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-widget-form-customize-control.php' );
- $header_image_data = array( 'choice' => $choice );
- foreach ( array( 'attachment_id', 'width', 'height', 'url', 'thumbnail_url' ) as $key ) {
- if ( isset( $header[ $key ] ) )
- $header_image_data[ $key ] = $header[ $key ];
- }
+/** WP_Customize_Nav_Menu_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-control.php' );
+/** WP_Customize_Nav_Menu_Item_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-control.php' );
- ?>
- <a href="#" class="thumbnail"
- data-customize-image-value="<?php echo esc_url( $header['url'] ); ?>"
- data-customize-header-image-data="<?php echo esc_attr( json_encode( $header_image_data ) ); ?>">
- <img src="<?php echo esc_url( $header['thumbnail_url'] ); ?>" />
- </a>
- <?php
- }
+/** WP_Customize_Nav_Menu_Location_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-location-control.php' );
- /**
- * @since 3.4.0
- */
- public function tab_uploaded() {
- ?><div class="uploaded-target"></div><?php
+/** WP_Customize_Nav_Menu_Name_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php' );
- foreach ( $this->uploaded_headers as $choice => $header )
- $this->print_header_image( $choice, $header );
- }
+/** WP_Customize_Nav_Menu_Auto_Add_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php' );
- /**
- * @since 3.4.0
- */
- public function tab_default_headers() {
- foreach ( $this->default_headers as $choice => $header )
- $this->print_header_image( $choice, $header );
- }
-}
\ No newline at end of file
+/** WP_Customize_New_Menu_Control class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-control.php' );
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff