}
/**
- * 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;
/**
* Registers widget control callback for customizing options.
*
- * The options contains the 'height', 'width', and 'id_base' keys. The 'height'
- * option is never used. The 'width' option is the width of the fully expanded
- * control form, but try hard to use the default width. The 'id_base' is for
- * multi-widgets (widgets which allow multiple instances such as the text
- * widget), an id_base must be provided. The widget id will end up looking like
- * `{$id_base}-{$unique_number}`.
- *
* @since 2.2.0
*
- * @todo Document `$options` as a hash notation, re: WP_Widget::__construct() cross-reference.
* @todo `$params` parameter?
*
* @global array $wp_registered_widget_controls
* @param int|string $id Sidebar ID.
* @param string $name Sidebar display name.
* @param callable $control_callback Run when sidebar is displayed.
- * @param array|string $options Optional. Widget options. See description above. Default empty array.
+ * @param array $options {
+ * Optional. Array or string of control options. Default empty array.
+ *
+ * @type int $height Never used. Default 200.
+ * @type int $width Width of the fully expanded control form (but try hard to use the default width).
+ * Default 250.
+ * @type int|string $id_base Required for multi-widgets, i.e widgets that allow multiple instances such as the
+ * text widget. The widget id will end up looking like `{$id_base}-{$unique_number}`.
+ * }
*/
function wp_register_widget_control( $id, $name, $control_callback, $options = array() ) {
global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks;
}
/**
+ * Registers the update callback for a widget.
+ *
+ * @since 2.8.0
+ *
* @global array $wp_registered_widget_updates
*
- * @param string $id_base
- * @param callable $update_callback
- * @param array $options
+ * @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 wp_register_widget_control().
+ * Default empty array.
*/
-function _register_widget_update_callback($id_base, $update_callback, $options = array()) {
+function _register_widget_update_callback( $id_base, $update_callback, $options = array() ) {
global $wp_registered_widget_updates;
if ( isset($wp_registered_widget_updates[$id_base]) ) {
}
/**
+ * Registers the form callback for a widget.
+ *
+ * @since 2.8.0
*
* @global array $wp_registered_widget_controls
*
- * @param int|string $id
- * @param string $name
- * @param callable $form_callback
- * @param array $options
+ * @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 wp_register_widget_control().
+ * Default empty array.
*/
function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {
global $wp_registered_widget_controls;
if ( is_int( $index ) ) {
$index = "sidebar-$index";
} else {
- $sanitized_index = sanitize_title( $index );
+ $index = sanitize_title( $index );
foreach ( (array) $wp_registered_sidebars as $key => $value ) {
- if ( sanitize_title( $value['name'] ) == $sanitized_index ) {
+ if ( sanitize_title( $value['name'] ) == $index ) {
$index = $key;
break;
}
/**
* Fires before widgets are rendered in a dynamic sidebar.
*
- * Note: The action also fires for empty sidebars, and on both the front-end
- * and back-end, including the Inactive Widgets sidebar on the Widgets screen.
+ * Note: The action also fires for empty sidebars, and on both the front end
+ * and back end, including the Inactive Widgets sidebar on the Widgets screen.
*
* @since 3.9.0
*
$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,
+ * Note: The filter is evaluated on both the front end and back end,
* including for the Inactive Widgets sidebar on the Widgets screen.
*
* @since 2.5.0
/**
* Fires before a widget's display callback is called.
*
- * Note: The action fires on both the front-end and back-end, including
+ * Note: The action fires on both the front end and back end, including
* for widgets in the Inactive Widgets sidebar on the Widgets screen.
*
* The action is not fired for empty sidebars.
*
* @type string $name Name of the widget.
* @type string $id Widget ID.
- * @type array|callable $callback When the hook is fired on the front-end, $callback is an array
- * containing the widget object. Fired on the back-end, $callback
+ * @type array|callable $callback When the hook is fired on the front end, $callback is an array
+ * containing the widget object. Fired on the back end, $callback
* is 'wp_widget_control', see $_callback.
* @type array $params An associative array of multi-widget arguments.
* @type string $classname CSS class applied to the widget container.
* @type string $description The widget description.
- * @type array $_callback When the hook is fired on the back-end, $_callback is populated
+ * @type array $_callback When the hook is fired on the back end, $_callback is populated
* with an array containing the widget object, see $callback.
* }
*/
/**
* Fires after widgets are rendered in a dynamic sidebar.
*
- * Note: The action also fires for empty sidebars, and on both the front-end
- * and back-end, including the Inactive Widgets sidebar on the Widgets screen.
+ * Note: The action also fires for empty sidebars, and on both the front end
+ * and back end, including the Inactive Widgets sidebar on the Widgets screen.
*
* @since 3.9.0
*
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.
+ * 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.
*
* @since 3.9.0
*
}
/**
- * Whether widget is displayed on the front-end.
+ * Whether widget is displayed on the front end.
*
* Either $callback or $id_base can be used
* $id_base is the first argument when extending WP_Widget class
* 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
*
* @global array $wp_registered_widgets
*
- * @param string $callback Optional, Widget callback to check.
- * @param int $widget_id Optional, but needed for checking. Widget ID.
- * @param string $id_base Optional, the base ID of a widget created by extending WP_Widget.
- * @param bool $skip_inactive Optional, whether to check in 'wp_inactive_widgets'.
+ * @param string|false $callback Optional, Widget callback to check. Default false.
+ * @param int|false $widget_id Optional. Widget ID. Optional, but needed for checking. Default false.
+ * @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'. Default true.
* @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;
$sidebars_widgets = wp_get_sidebars_widgets();
global $wp_registered_widgets, $wp_registered_sidebars;
$sidebars_widgets = get_option('sidebars_widgets');
foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
- if ( count($sidebars_widgets[$index]) ) {
+ if ( ! empty( $sidebars_widgets[ $index ] ) ) {
foreach ( (array) $sidebars_widgets[$index] as $widget )
if ( array_key_exists($widget, $wp_registered_widgets) )
return true;
$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
*
}
/**
- * Private
+ * Retrieves the widget ID base value.
+ *
+ * @since 2.8.0
*
- * @return string
+ * @param string $id Widget ID.
+ * @return string Widget ID base.
*/
-function _get_widget_id_base($id) {
+function _get_widget_id_base( $id ) {
return preg_replace( '/-[0-9]+$/', '', $id );
}
}
/**
- * 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
*/
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff