Changeset 34320

Timestamp:

09/19/2015 06:39:09 AM (9 years ago)

Author:

westonruter

Message:

Customize: Flesh out phpdoc for WP_Customize_Manager.

• Add missing phpdoc for class member variables.
• Supply missing @return descriptions from [34269].
• Add missing @since tags.
• Remove unused $customized protected class member variable.

Fixes #33898.

File:

• trunk/src/wp-includes/class-wp-customize-manager.php (modified) (14 diffs)

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

@@ -25 +25 @@
      * An instance of the theme being previewed.
      *
+     * @since 3.4.0
+     * @access protected
      * @var WP_Theme
      */
@@ -32 +34 @@
      * The directory name of the previously active theme (within the theme_root).
      *
+     * @since 3.4.0
+     * @access protected
      * @var string
      */
@@ -39 +43 @@
      * Whether this is a Customizer pageload.
      *
+     * @since 3.4.0
+     * @access protected
      * @var bool
      */
@@ -44 +50 @@
 
     /**
-     * Methods and properties deailing with managing widgets in the Customizer.
-     *
+     * Methods and properties dealing with managing widgets in the Customizer.
+     *
+     * @since 3.9.0
+     * @access public
      * @var WP_Customize_Widgets
      */
@@ -51 +59 @@
 
     /**
-     * Methods and properties deailing with managing nav menus in the Customizer.
-     *
+     * Methods and properties dealing with managing nav menus in the Customizer.
+     *
+     * @since 4.3.0
+     * @access public
      * @var WP_Customize_Nav_Menus
      */
     public $nav_menus;
 
-    protected $settings   = array();
+    /**
+     * Registered instances of WP_Customize_Setting.
+     *
+     * @since 3.4.0
+     * @access protected
+     * @var array
+     */
+    protected $settings = array();
+
+    /**
+     * Sorted top-level instances of WP_Customize_Panel and WP_Customize_Section.
+     *
+     * @since 4.0.0
+     * @access protected
+     * @var array
+     */
     protected $containers = array();
-    protected $panels     = array();
-    protected $sections   = array();
-    protected $controls   = array();
-
+
+    /**
+     * Registered instances of WP_Customize_Panel.
+     *
+     * @since 4.0.0
+     * @access protected
+     * @var array
+     */
+    protected $panels = array();
+
+    /**
+     * Registered instances of WP_Customize_Section.
+     *
+     * @since 3.4.0
+     * @access protected
+     * @var array
+     */
+    protected $sections = array();
+
+    /**
+     * Registered instances of WP_Customize_Control.
+     *
+     * @since 3.4.0
+     * @access protected
+     * @var array
+     */
+    protected $controls = array();
+
+    /**
+     * Return value of check_ajax_referer() in customize_preview_init() method.
+     *
+     * @since 3.5.0
+     * @access protected
+     * @var false|int
+     */
     protected $nonce_tick;
-
-    protected $customized;
 
     /**
@@ -734 +788 @@
      * @since 3.4.0
      *
-     * @return mixed
+     * @param mixed $return Value passed through for wp_die_handler filter.
+     * @return mixed Value passed through for wp_die_handler filter.
      */
     public function remove_preview_signature( $return = null ) {
@@ -1314 +1369 @@
 
     /**
-     * Return whether the user agent is iOS.
+     * Determine whether the user agent is iOS.
      *
      * @since 4.4.0
      * @access public
      *
-     * @return bool
+     * @return bool Whether the user agent is iOS.
      */
     public function is_ios() {
@@ -1331 +1386 @@
      * @access public
      *
-     * @return string
+     * @return string The template string for the document title.
      */
     public function get_document_title_template() {
@@ -1351 +1406 @@
      * @access public
      *
-     * @param string $preview_url  URL to be previewed.
+     * @param string $preview_url URL to be previewed.
      */
     public function set_preview_url( $preview_url ) {
@@ -1363 +1418 @@
      * @access public
      *
-     * @return string
+     * @return string URL being previewed.
      */
     public function get_preview_url() {
@@ -1382 +1437 @@
      * @access public
      *
-     * @param string $return_url  URL for return link.
+     * @param string $return_url URL for return link.
      */
     public function set_return_url( $return_url ) {
@@ -1396 +1451 @@
      * @access public
      *
-     * @return string
+     * @return string URL for link to close Customizer.
      */
     public function get_return_url() {
@@ -1414 +1469 @@
      * Set the autofocused constructs.
      *
+     * @since 4.4.0
+     * @access public
+     *
      * @param array $autofocus {
      *     Mapping of 'panel', 'section', 'control' to the ID which should be autofocused.
@@ -1447 +1505 @@
      * Print JavaScript settings for parent window.
      *
-     * @since 4.3.0
+     * @since 4.4.0
      */
     public function customize_pane_settings() {