Changeset 31698 for trunk/src/wp-includes/class-wp-customize-control.php

Timestamp:

03/10/2015 06:01:42 PM (12 years ago)

Author:

ocean90

Message:

Customizer: Introduce WP_Customize_Media_Control.

WP_Customize_Media_Control is a new base class for all Customizer media controls. If used directly it supports the ID of an attachment instead of an URL like WP_Customize_Upload_Control.

props celloexpressions.
fixes #29215.

File:

• trunk/src/wp-includes/class-wp-customize-control.php (modified) (9 diffs)

trunk/src/wp-includes/class-wp-customize-control.php

@@ -522 +522 @@
          */
         final public function print_template() {
-                ?>
-                <script type="text/html" id="tmpl-customize-control-<?php echo $this->type; ?>-content">
-                        <?php $this->content_template(); ?>
-                </script>
-                <?php
+                ?>
+                <script type="text/html" id="tmpl-customize-control-<?php echo $this->type; ?>-content">
+                        <?php $this->content_template(); ?>
+                </script>
+                <?php
         }
 
@@ -639 +639 @@
 
 /**
- * Customize Upload Control class.
- *
- * @since 3.4.0
+ * Customize Media Control class.
+ *
+ * @since 4.2.0
  *
  * @see WP_Customize_Control
  */
-class WP_Customize_Upload_Control extends WP_Customize_Control {
-        public $type          = 'upload';
+class WP_Customize_Media_Control extends WP_Customize_Control {
+        public $type          = 'media';
         public $mime_type     = '';
         public $button_labels = array();
-        public $removed = ''; // unused
-        public $context; // unused
-        public $extensions = array(); // unused
 
         /**
@@ -657 +654 @@
          *
          * @since 4.1.0
+         * @since 4.2.0 Moved from WP_Customize_Upload_Control.
          *
          * @param WP_Customize_Manager $manager {@see WP_Customize_Manager} instance.
@@ -678 +676 @@
          *
          * @since 3.4.0
+         * @since 4.2.0 Moved from WP_Customize_Upload_Control.
          */
         public function enqueue() {
@@ -687 +686 @@
          *
          * @since 3.4.0
+         * @since 4.2.0 Moved from WP_Customize_Upload_Control.
+         *
          * @uses WP_Customize_Control::to_json()
          */
@@ -699 +700 @@
                         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(
@@ -721 +723 @@
                                 $this->json['attachment'] = $this->json['defaultAttachment'];
                         } elseif ( $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 );
-                                }
+                                $this->json['attachment'] = wp_prepare_attachment_for_js( $value );
                         }
                 }
@@ -733 +731 @@
          * Don't render any content for this control from PHP.
          *
-         * @see WP_Customize_Upload_Control::content_template()
-         * @since 3.4.0
+         * @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() {}
 
         /**
-         * Render a JS template for the content of the upload control.
+         * 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() {
@@ -824 +825 @@
 
 /**
+ * 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
+
+        /**
+         * 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 );
+                        }
+                }
+        }
+}
+
+/**
  * Customize Image Control class.
  *