}
/**
- * Unregister a widget
+ * Unregisters a widget.
*
- * Unregisters a WP_Widget widget. Useful for unregistering default widgets.
- * Run within a function hooked to the widgets_init action.
+ * Unregisters a WP_Widget widget. Useful for un-registering default widgets.
+ * Run within a function hooked to the {@see 'widgets_init'} action.
*
* @since 2.8.0
*
*
* @global WP_Widget_Factory $wp_widget_factory
*
- * @param string $widget_class The name of a class that extends WP_Widget
+ * @param string $widget_class The name of a class that extends WP_Widget.
*/
function unregister_widget($widget_class) {
global $wp_widget_factory;
*
* @param string $id_base The base ID of a widget created by extending WP_Widget.
* @param callable $update_callback Update callback method for the widget.
- * @param array $options Optional. Widget control options. See {@see wp_register_widget_control()}.
+ * @param array $options Optional. Widget control options. See wp_register_widget_control().
* Default empty array.
*/
function _register_widget_update_callback( $id_base, $update_callback, $options = array() ) {
* @param int|string $id Widget ID.
* @param string $name Name attribute for the widget.
* @param callable $form_callback Form callback.
- * @param array $options Optional. Widget control options. See {@see wp_register_widget_control()}.
+ * @param array $options Optional. Widget control options. See wp_register_widget_control().
* Default empty array.
*/
function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {
$params[0]['before_widget'] = sprintf($params[0]['before_widget'], $id, $classname_);
/**
- * Filter the parameters passed to a widget's display callback.
+ * Filters the parameters passed to a widget's display callback.
*
* Note: The filter is evaluated on both the front end and back end,
* including for the Inactive Widgets sidebar on the Widgets screen.
do_action( 'dynamic_sidebar_after', $index, true );
/**
- * Filter whether a sidebar has widgets.
+ * Filters whether a sidebar has widgets.
*
* Note: The filter is also evaluated for empty sidebars, and on both the front end
* and back end, including the Inactive Widgets sidebar on the Widgets screen.
* the widget with that callback/$id_base AND that ID is found.
*
* NOTE: $widget_id and $id_base are the same for single widgets. To be effective
- * this function has to run after widgets have initialized, at action 'init' or later.
+ * this function has to run after widgets have initialized, at action {@see 'init'} or later.
*
* @since 2.2.0
*
$is_active_sidebar = ! empty( $sidebars_widgets[$index] );
/**
- * Filter whether a dynamic sidebar is considered "active".
+ * Filters whether a dynamic sidebar is considered "active".
*
* @since 3.9.0
*
unset($sidebars_widgets['array_version']);
/**
- * Filter the list of sidebars and their widgets.
+ * Filters the list of sidebars and their widgets.
*
* @since 2.7.0
*
}
/**
- * Register all of the default WordPress widgets on startup.
+ * Registers all of the default WordPress widgets on startup.
*
- * Calls 'widgets_init' action after all of the WordPress widgets have been
- * registered.
+ * Calls {@see 'widgets_init'} action after all of the WordPress widgets have been registered.
*
* @since 2.2.0
*/