Docs: Fix syntax for marking parameters optional in the DocBlock for `is_active_widget()`.

See #32246.

Built from https://develop.svn.wordpress.org/trunk@35990


git-svn-id: http://core.svn.wordpress.org/trunk@35955 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-12-17 17:19:26 +00:00
parent 9de8a1466a
commit c13824b1c0
2 changed files with 6 additions and 6 deletions

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-alpha-35989'; $wp_version = '4.5-alpha-35990';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -782,13 +782,13 @@ function dynamic_sidebar( $index = 1 ) {
* *
* @global array $wp_registered_widgets * @global array $wp_registered_widgets
* *
* @param string $callback Optional, Widget callback to check. * @param string|false $callback Optional, Widget callback to check. Default false.
* @param int $widget_id Optional, but needed for checking. Widget ID. * @param int|false $widget_id Optional. Widget ID. Optional, but needed for checking. Default false.
* @param string $id_base Optional, the base ID of a widget created by extending WP_Widget. * @param string|false $id_base Optional. The base ID of a widget created by extending WP_Widget. Default false.
* @param bool $skip_inactive Optional, whether to check in 'wp_inactive_widgets'. * @param bool $skip_inactive Optional. Whether to check in 'wp_inactive_widgets'. Default true.
* @return string|false False if widget is not active or id of sidebar in which the widget is active. * @return string|false False if widget is not active or id of sidebar in which the widget is active.
*/ */
function is_active_widget($callback = false, $widget_id = false, $id_base = false, $skip_inactive = true) { function is_active_widget( $callback = false, $widget_id = false, $id_base = false, $skip_inactive = true ) {
global $wp_registered_widgets; global $wp_registered_widgets;
$sidebars_widgets = wp_get_sidebars_widgets(); $sidebars_widgets = wp_get_sidebars_widgets();