Changeset 29159

Timestamp:

07/14/2014 12:41:20 AM (10 years ago)

Author:

DrewAPicture

Message:

Inline documentation cleanup for 4.0 audit.

phpDoc tweaks for methods, properties, and filters added in [29051]:

• WP_Customize_Widgets::is_widget_rendered() method
• WP_Customize_Widgets::is_sidebar_rendered() method

See #27993 and #28885.

File:

• trunk/src/wp-includes/class-wp-customize-widgets.php (modified) (3 diffs)

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

@@ -1078 +1078 @@
      * @access public
      *
-     * @param string $widget_id
-     * @return bool
+     * @param string $widget_id Widget ID to check.
+     * @return bool Whether the widget is rendered.
      */
     public function is_widget_rendered( $widget_id ) {
@@ -1091 +1091 @@
      * @access public
      *
-     * @param string $sidebar_id
-     * @return bool
+     * @param string $sidebar_id Sidebar ID to check.
+     * @return bool Whether the sidebar is rendered.
      */
     public function is_sidebar_rendered( $sidebar_id ) {
@@ -1109 +1109 @@
      * @access public
      *
-     * @param bool    $is_active  Whether the sidebar is active.
-     * @pasram string $sidebar_id Sidebar ID.
+     * @param bool   $is_active  Whether the sidebar is active.
+     * @param string $sidebar_id Sidebar ID.
      */
     public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) {