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.


git-svn-id: https://develop.svn.wordpress.org/trunk@29159 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-07-14 00:41:20 +00:00
parent 37a39b6b74
commit 17ba9ab973

View File

@ -1077,8 +1077,8 @@ final class WP_Customize_Widgets {
* @since 4.0.0 * @since 4.0.0
* @access public * @access public
* *
* @param string $widget_id * @param string $widget_id Widget ID to check.
* @return bool * @return bool Whether the widget is rendered.
*/ */
public function is_widget_rendered( $widget_id ) { public function is_widget_rendered( $widget_id ) {
return in_array( $widget_id, $this->rendered_widgets ); return in_array( $widget_id, $this->rendered_widgets );
@ -1090,8 +1090,8 @@ final class WP_Customize_Widgets {
* @since 4.0.0 * @since 4.0.0
* @access public * @access public
* *
* @param string $sidebar_id * @param string $sidebar_id Sidebar ID to check.
* @return bool * @return bool Whether the sidebar is rendered.
*/ */
public function is_sidebar_rendered( $sidebar_id ) { public function is_sidebar_rendered( $sidebar_id ) {
return in_array( $sidebar_id, $this->rendered_sidebars ); return in_array( $sidebar_id, $this->rendered_sidebars );
@ -1108,8 +1108,8 @@ final class WP_Customize_Widgets {
* @since 3.9.0 * @since 3.9.0
* @access public * @access public
* *
* @param bool $is_active Whether the sidebar is active. * @param bool $is_active Whether the sidebar is active.
* @pasram string $sidebar_id Sidebar ID. * @param string $sidebar_id Sidebar ID.
*/ */
public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) { public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) {
if ( isset( $GLOBALS['wp_registered_sidebars'][$sidebar_id] ) ) { if ( isset( $GLOBALS['wp_registered_sidebars'][$sidebar_id] ) ) {