mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-27 03:27:46 +01:00
0df3218cc2
Adds WP_Customize_Setting->sanitize_js_callback and 'customize_sanitize_js_$settingID' filter, to filter values before they're passed to JS using WP_Customize_Setting->js_value(). Adds support for regular hex colors to the color picker. Changes color methods: * sanitize_hex_color() accepts 3 and 6 digit hex colors (with hashes) and the empty string. * sanitize_hex_color_no_hash() accepts 3 and 6 digit hex colors (without hashes) and the empty string. * maybe_hash_hex_color() ensures that a hex color has a hash, and otherwise leaves the value untouched. git-svn-id: http://core.svn.wordpress.org/trunk@20936 1a063a9b-81f0-0310-95a4-ce76da25c4cd
483 lines
12 KiB
PHP
483 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* Customize Control Class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Customize
|
|
* @since 3.4.0
|
|
*/
|
|
|
|
class WP_Customize_Control {
|
|
public $manager;
|
|
public $id;
|
|
|
|
public $settings;
|
|
public $setting;
|
|
|
|
public $priority = 10;
|
|
public $section = '';
|
|
public $label = '';
|
|
// @todo: remove choices
|
|
public $choices = array();
|
|
|
|
public $json = array();
|
|
|
|
public $type = 'text';
|
|
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* If $args['settings'] is not defined, use the $id as the setting ID.
|
|
*
|
|
* @since 3.4.0
|
|
*/
|
|
function __construct( $manager, $id, $args = array() ) {
|
|
$keys = array_keys( get_object_vars( $this ) );
|
|
foreach ( $keys as $key ) {
|
|
if ( isset( $args[ $key ] ) )
|
|
$this->$key = $args[ $key ];
|
|
}
|
|
|
|
$this->manager = $manager;
|
|
$this->id = $id;
|
|
|
|
|
|
// Process settings.
|
|
if ( empty( $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 {
|
|
$this->setting = $this->manager->get_setting( $this->settings );
|
|
$settings['default'] = $this->setting;
|
|
}
|
|
$this->settings = $settings;
|
|
}
|
|
|
|
/**
|
|
* Enqueue control related scripts/styles.
|
|
*
|
|
* @since 3.4.0
|
|
*/
|
|
public function enqueue() {}
|
|
|
|
|
|
/**
|
|
* Fetch a setting's value.
|
|
* Grabs the main setting by default.
|
|
*
|
|
* @since 3.4.0
|
|
*/
|
|
public final function value( $setting_key = 'default' ) {
|
|
if ( isset( $this->settings[ $setting_key ] ) )
|
|
return $this->settings[ $setting_key ]->value();
|
|
}
|
|
|
|
/**
|
|
* Refresh the parameters passed to the JavaScript via JSON.
|
|
*
|
|
* @since 3.4.0
|
|
*/
|
|
public function to_json() {
|
|
$this->json['settings'] = array();
|
|
foreach ( $this->settings as $key => $setting ) {
|
|
$this->json['settings'][ $key ] = $setting->id;
|
|
}
|
|
|
|
$this->json['type'] = $this->type;
|
|
}
|
|
|
|
/**
|
|
* Check if the theme supports the control and check user capabilities.
|
|
*
|
|
* @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() {
|
|
foreach ( $this->settings as $setting ) {
|
|
if ( ! $setting->check_capabilities() )
|
|
return false;
|
|
}
|
|
|
|
$section = $this->manager->get_section( $this->section );
|
|
if ( isset( $section ) && ! $section->check_capabilities() )
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Check capabilities and render the control.
|
|
*
|
|
* @since 3.4.0
|
|
*/
|
|
public final function maybe_render() {
|
|
if ( ! $this->check_capabilities() )
|
|
return;
|
|
|
|
do_action( 'customize_render_control', $this );
|
|
do_action( 'customize_render_control_' . $this->id, $this );
|
|
|
|
$this->render();
|
|
}
|
|
|
|
/**
|
|
* Render the control. Renders the control wrapper, then calls $this->render_content().
|
|
*
|
|
* @since 3.4.0
|
|
*/
|
|
protected function render() {
|
|
$id = 'customize-control-' . str_replace( '[', '-', str_replace( ']', '', $this->id ) );
|
|
$class = 'customize-control customize-control-' . $this->type;
|
|
|
|
?><li id="<?php echo esc_attr( $id ); ?>" class="<?php echo esc_attr( $class ); ?>">
|
|
<?php $this->render_content(); ?>
|
|
</li><?php
|
|
}
|
|
|
|
public function get_link( $setting_key = 'default' ) {
|
|
if ( ! isset( $this->settings[ $setting_key ] ) )
|
|
return '';
|
|
|
|
return 'data-customize-setting-link="' . esc_attr( $this->settings[ $setting_key ]->id ) . '"';
|
|
}
|
|
|
|
public function link( $setting_key = 'default' ) {
|
|
echo $this->get_link( $setting_key );
|
|
}
|
|
|
|
/**
|
|
* Render the control's content.
|
|
*
|
|
* Allows the content to be overriden without having to rewrite the wrapper.
|
|
*
|
|
* @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 ); ?>
|
|
</label>
|
|
<?php
|
|
break;
|
|
case 'radio':
|
|
if ( empty( $this->choices ) )
|
|
return;
|
|
|
|
$name = '_customize-radio-' . $this->id;
|
|
|
|
?>
|
|
<span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
|
|
<?php
|
|
foreach ( $this->choices as $value => $label ) :
|
|
?>
|
|
<label>
|
|
<input type="radio" value="<?php echo esc_attr( $value ); ?>" name="<?php echo esc_attr( $name ); ?>" <?php $this->link(); checked( $this->value(), $value ); ?> />
|
|
<?php echo esc_html( $label ); ?><br/>
|
|
</label>
|
|
<?php
|
|
endforeach;
|
|
break;
|
|
case 'select':
|
|
if ( empty( $this->choices ) )
|
|
return;
|
|
|
|
?>
|
|
<label>
|
|
<span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
|
|
<select <?php $this->link(); ?>>
|
|
<?php
|
|
foreach ( $this->choices as $value => $label )
|
|
echo '<option value="' . esc_attr( $value ) . '"' . selected( $this->value(), $value, false ) . '>' . $label . '</option>';
|
|
?>
|
|
</select>
|
|
</label>
|
|
<?php
|
|
break;
|
|
case 'dropdown-pages':
|
|
$dropdown = wp_dropdown_pages(
|
|
array(
|
|
'name' => '_customize-dropdown-pages-' . $this->id,
|
|
'echo' => 0,
|
|
'show_option_none' => __( '— Select —' ),
|
|
'option_none_value' => '0',
|
|
'selected' => $this->value(),
|
|
)
|
|
);
|
|
|
|
// 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
|
|
);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
class WP_Customize_Color_Control extends WP_Customize_Control {
|
|
public $type = 'color';
|
|
public $statuses;
|
|
|
|
public function __construct( $manager, $id, $args = array() ) {
|
|
$this->statuses = array( '' => __('Default') );
|
|
parent::__construct( $manager, $id, $args );
|
|
}
|
|
|
|
public function enqueue() {
|
|
wp_enqueue_script( 'farbtastic' );
|
|
wp_enqueue_style( 'farbtastic' );
|
|
}
|
|
|
|
public function to_json() {
|
|
parent::to_json();
|
|
$this->json['statuses'] = $this->statuses;
|
|
}
|
|
|
|
public function render_content() {
|
|
?>
|
|
<label>
|
|
<span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
|
|
<div class="customize-control-content">
|
|
<div class="dropdown">
|
|
<div class="dropdown-content">
|
|
<div class="dropdown-status"></div>
|
|
</div>
|
|
<div class="dropdown-arrow"></div>
|
|
</div>
|
|
<input class="color-picker-hex" type="text" maxlength="7" placeholder="<?php esc_attr_e('Hex Value'); ?>" />
|
|
</div>
|
|
<div class="farbtastic-placeholder"></div>
|
|
</label>
|
|
<?php
|
|
}
|
|
}
|
|
|
|
class WP_Customize_Upload_Control extends WP_Customize_Control {
|
|
public $type = 'upload';
|
|
public $removed = '';
|
|
public $context;
|
|
|
|
public function enqueue() {
|
|
wp_enqueue_script( 'wp-plupload' );
|
|
}
|
|
|
|
public function to_json() {
|
|
parent::to_json();
|
|
|
|
$this->json['removed'] = $this->removed;
|
|
|
|
if ( $this->context )
|
|
$this->json['context'] = $this->context;
|
|
}
|
|
|
|
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
|
|
}
|
|
}
|
|
|
|
class WP_Customize_Image_Control extends WP_Customize_Upload_Control {
|
|
public $type = 'image';
|
|
public $get_url;
|
|
public $statuses;
|
|
|
|
protected $tabs = array();
|
|
|
|
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' ) );
|
|
}
|
|
|
|
public function to_json() {
|
|
parent::to_json();
|
|
$this->json['statuses'] = $this->statuses;
|
|
}
|
|
|
|
public function render_content() {
|
|
$src = $this->value();
|
|
if ( isset( $this->get_url ) )
|
|
$src = call_user_func( $this->get_url, $src );
|
|
|
|
?>
|
|
<label 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">
|
|
<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 ); ?>'>
|
|
<?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>
|
|
</label>
|
|
<?php
|
|
}
|
|
|
|
public function add_tab( $id, $label, $callback ) {
|
|
$this->tabs[ $id ] = array(
|
|
'label' => $label,
|
|
'callback' => $callback,
|
|
);
|
|
}
|
|
|
|
public function remove_tab( $id ) {
|
|
unset( $this->tabs[ $id ] );
|
|
}
|
|
|
|
public function tab_upload_new() {
|
|
?>
|
|
<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 tab_uploaded() {
|
|
?>
|
|
<div class="uploaded-target"></div>
|
|
<?php
|
|
}
|
|
|
|
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
|
|
}
|
|
}
|
|
|
|
class WP_Customize_Background_Image_Control extends WP_Customize_Image_Control {
|
|
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' ) );
|
|
}
|
|
|
|
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 tab_default_background() {
|
|
$this->print_tab_image( $this->setting->default );
|
|
}
|
|
}
|
|
|
|
class WP_Customize_Header_Image_Control extends WP_Customize_Image_Control {
|
|
public function __construct( $manager ) {
|
|
parent::__construct( $manager, 'header_image', array(
|
|
'label' => __( 'Header Image' ),
|
|
'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'),
|
|
)
|
|
) );
|
|
|
|
$this->add_tab( 'default', __('Default'), array( $this, 'tab_default_headers' ) );
|
|
}
|
|
|
|
public function tab_uploaded() {
|
|
$headers = get_uploaded_header_images();
|
|
|
|
?><div class="uploaded-target"></div><?php
|
|
|
|
foreach ( $headers as $header )
|
|
$this->print_tab_image( $header['url'], $header['thumbnail_url'] );
|
|
}
|
|
|
|
public function tab_default_headers() {
|
|
global $custom_image_header;
|
|
$custom_image_header->process_default_headers();
|
|
|
|
foreach ( $custom_image_header->default_headers as $header )
|
|
$this->print_tab_image( $header['url'], $header['thumbnail_url'] );
|
|
}
|
|
}
|