WordPress/wp-includes/customize/class-wp-customize-upload-control.php
Sergey Biryukov f31f929a5b Docs: Add documentation for the $type, $mime_type, and $button_labels properties in WP_Customize_Upload_Control.
Follow-up to [20319], [30309], [31698], [32023].

Props subrataemfluence.
See #44411.
Built from https://develop.svn.wordpress.org/trunk@49679


git-svn-id: http://core.svn.wordpress.org/trunk@49402 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-22 15:51:03 +00:00

66 lines
1.2 KiB
PHP

<?php
/**
* Customize API: WP_Customize_Upload_Control class
*
* @package WordPress
* @subpackage Customize
* @since 4.4.0
*/
/**
* Customize Upload Control Class.
*
* @since 3.4.0
*
* @see WP_Customize_Media_Control
*/
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 );
}
}
}
}