WP_Customize_Upload_Control – Class | Developer.WordPress.org

Customize Upload Control Class.

Description

More Information

This class is used with the Theme Customization API to allow a user to upload a file on the Theme Customizer in WordPress 3.4 or newer.

or more information on available Theme Customizer controls, see the codex entry for WP_Customize_Manager->add_control()

To force a specific image size see: WP_Customize_Cropped_Image_Control

Methods

Name	Description
WP_Customize_Upload_Control::to_json	Refresh the parameters passed to the JavaScript via JSON.

Source

class WP_Customize_Upload_Control extends WP_Customize_Media_Control {
	/**
	 * Control type.
	 *
	 * @since 3.4.0
	 * @var string
	 */
	public $type = 'upload';

	/**
	 * Media control mime type.
	 *
	 * @since 4.1.0
	 * @var string
	 */
	public $mime_type = '';

	/**
	 * Button labels.
	 *
	 * @since 4.1.0
	 * @var array
	 */
	public $button_labels = array();

	public $removed = '';         // Unused.
	public $context;              // Unused.
	public $extensions = array(); // Unused.

	/**
	 * Refresh the parameters passed to the JavaScript via JSON.
	 *
	 * @since 3.4.0
	 *
	 * @uses WP_Customize_Media_Control::to_json()
	 */
	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 );
			}
		}
	}
}

View all references View on Trac View on GitHub

Uses	Description
WP_Customize_Media_Control`wp-includes/customize/class-wp-customize-media-control.php`	Customize Media Control class.

Used by	Description
WP_Customize_Image_Control`wp-includes/customize/class-wp-customize-image-control.php`	Customize Image Control class.

Changelog

Version	Description
3.4.0	Introduced.

User Contributed Notes

Skip to note 2 content

Chetan Satasiya 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -3You must log in to vote on the helpfulness of this note
This class is used with the Theme Customization API to allow a user to upload a file on the Theme Customizer in WordPress 3.4 or newer.
```
$wp_customize->add_control( 
	new WP_Customize_Upload_Control( 
	$wp_customize, 
	'your_setting_id', 
	array(
		'label'      => __( 'Header Color', 'mytheme' ),
		'section'    => 'your_section_id',
		'settings'   => 'your_setting_id',
	) ) 
);
```
Log in to add feedback

class WP_Customize_Upload_Control {}

In this article