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

Timestamp:

10/29/2014 10:50:21 PM (10 years ago)

Author:

ocean90

Message:

Improve/introduce Customizer JavaScript models for Controls, Sections, and Panels.

• Introduce models for panels and sections.
• Introduce API to expand and focus a control, section or panel.
• Allow deep-linking to panels, sections, and controls inside of the Customizer.
• Clean up accordion.js, removing all Customizer-specific logic.
• Add initial unit tests for wp.customize.Class in customize-base.js.

​https://make.wordpress.org/core/2014/10/27/toward-a-complete-javascript-api-for-the-customizer/ provides an overview of how to use the JavaScript API.

props westonruter, celloexpressions, ryankienstra.
see #28032, #28579, #28580, #28650, #28709, #29758.
fixes #29529.

File:

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

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

@@ -75 +75 @@
 
     /**
+     * @deprecated It is better to just call the json() method
      * @access public
      * @var array
@@ -219 +220 @@
 
         $this->json['type']        = $this->type;
+        $this->json['priority']    = $this->priority;
+        $this->json['active']      = $this->active();
+        $this->json['section']     = $this->section;
+        $this->json['content']     = $this->get_content();
         $this->json['label']       = $this->label;
         $this->json['description'] = $this->description;
-        $this->json['active']      = $this->active();
+    }
+
+    /**
+     * Get the data to export to the client via JSON.
+     *
+     * @since 4.1.0
+     *
+     * @return array
+     */
+    public function json() {
+        $this->to_json();
+        return $this->json;
     }
 
@@ -242 +258 @@
 
         return true;
+    }
+
+    /**
+     * Get the control's content for insertion into the Customizer pane.
+     *
+     * @since 4.1.0
+     *
+     * @return string
+     */
+    public final function get_content() {
+        ob_start();
+        $this->maybe_render();
+        $template = trim( ob_get_contents() );
+        ob_end_clean();
+        return $template;
     }
 
@@ -1074 +1105 @@
  * Widget Area Customize Control Class
  *
+ * @since 3.9.0
  */
 class WP_Widget_Area_Customize_Control extends WP_Customize_Control {
@@ -1115 +1147 @@
 /**
  * Widget Form Customize Control Class
+ *
+ * @since 3.9.0
  */
 class WP_Widget_Form_Customize_Control extends WP_Customize_Control {