<?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
+ * @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
* @access public
* @var int
*/
- public $priority = 10;
+ public $priority = 10;
+
+ /**
+ * @access public
+ * @var string
+ */
+ public $section = '';
/**
* @access public
* @var string
*/
- public $section = '';
+ public $label = '';
/**
* @access public
* @var string
*/
- public $label = '';
+ public $description = '';
/**
* @todo: Remove choices
* @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
*/
*/
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 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 ) ) {
*/
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 bool 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;
+ }
+
+ /**
+ * 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;
}
/**
*
* @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;
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();
+ $template = trim( ob_get_contents() );
+ ob_end_clean();
+ return $template;
+ }
+
/**
* 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
*/
}
/**
- * 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 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':
- ?>
- <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->link(); ?>><?php echo esc_textarea( $this->value() ); ?></textarea>
+ </label>
+ <?php
+ break;
case 'dropdown-pages':
$dropdown = wp_dropdown_pages(
array(
$dropdown
);
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;
}
}
+
+ /**
+ * Render the control's JS template.
+ *
+ * This function is only run for control types that have been registered with
+ * {@see WP_Customize_Manager::register_control_type()}.
+ *
+ * In the future, this will also print the template for the control's container
+ * element and be override-able.
+ *
+ * @since 4.1.0
+ */
+ final public function print_template() {
+ ?>
+ <script type="text/html" id="tmpl-customize-control-<?php echo $this->type; ?>-content">
+ <?php $this->content_template(); ?>
+ </script>
+ <?php
+ }
+
+ /**
+ * An Underscore (JS) template for this control's content (but not its container).
+ *
+ * Class variables for this control class are available in the `data` JS object;
+ * export custom variables by overriding {@see WP_Customize_Control::to_json()}.
+ *
+ * @see WP_Customize_Control::print_template()
+ *
+ * @since 4.1.0
+ */
+ protected function content_template() {}
+
}
/**
- * Customize Color Control Class
+ * Customize Color Control class.
*
- * @package WordPress
- * @subpackage Customize
* @since 3.4.0
+ *
+ * @see WP_Customize_Control
*/
class WP_Customize_Color_Control extends WP_Customize_Control {
/**
/**
* Constructor.
*
- * If $args['settings'] is not defined, use the $id as the setting ID.
- *
* @since 3.4.0
* @uses WP_Customize_Control::__construct()
*
}
/**
- * Enqueue control related scripts/styles.
+ * Enqueue scripts/styles for the color picker.
*
* @since 3.4.0
*/
public function to_json() {
parent::to_json();
$this->json['statuses'] = $this->statuses;
+ $this->json['defaultValue'] = $this->setting->default;
}
/**
- * Render the control's content.
+ * Don't render the control content from PHP, as it's rendered via JS on load.
*
* @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.
+ public function render_content() {}
+
+ /**
+ * Render a JS template for the content of the color picker control.
+ *
+ * @since 4.1.0
+ */
+ public function content_template() {
?>
+ <# var defaultValue = '';
+ if ( data.defaultValue ) {
+ if ( '#' !== data.defaultValue.substring( 0, 1 ) ) {
+ defaultValue = '#' + data.defaultValue;
+ } else {
+ defaultValue = data.defaultValue;
+ }
+ defaultValue = ' data-default-color=' + defaultValue; // Quotes added automatically.
+ } #>
<label>
- <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
+ <# if ( data.label ) { #>
+ <span class="customize-control-title">{{{ data.label }}}</span>
+ <# } #>
+ <# if ( data.description ) { #>
+ <span class="description customize-control-description">{{{ data.description }}}</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 ?> />
+ <input class="color-picker-hex" type="text" maxlength="7" placeholder="<?php esc_attr_e( 'Hex Value' ); ?>" {{ defaultValue }} />
</div>
</label>
<?php
}
/**
- * Customize Upload Control Class
+ * Customize Media Control class.
*
- * @package WordPress
- * @subpackage Customize
- * @since 3.4.0
+ * @since 4.2.0
+ *
+ * @see WP_Customize_Control
*/
-class WP_Customize_Upload_Control extends WP_Customize_Control {
- public $type = 'upload';
- public $removed = '';
- public $context;
- public $extensions = array();
-
+class WP_Customize_Media_Control extends WP_Customize_Control {
/**
- * Enqueue control related scripts/styles.
+ * Control type.
*
- * @since 3.4.0
+ * @since 4.2.0
+ * @access public
+ * @var string
*/
- public function enqueue() {
- wp_enqueue_script( 'wp-plupload' );
- }
+ public $type = 'media';
/**
- * Refresh the parameters passed to the JavaScript via JSON.
+ * Media control mime type.
*
- * @since 3.4.0
- * @uses WP_Customize_Control::to_json()
+ * @since 4.2.0
+ * @access public
+ * @var string
*/
- 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 );
- }
+ public $mime_type = '';
/**
- * Render the control's content.
+ * Button labels.
*
- * @since 3.4.0
+ * @since 4.2.0
+ * @access public
+ * @var array
*/
- 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();
+ public $button_labels = array();
/**
* Constructor.
*
- * If $args['settings'] is not defined, use the $id as the setting ID.
+ * @since 4.1.0
+ * @since 4.2.0 Moved from WP_Customize_Upload_Control.
*
- * @since 3.4.0
- * @uses WP_Customize_Upload_Control::__construct()
- *
- * @param WP_Customize_Manager $manager
- * @param string $id
- * @param array $args
+ * @param WP_Customize_Manager $manager {@see WP_Customize_Manager} instance.
*/
- public function __construct( $manager, $id, $args ) {
- $this->statuses = array( '' => __('No Image') );
-
+ public function __construct( $manager, $id, $args = array() ) {
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 );
+ $this->button_labels = array(
+ 'select' => __( 'Select File' ),
+ 'change' => __( 'Change File' ),
+ 'default' => __( 'Default' ),
+ 'remove' => __( 'Remove' ),
+ 'placeholder' => __( 'No file selected' ),
+ 'frame_title' => __( 'Select File' ),
+ 'frame_button' => __( 'Choose File' ),
+ );
}
/**
- * Prepares the control.
- *
- * If no tabs exist, removes the control from the manager.
+ * Enqueue control related scripts/styles.
*
- * @since 3.4.2
+ * @since 3.4.0
+ * @since 4.2.0 Moved from WP_Customize_Upload_Control.
*/
- public function prepare_control() {
- if ( ! $this->tabs )
- $this->manager->remove_control( $this->id );
+ public function enqueue() {
+ wp_enqueue_media();
}
/**
* Refresh the parameters passed to the JavaScript via JSON.
*
* @since 3.4.0
- * @uses WP_Customize_Upload_Control::to_json()
+ * @since 4.2.0 Moved from WP_Customize_Upload_Control.
+ *
+ * @see WP_Customize_Control::to_json()
*/
public function to_json() {
parent::to_json();
- $this->json['statuses'] = $this->statuses;
+ $this->json['mime_type'] = $this->mime_type;
+ $this->json['button_labels'] = $this->button_labels;
+
+ $value = $this->value();
+
+ if ( is_object( $this->setting ) ) {
+ if ( $this->setting->default ) {
+ // Fake an attachment model - needs all fields used by template.
+ // Note that the default value must be a URL, NOT an attachment ID.
+ $type = in_array( substr( $this->setting->default, -3 ), array( 'jpg', 'png', 'gif', 'bmp' ) ) ? 'image' : 'document';
+ $default_attachment = array(
+ 'id' => 1,
+ 'url' => $this->setting->default,
+ 'type' => $type,
+ 'icon' => wp_mime_type_icon( $type ),
+ 'title' => basename( $this->setting->default ),
+ );
+
+ if ( 'image' === $type ) {
+ $default_attachment['sizes'] = array(
+ 'full' => array( 'url' => $this->setting->default ),
+ );
+ }
+
+ $this->json['defaultAttachment'] = $default_attachment;
+ }
+
+ if ( $value && $this->setting->default && $value === $this->setting->default ) {
+ // Set the default as the attachment.
+ $this->json['attachment'] = $this->json['defaultAttachment'];
+ } elseif ( $value ) {
+ $this->json['attachment'] = wp_prepare_attachment_for_js( $value );
+ }
+ }
}
/**
- * Render the control's content.
+ * Don't render any content for this control from PHP.
*
* @since 3.4.0
+ * @since 4.2.0 Moved from WP_Customize_Upload_Control.
+ *
+ * @see WP_Customize_Media_Control::content_template()
*/
- public function render_content() {
- $src = $this->value();
- if ( isset( $this->get_url ) )
- $src = call_user_func( $this->get_url, $src );
+ public function render_content() {}
+ /**
+ * Render a JS template for the content of the media control.
+ *
+ * @since 4.1.0
+ * @since 4.2.0 Moved from WP_Customize_Upload_Control.
+ */
+ public function content_template() {
?>
- <div class="customize-image-picker">
- <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
+ <label for="{{ data.settings['default'] }}-button">
+ <# if ( data.label ) { #>
+ <span class="customize-control-title">{{ data.label }}</span>
+ <# } #>
+ <# if ( data.description ) { #>
+ <span class="description customize-control-description">{{{ data.description }}}</span>
+ <# } #>
+ </label>
- <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>
+ <# if ( data.attachment && data.attachment.id ) { #>
+ <div class="current">
+ <div class="container">
+ <div class="attachment-media-view attachment-media-view-{{ data.attachment.type }} {{ data.attachment.orientation }}">
+ <div class="thumbnail thumbnail-{{ data.attachment.type }}">
+ <# if ( 'image' === data.attachment.type && data.attachment.sizes && data.attachment.sizes.medium ) { #>
+ <img class="attachment-thumb" src="{{ data.attachment.sizes.medium.url }}" draggable="false" />
+ <# } else if ( 'image' === data.attachment.type && data.attachment.sizes && data.attachment.sizes.full ) { #>
+ <img class="attachment-thumb" src="{{ data.attachment.sizes.full.url }}" draggable="false" />
+ <# } else if ( 'audio' === data.attachment.type ) { #>
+ <# if ( data.attachment.image && data.attachment.image.src && data.attachment.image.src !== data.attachment.icon ) { #>
+ <img src="{{ data.attachment.image.src }}" class="thumbnail" draggable="false" />
+ <# } else { #>
+ <img src="{{ data.attachment.icon }}" class="attachment-thumb type-icon" draggable="false" />
+ <# } #>
+ <p class="attachment-meta attachment-meta-title">“{{ data.attachment.title }}”</p>
+ <# if ( data.attachment.album || data.attachment.meta.album ) { #>
+ <p class="attachment-meta"><em>{{ data.attachment.album || data.attachment.meta.album }}</em></p>
+ <# } #>
+ <# if ( data.attachment.artist || data.attachment.meta.artist ) { #>
+ <p class="attachment-meta">{{ data.attachment.artist || data.attachment.meta.artist }}</p>
+ <# } #>
+ <audio style="visibility: hidden" controls class="wp-audio-shortcode" width="100%" preload="none">
+ <source type="{{ data.attachment.mime }}" src="{{ data.attachment.url }}"/>
+ </audio>
+ <# } else if ( 'video' === data.attachment.type ) { #>
+ <div class="wp-media-wrapper wp-video">
+ <video controls="controls" class="wp-video-shortcode" preload="metadata"
+ <# if ( data.attachment.image && data.attachment.image.src !== data.attachment.icon ) { #>poster="{{ data.attachment.image.src }}"<# } #>>
+ <source type="{{ data.attachment.mime }}" src="{{ data.attachment.url }}"/>
+ </video>
+ </div>
+ <# } else { #>
+ <img class="attachment-thumb type-icon" src="{{ data.attachment.icon }}" class="icon" draggable="false" />
+ <p class="attachment-title">{{ data.attachment.title }}</p>
+ <# } #>
+ </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 class="actions">
+ <button type="button" class="button remove-button"><?php echo $this->button_labels['remove']; ?></button>
+ <button type="button" class="button upload-button" id="{{ data.settings['default'] }}-button"><?php echo $this->button_labels['change']; ?></button>
+ <div style="clear:both"></div>
+ </div>
+ <# } else { #>
+ <div class="current">
+ <div class="container">
+ <div class="placeholder">
+ <div class="inner">
+ <span>
+ <?php echo $this->button_labels['placeholder']; ?>
+ </span>
+ </div>
</div>
- <?php endforeach; ?>
+ </div>
</div>
-
<div class="actions">
- <a href="#" class="remove"><?php _e( 'Remove Image' ); ?></a>
+ <# if ( data.defaultAttachment ) { #>
+ <button type="button" class="button default-button"><?php echo $this->button_labels['default']; ?></button>
+ <# } #>
+ <button type="button" class="button upload-button" id="{{ data.settings['default'] }}-button"><?php echo $this->button_labels['select']; ?></button>
+ <div style="clear:both"></div>
</div>
- </div>
+ <# } #>
<?php
}
+}
+
+/**
+ * Customize Upload Control Class.
+ *
+ * @since 3.4.0
+ *
+ * @see WP_Customize_Media_Control
+ */
+class WP_Customize_Upload_Control extends WP_Customize_Media_Control {
+ public $type = 'upload';
+ public $mime_type = '';
+ public $button_labels = array();
+ public $removed = ''; // unused
+ public $context; // unused
+ public $extensions = array(); // unused
/**
- * Add a tab to the control.
+ * Refresh the parameters passed to the JavaScript via JSON.
*
* @since 3.4.0
*
- * @param string $id
- * @param string $label
- * @param mixed $callback
+ * @uses WP_Customize_Media_Control::to_json()
*/
- public function add_tab( $id, $label, $callback ) {
- $this->tabs[ $id ] = array(
- 'label' => $label,
- 'callback' => $callback,
- );
+ public function to_json() {
+ parent::to_json();
+
+ $value = $this->value();
+ if ( $value ) {
+ // Get the attachment model for the existing file.
+ $attachment_id = attachment_url_to_postid( $value );
+ if ( $attachment_id ) {
+ $this->json['attachment'] = wp_prepare_attachment_for_js( $attachment_id );
+ }
+ }
}
+}
+
+/**
+ * Customize Image Control class.
+ *
+ * @since 3.4.0
+ *
+ * @see WP_Customize_Upload_Control
+ */
+class WP_Customize_Image_Control extends WP_Customize_Upload_Control {
+ public $type = 'image';
+ public $mime_type = 'image';
/**
- * Remove a tab from the control.
+ * Constructor.
*
* @since 3.4.0
+ * @uses WP_Customize_Upload_Control::__construct()
*
+ * @param WP_Customize_Manager $manager
* @param string $id
+ * @param array $args
*/
- public function remove_tab( $id ) {
- unset( $this->tabs[ $id ] );
+ public function __construct( $manager, $id, $args = array() ) {
+ parent::__construct( $manager, $id, $args );
+
+ $this->button_labels = array(
+ 'select' => __( 'Select Image' ),
+ 'change' => __( 'Change Image' ),
+ 'remove' => __( 'Remove' ),
+ 'default' => __( 'Default' ),
+ 'placeholder' => __( 'No image selected' ),
+ 'frame_title' => __( 'Select Image' ),
+ 'frame_button' => __( 'Choose Image' ),
+ );
}
+ /**
+ * @since 3.4.2
+ * @deprecated 4.1.0
+ */
+ public function prepare_control() {}
+
/**
* @since 3.4.0
+ * @deprecated 4.1.0
+ *
+ * @param string $id
+ * @param string $label
+ * @param mixed $callback
*/
- public function tab_upload_new() {
- if ( ! _device_can_upload() ) {
- ?>
- <p><?php _e('The web browser on your device cannot be used to upload files. You may be able to use the <a href="http://wordpress.org/extend/mobile/">native app for your device</a> instead.'); ?></p>
- <?php
- } 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
- }
- }
+ public function add_tab( $id, $label, $callback ) {}
/**
* @since 3.4.0
+ * @deprecated 4.1.0
+ *
+ * @param string $id
*/
- public function tab_uploaded() {
- ?>
- <div class="uploaded-target"></div>
- <?php
- }
+ public function remove_tab( $id ) {}
/**
* @since 3.4.0
+ * @deprecated 4.1.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
- }
+ public function print_tab_image( $url, $thumbnail_url = null ) {}
}
/**
- * Customize Background Image Control Class
+ * Customize Background Image Control class.
*
- * @package WordPress
- * @subpackage Customize
* @since 3.4.0
+ *
+ * @see WP_Customize_Image_Control
*/
class WP_Customize_Background_Image_Control extends WP_Customize_Image_Control {
+ public $type = 'background';
/**
* Constructor.
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
+ * Enqueue control related scripts/styles.
+ *
+ * @since 4.1.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;
-
- foreach ( (array) $backgrounds as $background )
- $this->print_tab_image( esc_url_raw( $background->guid ) );
- }
+ public function enqueue() {
+ parent::enqueue();
- /**
- * @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_localize_script( 'customize-controls', '_wpCustomizeBackground', array(
+ 'nonces' => array(
+ 'add' => wp_create_nonce( 'background-add' ),
+ ),
+ ) );
}
}
/**
- * Customize Header Image Control Class
+ * Customize Header Image Control class.
*
- * @package WordPress
- * @subpackage Customize
* @since 3.4.0
+ *
+ * @see WP_Customize_Image_Control
*/
class WP_Customize_Header_Image_Control extends WP_Customize_Image_Control {
- /**
- * The processed default headers.
- * @since 3.4.2
- * @var array
- */
- protected $default_headers;
-
- /**
- * The uploaded headers.
- * @since 3.4.2
- * @var array
- */
- protected $uploaded_headers;
+ public $type = 'header';
+ public $uploaded_headers;
+ public $default_headers;
/**
- * 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 ) {
'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' );
}
- /**
- * Prepares the control.
- *
- * If no tabs exist, removes the control from the manager.
- *
- * @since 3.4.2
- */
+ public function enqueue() {
+ wp_enqueue_media();
+ wp_enqueue_script( 'customize-views' );
+
+ $this->prepare_control();
+
+ wp_localize_script( 'customize-views', '_wpCustomizeHeader', array(
+ 'data' => array(
+ 'width' => absint( get_theme_support( 'custom-header', 'width' ) ),
+ 'height' => absint( get_theme_support( 'custom-header', 'height' ) ),
+ 'flex-width' => absint( get_theme_support( 'custom-header', 'flex-width' ) ),
+ 'flex-height' => absint( get_theme_support( 'custom-header', 'flex-height' ) ),
+ 'currentImgSrc' => $this->get_current_image_src(),
+ ),
+ 'nonces' => array(
+ 'add' => wp_create_nonce( 'header-add' ),
+ 'remove' => wp_create_nonce( 'header-remove' ),
+ ),
+ 'uploads' => $this->uploaded_headers,
+ 'defaults' => $this->default_headers
+ ) );
+
+ parent::enqueue();
+ }
+
public function prepare_control() {
global $custom_image_header;
- if ( empty( $custom_image_header ) )
- return parent::prepare_control();
+ if ( empty( $custom_image_header ) ) {
+ return;
+ }
// 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();
+ $this->default_headers = $custom_image_header->get_default_header_images();
+ $this->uploaded_headers = $custom_image_header->get_uploaded_header_images();
+ }
+
+ public function print_header_image_template() {
+ ?>
+ <script type="text/template" id="tmpl-header-choice">
+ <# if (data.random) { #>
+ <button type="button" class="button display-options random">
+ <span class="dashicons dashicons-randomize dice"></span>
+ <# if ( data.type === 'uploaded' ) { #>
+ <?php _e( 'Randomize uploaded headers' ); ?>
+ <# } else if ( data.type === 'default' ) { #>
+ <?php _e( 'Randomize suggested headers' ); ?>
+ <# } #>
+ </button>
+
+ <# } else { #>
+
+ <# if (data.type === 'uploaded') { #>
+ <div class="dashicons dashicons-no close"></div>
+ <# } #>
+
+ <button type="button" class="choice thumbnail"
+ data-customize-image-value="{{{data.header.url}}}"
+ data-customize-header-image-data="{{JSON.stringify(data.header)}}">
+ <span class="screen-reader-text"><?php _e( 'Set image' ); ?></span>
+ <img src="{{{data.header.thumbnail_url}}}" alt="{{{data.header.alt_text || data.header.description}}}">
+ </button>
+
+ <# } #>
+ </script>
+
+ <script type="text/template" id="tmpl-header-current">
+ <# if (data.choice) { #>
+ <# if (data.random) { #>
+
+ <div class="placeholder">
+ <div class="inner">
+ <span><span class="dashicons dashicons-randomize dice"></span>
+ <# if ( data.type === 'uploaded' ) { #>
+ <?php _e( 'Randomizing uploaded headers' ); ?>
+ <# } else if ( data.type === 'default' ) { #>
+ <?php _e( 'Randomizing suggested headers' ); ?>
+ <# } #>
+ </span>
+ </div>
+ </div>
+
+ <# } else { #>
- if ( $this->default_headers )
- $this->add_tab( 'default', __('Default'), array( $this, 'tab_default_headers' ) );
+ <img src="{{{data.header.thumbnail_url}}}" alt="{{{data.header.alt_text || data.header.description}}}" tabindex="0"/>
- if ( ! $this->uploaded_headers )
- $this->remove_tab( 'uploaded' );
+ <# } #>
+ <# } else { #>
- return parent::prepare_control();
+ <div class="placeholder">
+ <div class="inner">
+ <span>
+ <?php _e( 'No image set' ); ?>
+ </span>
+ </div>
+ </div>
+
+ <# } #>
+ </script>
+ <?php
+ }
+
+ public function get_current_image_src() {
+ $src = $this->value();
+ if ( isset( $this->get_url ) ) {
+ $src = call_user_func( $this->get_url, $src );
+ return $src;
+ }
+ return null;
+ }
+
+ public function render_content() {
+ $this->print_header_image_template();
+ $visibility = $this->get_current_image_src() ? '' : ' style="display:none" ';
+ $width = absint( get_theme_support( 'custom-header', 'width' ) );
+ $height = absint( get_theme_support( 'custom-header', 'height' ) );
+ ?>
+
+
+ <div class="customize-control-content">
+ <p class="customizer-section-intro">
+ <?php
+ if ( $width && $height ) {
+ printf( __( 'While you can crop images to your liking after clicking <strong>Add new image</strong>, your theme recommends a header size of <strong>%s × %s</strong> pixels.' ), $width, $height );
+ } elseif ( $width ) {
+ printf( __( 'While you can crop images to your liking after clicking <strong>Add new image</strong>, your theme recommends a header width of <strong>%s</strong> pixels.' ), $width );
+ } else {
+ printf( __( 'While you can crop images to your liking after clicking <strong>Add new image</strong>, your theme recommends a header height of <strong>%s</strong> pixels.' ), $height );
+ }
+ ?>
+ </p>
+ <div class="current">
+ <span class="customize-control-title">
+ <?php _e( 'Current header' ); ?>
+ </span>
+ <div class="container">
+ </div>
+ </div>
+ <div class="actions">
+ <?php /* translators: Hide as in hide header image via the Customizer */ ?>
+ <button type="button"<?php echo $visibility ?> class="button remove"><?php _ex( 'Hide image', 'custom header' ); ?></button>
+ <?php /* translators: New as in add new header image via the Customizer */ ?>
+ <button type="button" class="button new"><?php _ex( 'Add new image', 'header image' ); ?></button>
+ <div style="clear:both"></div>
+ </div>
+ <div class="choices">
+ <span class="customize-control-title header-previously-uploaded">
+ <?php _ex( 'Previously uploaded', 'custom headers' ); ?>
+ </span>
+ <div class="uploaded">
+ <div class="list">
+ </div>
+ </div>
+ <span class="customize-control-title header-default">
+ <?php _ex( 'Suggested', 'custom headers' ); ?>
+ </span>
+ <div class="default">
+ <div class="list">
+ </div>
+ </div>
+ </div>
+ </div>
+ <?php
}
+}
+
+/**
+ * Customize Theme Control class.
+ *
+ * @since 4.2.0
+ *
+ * @see WP_Customize_Control
+ */
+class WP_Customize_Theme_Control extends WP_Customize_Control {
/**
- * @since 3.4.0
+ * Customize control type.
*
- * @param mixed $choice Which header image to select. (@see Custom_Image_Header::get_header_image() )
- * @param array $header
+ * @since 4.2.0
+ * @access public
+ * @var string
*/
- public function print_header_image( $choice, $header ) {
- $header['url'] = set_url_scheme( $header['url'] );
- $header['thumbnail_url'] = set_url_scheme( $header['thumbnail_url'] );
+ public $type = 'theme';
- $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 ];
- }
+ /**
+ * Theme object.
+ *
+ * @since 4.2.0
+ * @access public
+ * @var WP_Theme
+ */
+ public $theme;
+
+ /**
+ * Refresh the parameters passed to the JavaScript via JSON.
+ *
+ * @since 4.2.0
+ * @access public
+ *
+ * @see WP_Customize_Control::to_json()
+ */
+ public function to_json() {
+ parent::to_json();
+ $this->json['theme'] = $this->theme;
+ }
+
+ /**
+ * Don't render the control content from PHP, as it's rendered via JS on load.
+ *
+ * @since 4.2.0
+ * @access public
+ */
+ public function render_content() {}
+
+ /**
+ * Render a JS template for theme display.
+ *
+ * @since 4.2.0
+ * @access public
+ */
+ public function content_template() {
+ $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
+ $active_url = esc_url( remove_query_arg( 'theme', $current_url ) );
+ $preview_url = esc_url( add_query_arg( 'theme', '__THEME__', $current_url ) ); // Token because esc_url() strips curly braces.
+ $preview_url = str_replace( '__THEME__', '{{ data.theme.id }}', $preview_url );
+ ?>
+ <# if ( data.theme.isActiveTheme ) { #>
+ <div class="theme active" tabindex="0" data-preview-url="<?php echo esc_attr( $active_url ); ?>" aria-describedby="{{ data.theme.id }}-action {{ data.theme.id }}-name">
+ <# } else { #>
+ <div class="theme" tabindex="0" data-preview-url="<?php echo esc_attr( $preview_url ); ?>" aria-describedby="{{ data.theme.id }}-action {{ data.theme.id }}-name">
+ <# } #>
+
+ <# if ( data.theme.screenshot[0] ) { #>
+ <div class="theme-screenshot">
+ <img data-src="{{ data.theme.screenshot[0] }}" alt="" />
+ </div>
+ <# } else { #>
+ <div class="theme-screenshot blank"></div>
+ <# } #>
+
+ <# if ( data.theme.isActiveTheme ) { #>
+ <span class="more-details" id="{{ data.theme.id }}-action"><?php _e( 'Customize' ); ?></span>
+ <# } else { #>
+ <span class="more-details" id="{{ data.theme.id }}-action"><?php _e( 'Live Preview' ); ?></span>
+ <# } #>
+ <div class="theme-author"><?php printf( __( 'By %s' ), '{{ data.theme.author }}' ); ?></div>
+
+ <# if ( data.theme.isActiveTheme ) { #>
+ <h3 class="theme-name" id="{{ data.theme.id }}-name">
+ <?php
+ /* translators: %s: theme name */
+ printf( __( '<span>Active:</span> %s' ), '{{ data.theme.name }}' );
+ ?>
+ </h3>
+ <# } else { #>
+ <h3 class="theme-name" id="{{ data.theme.id }}-name">{{ data.theme.name }}</h3>
+ <div class="theme-actions">
+ <button type="button" class="button theme-details"><?php _e( 'Theme Details' ); ?></button>
+ </div>
+ <# } #>
+ </div>
+ <?php
+ }
+}
+
+/**
+ * Widget Area Customize Control class.
+ *
+ * @since 3.9.0
+ *
+ * @see WP_Customize_Control
+ */
+class WP_Widget_Area_Customize_Control extends WP_Customize_Control {
+ public $type = 'sidebar_widgets';
+ public $sidebar_id;
+
+ public function to_json() {
+ parent::to_json();
+ $exported_properties = array( 'sidebar_id' );
+ foreach ( $exported_properties as $key ) {
+ $this->json[ $key ] = $this->$key;
+ }
+ }
+ public function render_content() {
?>
- <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>
+ <span class="button-secondary add-new-widget" tabindex="0">
+ <?php _e( 'Add a Widget' ); ?>
+ </span>
+
+ <span class="reorder-toggle" tabindex="0">
+ <span class="reorder"><?php _ex( 'Reorder', 'Reorder widgets in Customizer' ); ?></span>
+ <span class="reorder-done"><?php _ex( 'Done', 'Cancel reordering widgets in Customizer' ); ?></span>
+ </span>
<?php
}
- /**
- * @since 3.4.0
- */
- public function tab_uploaded() {
- ?><div class="uploaded-target"></div><?php
+}
+
+/**
+ * Widget Form Customize Control class.
+ *
+ * @since 3.9.0
+ *
+ * @see WP_Customize_Control
+ */
+class WP_Widget_Form_Customize_Control extends WP_Customize_Control {
+ public $type = 'widget_form';
+ public $widget_id;
+ public $widget_id_base;
+ public $sidebar_id;
+ public $is_new = false;
+ public $width;
+ public $height;
+ public $is_wide = false;
- foreach ( $this->uploaded_headers as $choice => $header )
- $this->print_header_image( $choice, $header );
+ public function to_json() {
+ parent::to_json();
+ $exported_properties = array( 'widget_id', 'widget_id_base', 'sidebar_id', 'width', 'height', 'is_wide' );
+ foreach ( $exported_properties as $key ) {
+ $this->json[ $key ] = $this->$key;
+ }
+ }
+
+ public function render_content() {
+ global $wp_registered_widgets;
+ require_once ABSPATH . '/wp-admin/includes/widgets.php';
+
+ $widget = $wp_registered_widgets[ $this->widget_id ];
+ if ( ! isset( $widget['params'][0] ) ) {
+ $widget['params'][0] = array();
+ }
+
+ $args = array(
+ 'widget_id' => $widget['id'],
+ 'widget_name' => $widget['name'],
+ );
+
+ $args = wp_list_widget_controls_dynamic_sidebar( array( 0 => $args, 1 => $widget['params'][0] ) );
+ echo $this->manager->widgets->get_widget_control( $args );
}
/**
- * @since 3.4.0
+ * Whether the current widget is rendered on the page.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @return bool Whether the widget is rendered.
*/
- public function tab_default_headers() {
- foreach ( $this->default_headers as $choice => $header )
- $this->print_header_image( $choice, $header );
+ public function active_callback() {
+ return $this->manager->widgets->is_widget_rendered( $this->widget_id );
}
-}
\ No newline at end of file
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff