Changeset 29157 for trunk/src/wp-includes/class-wp-customize-manager.php

Timestamp:

07/14/2014 12:35:43 AM (12 years ago)

Author:

DrewAPicture

Message:

Inline documentation cleanup for 4.0 audit.

phpDoc tweaks for methods added in [28861]:

• WP_Customize_Manager::panels() method
• WP_Customize_Manager::add_panel() method
• WP_Customize_Manager::get_panel() method
• WP_Customize_Manager::remove_panel() method

Added in [28970]:

• WP_Customize_Manager::customize_preview_override_404_status() method

See #27406 and #28885.

File:

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

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

@@ -320 +320 @@
          *
          * @since 4.0.0
-         *
-         * @return array
+         * @access public
+         *
+         * @return array Panels.
          */
         public function panels() {
@@ -434 +435 @@
          *
          * @since 4.0.0
+         * @access public
          */
         public function customize_preview_override_404_status() {
@@ -681 +683 @@
          *
          * @since 4.0.0
+         * @access public
          *
          * @param WP_Customize_Panel|string $id   Customize Panel object, or Panel ID.
-         * @param array                     $args Panel arguments.
+         * @param array                     $args Optional. Panel arguments. Default empty array.
          */
         public function add_panel( $id, $args = array() ) {
@@ -700 +703 @@
          *
          * @since 4.0.0
-         *
-         * @param string $id Panel ID.
-         * @return WP_Customize_Panel
+         * @access public
+         *
+         * @param string $id Panel ID to get.
+         * @return WP_Customize_Panel Requested panel instance.
          */
         public function get_panel( $id ) {
@@ -714 +718 @@
          *
          * @since 4.0.0
-         *
-         * @param string $id Panel ID.
+         * @access public
+         *
+         * @param string $id Panel ID to remove.
          */
         public function remove_panel( $id ) {