WP_Customize_Upload_Control

Customize Upload Control Class.


Description Description

See also See also


Top ↑

Source Source

File: wp-includes/customize/class-wp-customize-upload-control.php

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

	/**
	 * 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 );
			}
		}
	}
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.4.0 Introduced.


Top ↑

Methods Methods

  • __construct — Constructor.
  • content_template — Render a JS template for the content of the upload control.
  • enqueue — Enqueue control related scripts/styles.
  • render_content — Don't render any content for this control from PHP.
  • to_json — Refresh the parameters passed to the JavaScript via JSON.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by chetansatasiya

    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',
    	) ) 
    );
    

You must log in before being able to contribute a note or feedback.