X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/177fd6fefd2e3d5a0ea6591c71d660cabdb3c1a4..073c5ed6408e2f00dc1863b463fe205467628905:/wp-includes/widgets.php diff --git a/wp-includes/widgets.php b/wp-includes/widgets.php index 9fa26306..3540be9b 100644 --- a/wp-includes/widgets.php +++ b/wp-includes/widgets.php @@ -1,105 +1,354 @@ register($widget_class); +} + +/** + * Unregisters a widget. + * + * 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 + * + * @see WP_Widget + * + * @global WP_Widget_Factory $wp_widget_factory + * + * @param string $widget_class The name of a class that extends WP_Widget. + */ +function unregister_widget($widget_class) { + global $wp_widget_factory; + + $wp_widget_factory->unregister($widget_class); +} + +/** + * Creates multiple sidebars. + * + * If you wanted to quickly create multiple sidebars for a theme or internally. + * This function will allow you to do so. If you don't pass the 'name' and/or + * 'id' in `$args`, then they will be built for you. + * + * @since 2.2.0 + * + * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here. + * + * @global array $wp_registered_sidebars + * + * @param int $number Optional. Number of sidebars to create. Default 1. + * @param array|string $args { + * Optional. Array or string of arguments for building a sidebar. + * + * @type string $id The base string of the unique identifier for each sidebar. If provided, and multiple + * sidebars are being defined, the id will have "-2" appended, and so on. + * Default 'sidebar-' followed by the number the sidebar creation is currently at. + * @type string $name The name or title for the sidebars displayed in the admin dashboard. If registering + * more than one sidebar, include '%d' in the string as a placeholder for the uniquely + * assigned number for each sidebar. + * Default 'Sidebar' for the first sidebar, otherwise 'Sidebar %d'. + * } + */ +function register_sidebars( $number = 1, $args = array() ) { global $wp_registered_sidebars; $number = (int) $number; if ( is_string($args) ) parse_str($args, $args); - for ( $i=1; $i <= $number; $i++ ) { + for ( $i = 1; $i <= $number; $i++ ) { $_args = $args; - if ( $number > 1 ) { + if ( $number > 1 ) $_args['name'] = isset($args['name']) ? sprintf($args['name'], $i) : sprintf(__('Sidebar %d'), $i); - } else { + else $_args['name'] = isset($args['name']) ? $args['name'] : __('Sidebar'); - } - if (isset($args['id'])) { + // Custom specified ID's are suffixed if they exist already. + // Automatically generated sidebar names need to be suffixed regardless starting at -0 + if ( isset($args['id']) ) { $_args['id'] = $args['id']; + $n = 2; // Start at -2 for conflicting custom ID's + while ( is_registered_sidebar( $_args['id'] ) ) { + $_args['id'] = $args['id'] . '-' . $n++; + } } else { - $n = count($wp_registered_sidebars); + $n = count( $wp_registered_sidebars ); do { - $n++; - $_args['id'] = "sidebar-$n"; - } while (isset($wp_registered_sidebars[$_args['id']])); + $_args['id'] = 'sidebar-' . ++$n; + } while ( is_registered_sidebar( $_args['id'] ) ); } - register_sidebar($_args); } } +/** + * Builds the definition for a single sidebar and returns the ID. + * + * Accepts either a string or an array and then parses that against a set + * of default arguments for the new sidebar. WordPress will automatically + * generate a sidebar ID and name based on the current number of registered + * sidebars if those arguments are not included. + * + * When allowing for automatic generation of the name and ID parameters, keep + * in mind that the incrementor for your sidebar can change over time depending + * on what other plugins and themes are installed. + * + * If theme support for 'widgets' has not yet been added when this function is + * called, it will be automatically enabled through the use of add_theme_support() + * + * @since 2.2.0 + * + * @global array $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID. + * + * @param array|string $args { + * Optional. Array or string of arguments for the sidebar being registered. + * + * @type string $name The name or title of the sidebar displayed in the Widgets + * interface. Default 'Sidebar $instance'. + * @type string $id The unique identifier by which the sidebar will be called. + * Default 'sidebar-$instance'. + * @type string $description Description of the sidebar, displayed in the Widgets interface. + * Default empty string. + * @type string $class Extra CSS class to assign to the sidebar in the Widgets interface. + * Default empty. + * @type string $before_widget HTML content to prepend to each widget's HTML output when + * assigned to this sidebar. Default is an opening list item element. + * @type string $after_widget HTML content to append to each widget's HTML output when + * assigned to this sidebar. Default is a closing list item element. + * @type string $before_title HTML content to prepend to the sidebar title when displayed. + * Default is an opening h2 element. + * @type string $after_title HTML content to append to the sidebar title when displayed. + * Default is a closing h2 element. + * } + * @return string Sidebar ID added to $wp_registered_sidebars global. + */ function register_sidebar($args = array()) { global $wp_registered_sidebars; - if ( is_string($args) ) - parse_str($args, $args); - $i = count($wp_registered_sidebars) + 1; + $id_is_empty = empty( $args['id'] ); + $defaults = array( 'name' => sprintf(__('Sidebar %d'), $i ), 'id' => "sidebar-$i", + 'description' => '', + 'class' => '', 'before_widget' => '
id
', $sidebar['name'], $sidebar['id'] ), '4.2.0' );
+ }
$wp_registered_sidebars[$sidebar['id']] = $sidebar;
+ add_theme_support('widgets');
+
+ /**
+ * Fires once a sidebar has been registered.
+ *
+ * @since 3.0.0
+ *
+ * @param array $sidebar Parsed arguments for the registered sidebar.
+ */
+ do_action( 'register_sidebar', $sidebar );
+
return $sidebar['id'];
}
+/**
+ * Removes a sidebar from the list.
+ *
+ * @since 2.2.0
+ *
+ * @global array $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
+ *
+ * @param string $name The ID of the sidebar when it was added.
+ */
function unregister_sidebar( $name ) {
global $wp_registered_sidebars;
- if ( isset( $wp_registered_sidebars[$name] ) )
- unset( $wp_registered_sidebars[$name] );
+ unset( $wp_registered_sidebars[ $name ] );
}
-function register_sidebar_widget($name, $output_callback, $classname = '') {
- // Compat
- if ( is_array($name) ) {
- if ( count($name) == 3 )
- $name = sprintf($name[0], $name[2]);
- else
- $name = $name[0];
- }
-
- $id = sanitize_title($name);
- $options = array();
- if ( !empty($classname) && is_string($classname) )
- $options['classname'] = $classname;
- $params = array_slice(func_get_args(), 2);
- $args = array($id, $name, $output_callback, $options);
- if ( !empty($params) )
- $args = array_merge($args, $params);
+/**
+ * Checks if a sidebar is registered.
+ *
+ * @since 4.4.0
+ *
+ * @global array $wp_registered_sidebars Registered sidebars.
+ *
+ * @param string|int $sidebar_id The ID of the sidebar when it was registered.
+ * @return bool True if the sidebar is registered, false otherwise.
+ */
+function is_registered_sidebar( $sidebar_id ) {
+ global $wp_registered_sidebars;
- call_user_func_array('wp_register_sidebar_widget', $args);
+ return isset( $wp_registered_sidebars[ $sidebar_id ] );
}
-function wp_register_sidebar_widget($id, $name, $output_callback, $options = array()) {
- global $wp_registered_widgets;
+/**
+ * Register an instance of a widget.
+ *
+ * The default widget option is 'classname' that can be overridden.
+ *
+ * The function can also be used to un-register widgets when `$output_callback`
+ * parameter is an empty string.
+ *
+ * @since 2.2.0
+ *
+ * @global array $wp_registered_widgets Uses stored registered widgets.
+ * @global array $wp_register_widget_defaults Retrieves widget defaults.
+ * @global array $wp_registered_widget_updates
+ * @global array $_wp_deprecated_widgets_callbacks
+ *
+ * @param int|string $id Widget ID.
+ * @param string $name Widget display title.
+ * @param callable $output_callback Run when widget is called.
+ * @param array $options {
+ * Optional. An array of supplementary widget options for the instance.
+ *
+ * @type string $classname Class name for the widget's HTML container. Default is a shortened
+ * version of the output callback name.
+ * @type string $description Widget description for display in the widget administration
+ * panel and/or theme.
+ * }
+ */
+function wp_register_sidebar_widget( $id, $name, $output_callback, $options = array() ) {
+ global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks;
+
+ $id = strtolower($id);
if ( empty($output_callback) ) {
unset($wp_registered_widgets[$id]);
return;
}
+ $id_base = _get_widget_id_base($id);
+ if ( in_array($output_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($output_callback) ) {
+ unset( $wp_registered_widget_controls[ $id ] );
+ unset( $wp_registered_widget_updates[ $id_base ] );
+ return;
+ }
+
$defaults = array('classname' => $output_callback);
$options = wp_parse_args($options, $defaults);
$widget = array(
@@ -110,10 +359,34 @@ function wp_register_sidebar_widget($id, $name, $output_callback, $options = arr
);
$widget = array_merge($widget, $options);
- if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) )
+ if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) ) {
+
+ /**
+ * Fires once for each registered widget.
+ *
+ * @since 3.0.0
+ *
+ * @param array $widget An array of default widget arguments.
+ */
+ do_action( 'wp_register_sidebar_widget', $widget );
$wp_registered_widgets[$id] = $widget;
+ }
}
+/**
+ * Retrieve description for widget.
+ *
+ * When registering widgets, the options can also include 'description' that
+ * describes the widget for display on the widget administration panel or
+ * in the theme.
+ *
+ * @since 2.5.0
+ *
+ * @global array $wp_registered_widgets
+ *
+ * @param int|string $id Widget ID.
+ * @return string|void Widget description, if available.
+ */
function wp_widget_description( $id ) {
if ( !is_scalar($id) )
return;
@@ -121,52 +394,93 @@ function wp_widget_description( $id ) {
global $wp_registered_widgets;
if ( isset($wp_registered_widgets[$id]['description']) )
- return wp_specialchars( $wp_registered_widgets[$id]['description'] );
+ return esc_html( $wp_registered_widgets[$id]['description'] );
}
-function unregister_sidebar_widget($id) {
- return wp_unregister_sidebar_widget($id);
+/**
+ * Retrieve description for a sidebar.
+ *
+ * When registering sidebars a 'description' parameter can be included that
+ * describes the sidebar for display on the widget administration panel.
+ *
+ * @since 2.9.0
+ *
+ * @global array $wp_registered_sidebars
+ *
+ * @param string $id sidebar ID.
+ * @return string|void Sidebar description, if available.
+ */
+function wp_sidebar_description( $id ) {
+ if ( !is_scalar($id) )
+ return;
+
+ global $wp_registered_sidebars;
+
+ if ( isset($wp_registered_sidebars[$id]['description']) )
+ return esc_html( $wp_registered_sidebars[$id]['description'] );
}
+/**
+ * Remove widget from sidebar.
+ *
+ * @since 2.2.0
+ *
+ * @param int|string $id Widget ID.
+ */
function wp_unregister_sidebar_widget($id) {
- wp_register_sidebar_widget($id, '', '');
- wp_unregister_widget_control($id);
-}
-function register_widget_control($name, $control_callback, $width = '', $height = '') {
- // Compat
- if ( is_array($name) ) {
- if ( count($name) == 3 )
- $name = sprintf($name[0], $name[2]);
- else
- $name = $name[0];
- }
+ /**
+ * Fires just before a widget is removed from a sidebar.
+ *
+ * @since 3.0.0
+ *
+ * @param int $id The widget ID.
+ */
+ do_action( 'wp_unregister_sidebar_widget', $id );
- $id = sanitize_title($name);
- $options = array();
- if ( !empty($width) )
- $options['width'] = $width;
- if ( !empty($height) )
- $options['height'] = $height;
- $params = array_slice(func_get_args(), 4);
- $args = array($id, $name, $control_callback, $options);
- if ( !empty($params) )
- $args = array_merge($args, $params);
-
- call_user_func_array('wp_register_widget_control', $args);
+ wp_register_sidebar_widget($id, '', '');
+ wp_unregister_widget_control($id);
}
-/* $options: height, width, id_base
- * height: never used
- * width: width of fully expanded control form. Try hard to use the default width.
- * id_base: for multi-widgets (widgets which allow multiple instances such as the text widget), an id_base must be provided.
- * the widget id will ennd up looking like {$id_base}-{$unique_number}
+/**
+ * Registers widget control callback for customizing options.
+ *
+ * @since 2.2.0
+ *
+ * @todo `$params` parameter?
+ *
+ * @global array $wp_registered_widget_controls
+ * @global array $wp_registered_widget_updates
+ * @global array $wp_registered_widgets
+ * @global array $_wp_deprecated_widgets_callbacks
+ *
+ * @param int|string $id Sidebar ID.
+ * @param string $name Sidebar display name.
+ * @param callable $control_callback Run when sidebar is displayed.
+ * @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;
+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;
+
+ $id = strtolower($id);
+ $id_base = _get_widget_id_base($id);
if ( empty($control_callback) ) {
unset($wp_registered_widget_controls[$id]);
+ unset($wp_registered_widget_updates[$id_base]);
+ return;
+ }
+
+ if ( in_array($control_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($control_callback) ) {
+ unset( $wp_registered_widgets[ $id ] );
return;
}
@@ -187,25 +501,124 @@ function wp_register_widget_control($id, $name, $control_callback, $options = ar
$widget = array_merge($widget, $options);
$wp_registered_widget_controls[$id] = $widget;
+
+ if ( isset($wp_registered_widget_updates[$id_base]) )
+ return;
+
+ if ( isset($widget['params'][0]['number']) )
+ $widget['params'][0]['number'] = -1;
+
+ unset($widget['width'], $widget['height'], $widget['name'], $widget['id']);
+ $wp_registered_widget_updates[$id_base] = $widget;
}
-function unregister_widget_control($id) {
- return wp_unregister_widget_control($id);
+/**
+ * Registers the update callback for a widget.
+ *
+ * @since 2.8.0
+ *
+ * @global array $wp_registered_widget_updates
+ *
+ * @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() ) {
+ global $wp_registered_widget_updates;
+
+ if ( isset($wp_registered_widget_updates[$id_base]) ) {
+ if ( empty($update_callback) )
+ unset($wp_registered_widget_updates[$id_base]);
+ return;
+ }
+
+ $widget = array(
+ 'callback' => $update_callback,
+ 'params' => array_slice(func_get_args(), 3)
+ );
+
+ $widget = array_merge($widget, $options);
+ $wp_registered_widget_updates[$id_base] = $widget;
}
+/**
+ * Registers the form callback for a widget.
+ *
+ * @since 2.8.0
+ *
+ * @global array $wp_registered_widget_controls
+ *
+ * @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;
+
+ $id = strtolower($id);
+
+ if ( empty($form_callback) ) {
+ unset($wp_registered_widget_controls[$id]);
+ return;
+ }
+
+ if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) )
+ return;
+
+ $defaults = array('width' => 250, 'height' => 200 );
+ $options = wp_parse_args($options, $defaults);
+ $options['width'] = (int) $options['width'];
+ $options['height'] = (int) $options['height'];
+
+ $widget = array(
+ 'name' => $name,
+ 'id' => $id,
+ 'callback' => $form_callback,
+ 'params' => array_slice(func_get_args(), 4)
+ );
+ $widget = array_merge($widget, $options);
+
+ $wp_registered_widget_controls[$id] = $widget;
+}
+
+/**
+ * Remove control callback for widget.
+ *
+ * @since 2.2.0
+ *
+ * @param int|string $id Widget ID.
+ */
function wp_unregister_widget_control($id) {
- return wp_register_widget_control($id, '', '');
+ wp_register_widget_control( $id, '', '' );
}
-function dynamic_sidebar($index = 1) {
+/**
+ * Display dynamic sidebar.
+ *
+ * By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or
+ * 'name' parameter for its registered sidebars you can pass an id or name as the $index parameter.
+ * Otherwise, you can pass in a numerical index to display the sidebar at that index.
+ *
+ * @since 2.2.0
+ *
+ * @global array $wp_registered_sidebars
+ * @global array $wp_registered_widgets
+ *
+ * @param int|string $index Optional, default is 1. Index, name or ID of dynamic sidebar.
+ * @return bool True, if widget sidebar was found and called. False if not found or not called.
+ */
+function dynamic_sidebar( $index = 1 ) {
global $wp_registered_sidebars, $wp_registered_widgets;
- if ( is_int($index) ) {
+ if ( is_int( $index ) ) {
$index = "sidebar-$index";
} else {
- $index = sanitize_title($index);
- foreach ( $wp_registered_sidebars as $key => $value ) {
- if ( sanitize_title($value['name']) == $index ) {
+ $index = sanitize_title( $index );
+ foreach ( (array) $wp_registered_sidebars as $key => $value ) {
+ if ( sanitize_title( $value['name'] ) == $index ) {
$index = $key;
break;
}
@@ -213,14 +626,35 @@ function dynamic_sidebar($index = 1) {
}
$sidebars_widgets = wp_get_sidebars_widgets();
+ if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) {
+ /** This action is documented in wp-includes/widget.php */
+ do_action( 'dynamic_sidebar_before', $index, false );
+ /** This action is documented in wp-includes/widget.php */
+ do_action( 'dynamic_sidebar_after', $index, false );
+ /** This filter is documented in wp-includes/widget.php */
+ return apply_filters( 'dynamic_sidebar_has_widgets', false, $index );
+ }
- if ( empty($wp_registered_sidebars[$index]) || !array_key_exists($index, $sidebars_widgets) || !is_array($sidebars_widgets[$index]) || empty($sidebars_widgets[$index]) )
- return false;
-
+ /**
+ * 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.
+ *
+ * @since 3.9.0
+ *
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ * @param bool $has_widgets Whether the sidebar is populated with widgets.
+ * Default true.
+ */
+ do_action( 'dynamic_sidebar_before', $index, true );
$sidebar = $wp_registered_sidebars[$index];
$did_one = false;
- foreach ( $sidebars_widgets[$index] as $id ) {
+ foreach ( (array) $sidebars_widgets[$index] as $id ) {
+
+ if ( !isset($wp_registered_widgets[$id]) ) continue;
+
$params = array_merge(
array( array_merge( $sidebar, array('widget_id' => $id, 'widget_name' => $wp_registered_widgets[$id]['name']) ) ),
(array) $wp_registered_widgets[$id]['params']
@@ -237,42 +671,167 @@ function dynamic_sidebar($index = 1) {
$classname_ = ltrim($classname_, '_');
$params[0]['before_widget'] = sprintf($params[0]['before_widget'], $id, $classname_);
+ /**
+ * 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.
+ *
+ * @since 2.5.0
+ *
+ * @see register_sidebar()
+ *
+ * @param array $params {
+ * @type array $args {
+ * An array of widget display arguments.
+ *
+ * @type string $name Name of the sidebar the widget is assigned to.
+ * @type string $id ID of the sidebar the widget is assigned to.
+ * @type string $description The sidebar description.
+ * @type string $class CSS class applied to the sidebar container.
+ * @type string $before_widget HTML markup to prepend to each widget in the sidebar.
+ * @type string $after_widget HTML markup to append to each widget in the sidebar.
+ * @type string $before_title HTML markup to prepend to the widget title when displayed.
+ * @type string $after_title HTML markup to append to the widget title when displayed.
+ * @type string $widget_id ID of the widget.
+ * @type string $widget_name Name of the widget.
+ * }
+ * @type array $widget_args {
+ * An array of multi-widget arguments.
+ *
+ * @type int $number Number increment used for multiples of the same widget.
+ * }
+ * }
+ */
$params = apply_filters( 'dynamic_sidebar_params', $params );
$callback = $wp_registered_widgets[$id]['callback'];
+ /**
+ * Fires before a widget's display callback is called.
+ *
+ * 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.
+ *
+ * @since 3.0.0
+ *
+ * @param array $widget_id {
+ * An associative array of widget arguments.
+ *
+ * @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
+ * 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
+ * with an array containing the widget object, see $callback.
+ * }
+ */
+ do_action( 'dynamic_sidebar', $wp_registered_widgets[ $id ] );
+
if ( is_callable($callback) ) {
call_user_func_array($callback, $params);
$did_one = true;
}
}
- return $did_one;
+ /**
+ * 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.
+ *
+ * @since 3.9.0
+ *
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ * @param bool $has_widgets Whether the sidebar is populated with widgets.
+ * Default true.
+ */
+ do_action( 'dynamic_sidebar_after', $index, true );
+
+ /**
+ * 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.
+ *
+ * @since 3.9.0
+ *
+ * @param bool $did_one Whether at least one widget was rendered in the sidebar.
+ * Default false.
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ */
+ return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index );
}
-/* @return mixed false if widget is not active or id of sidebar in which the widget is active
+/**
+ * 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
+ * Without the optional $widget_id parameter, returns the ID of the first sidebar
+ * in which the first instance of the widget with the given callback or $id_base is found.
+ * With the $widget_id parameter, returns the ID of the sidebar where
+ * 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 {@see 'init'} or later.
+ *
+ * @since 2.2.0
+ *
+ * @global array $wp_registered_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, $widget_id = false) {
+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(false);
-
- if ( is_array($sidebars_widgets) ) foreach ( $sidebars_widgets as $sidebar => $widgets )
- if ( is_array($widgets) ) foreach ( $widgets as $widget )
- if ( isset($wp_registered_widgets[$widget]['callback']) && $wp_registered_widgets[$widget]['callback'] == $callback )
- if ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] )
- return $sidebar;
+ $sidebars_widgets = wp_get_sidebars_widgets();
+ if ( is_array($sidebars_widgets) ) {
+ foreach ( $sidebars_widgets as $sidebar => $widgets ) {
+ if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) ) {
+ continue;
+ }
+ if ( is_array($widgets) ) {
+ foreach ( $widgets as $widget ) {
+ if ( ( $callback && isset($wp_registered_widgets[$widget]['callback']) && $wp_registered_widgets[$widget]['callback'] == $callback ) || ( $id_base && _get_widget_id_base($widget) == $id_base ) ) {
+ if ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] )
+ return $sidebar;
+ }
+ }
+ }
+ }
+ }
return false;
}
+/**
+ * Whether the dynamic sidebar is enabled and used by theme.
+ *
+ * @since 2.2.0
+ *
+ * @global array $wp_registered_widgets
+ * @global array $wp_registered_sidebars
+ *
+ * @return bool True, if using widgets. False, if not using widgets.
+ */
function is_dynamic_sidebar() {
global $wp_registered_widgets, $wp_registered_sidebars;
$sidebars_widgets = get_option('sidebars_widgets');
- foreach ( $wp_registered_sidebars as $index => $sidebar ) {
- if ( count($sidebars_widgets[$index]) ) {
- foreach ( $sidebars_widgets[$index] as $widget )
+ foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
+ if ( ! empty( $sidebars_widgets[ $index ] ) ) {
+ foreach ( (array) $sidebars_widgets[$index] as $widget )
if ( array_key_exists($widget, $wp_registered_widgets) )
return true;
}
@@ -280,1278 +839,637 @@ function is_dynamic_sidebar() {
return false;
}
-/* Internal Functions */
-
-function wp_get_sidebars_widgets($update = true) {
- global $wp_registered_widgets, $wp_registered_sidebars;
+/**
+ * Whether a sidebar is in use.
+ *
+ * @since 2.8.0
+ *
+ * @param string|int $index Sidebar name, id or number to check.
+ * @return bool true if the sidebar is in use, false otherwise.
+ */
+function is_active_sidebar( $index ) {
+ $index = ( is_int($index) ) ? "sidebar-$index" : sanitize_title($index);
+ $sidebars_widgets = wp_get_sidebars_widgets();
+ $is_active_sidebar = ! empty( $sidebars_widgets[$index] );
+
+ /**
+ * Filters whether a dynamic sidebar is considered "active".
+ *
+ * @since 3.9.0
+ *
+ * @param bool $is_active_sidebar Whether or not the sidebar should be considered "active".
+ * In other words, whether the sidebar contains any widgets.
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ */
+ return apply_filters( 'is_active_sidebar', $is_active_sidebar, $index );
+}
- $sidebars_widgets = get_option('sidebars_widgets');
- $_sidebars_widgets = array();
-
- if ( !isset($sidebars_widgets['array_version']) )
- $sidebars_widgets['array_version'] = 1;
-
- switch ( $sidebars_widgets['array_version'] ) {
- case 1 :
- foreach ( $sidebars_widgets as $index => $sidebar )
- if ( is_array($sidebar) )
- foreach ( $sidebar as $i => $name ) {
- $id = strtolower($name);
- if ( isset($wp_registered_widgets[$id]) ) {
- $_sidebars_widgets[$index][$i] = $id;
- continue;
- }
- $id = sanitize_title($name);
- if ( isset($wp_registered_widgets[$id]) ) {
- $_sidebars_widgets[$index][$i] = $id;
- continue;
- }
-
- $found = false;
-
- foreach ( $wp_registered_widgets as $widget_id => $widget ) {
- if ( strtolower($widget['name']) == strtolower($name) ) {
- $_sidebars_widgets[$index][$i] = $widget['id'];
- $found = true;
- break;
- } elseif ( sanitize_title($widget['name']) == sanitize_title($name) ) {
- $_sidebars_widgets[$index][$i] = $widget['id'];
- $found = true;
- break;
- }
- }
-
- if ( $found )
- continue;
-
- unset($_sidebars_widgets[$index][$i]);
- }
- $_sidebars_widgets['array_version'] = 2;
- $sidebars_widgets = $_sidebars_widgets;
- unset($_sidebars_widgets);
-
- case 2 :
- $sidebars = array_keys( $wp_registered_sidebars );
- if ( !empty( $sidebars ) ) {
- // Move the known-good ones first
- foreach ( $sidebars as $id ) {
- if ( array_key_exists( $id, $sidebars_widgets ) ) {
- $_sidebars_widgets[$id] = $sidebars_widgets[$id];
- unset($sidebars_widgets[$id], $sidebars[$id]);
- }
- }
+//
+// Internal Functions
+//
+
+/**
+ * Retrieve full list of sidebars and their widget instance IDs.
+ *
+ * Will upgrade sidebar widget list, if needed. Will also save updated list, if
+ * needed.
+ *
+ * @since 2.2.0
+ * @access private
+ *
+ * @global array $_wp_sidebars_widgets
+ * @global array $sidebars_widgets
+ *
+ * @param bool $deprecated Not used (argument deprecated).
+ * @return array Upgraded list of widgets to version 3 array format when called from the admin.
+ */
+function wp_get_sidebars_widgets( $deprecated = true ) {
+ if ( $deprecated !== true )
+ _deprecated_argument( __FUNCTION__, '2.8.1' );
- // Assign to each unmatched registered sidebar the first available orphan
- unset( $sidebars_widgets[ 'array_version' ] );
- while ( ( $sidebar = array_shift( $sidebars ) ) && $widgets = array_shift( $sidebars_widgets ) )
- $_sidebars_widgets[ $sidebar ] = $widgets;
+ global $_wp_sidebars_widgets, $sidebars_widgets;
- $_sidebars_widgets['array_version'] = 3;
- $sidebars_widgets = $_sidebars_widgets;
- unset($_sidebars_widgets);
- }
+ // If loading from front page, consult $_wp_sidebars_widgets rather than options
+ // to see if wp_convert_widget_settings() has made manipulations in memory.
+ if ( !is_admin() ) {
+ if ( empty($_wp_sidebars_widgets) )
+ $_wp_sidebars_widgets = get_option('sidebars_widgets', array());
- if ( $update )
- update_option('sidebars_widgets', $sidebars_widgets);
+ $sidebars_widgets = $_wp_sidebars_widgets;
+ } else {
+ $sidebars_widgets = get_option('sidebars_widgets', array());
}
- unset($sidebars_widgets['array_version']);
-
- return $sidebars_widgets;
+ if ( is_array( $sidebars_widgets ) && isset($sidebars_widgets['array_version']) )
+ unset($sidebars_widgets['array_version']);
+
+ /**
+ * Filters the list of sidebars and their widgets.
+ *
+ * @since 2.7.0
+ *
+ * @param array $sidebars_widgets An associative array of sidebars and their widgets.
+ */
+ return apply_filters( 'sidebars_widgets', $sidebars_widgets );
}
+/**
+ * Set the sidebar widget option to update sidebars.
+ *
+ * @since 2.2.0
+ * @access private
+ *
+ * @param array $sidebars_widgets Sidebar widgets and their settings.
+ */
function wp_set_sidebars_widgets( $sidebars_widgets ) {
+ if ( !isset( $sidebars_widgets['array_version'] ) )
+ $sidebars_widgets['array_version'] = 3;
update_option( 'sidebars_widgets', $sidebars_widgets );
}
+/**
+ * Retrieve default registered sidebars list.
+ *
+ * @since 2.2.0
+ * @access private
+ *
+ * @global array $wp_registered_sidebars
+ *
+ * @return array
+ */
function wp_get_widget_defaults() {
global $wp_registered_sidebars;
$defaults = array();
- foreach ( $wp_registered_sidebars as $index => $sidebar )
+ foreach ( (array) $wp_registered_sidebars as $index => $sidebar )
$defaults[$index] = array();
return $defaults;
}
-/* Default Widgets */
-
-function wp_widget_pages( $args ) {
- extract( $args );
- $options = get_option( 'widget_pages' );
-
- $title = empty( $options['title'] ) ? __( 'Pages' ) : $options['title'];
- $sortby = empty( $options['sortby'] ) ? 'menu_order' : $options['sortby'];
- $exclude = empty( $options['exclude'] ) ? '' : $options['exclude'];
-
- if ( $sortby == 'menu_order' ) {
- $sortby = 'menu_order, post_title';
- }
-
- $out = wp_list_pages( array('title_li' => '', 'echo' => 0, 'sort_column' => $sortby, 'exclude' => $exclude) );
-
- if ( !empty( $out ) ) {
-?>
-
-
- - -
-
-
-
-
-
-
-
-
-
- - - -
- 'widget_text', 'description' => __('Arbitrary text or HTML')); - $control_ops = array('width' => 400, 'height' => 350, 'id_base' => 'text'); - $name = __('Text'); - - $id = false; - foreach ( array_keys($options) as $o ) { - // Old widgets can have null values for some reason - if ( !isset($options[$o]['title']) || !isset($options[$o]['text']) ) - continue; - $id = "text-$o"; // Never never never translate an id - wp_register_sidebar_widget($id, $name, 'wp_widget_text', $widget_ops, array( 'number' => $o )); - wp_register_widget_control($id, $name, 'wp_widget_text_control', $control_ops, array( 'number' => $o )); - } - - // If there are none, we register the widget's existance with a generic template - if ( !$id ) { - wp_register_sidebar_widget( 'text-1', $name, 'wp_widget_text', $widget_ops, array( 'number' => -1 ) ); - wp_register_widget_control( 'text-1', $name, 'wp_widget_text_control', $control_ops, array( 'number' => -1 ) ); - } -} - -// See large comment section at end of this file -function wp_widget_categories($args, $widget_args = 1) { - extract($args, EXTR_SKIP); - if ( is_numeric($widget_args) ) - $widget_args = array( 'number' => $widget_args ); - $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); - extract($widget_args, EXTR_SKIP); - - $options = get_option('widget_categories'); - if ( !isset($options[$number]) ) - return; - - $c = $options[$number]['count'] ? '1' : '0'; - $h = $options[$number]['hierarchical'] ? '1' : '0'; - $d = $options[$number]['dropdown'] ? '1' : '0'; - - $title = empty($options[$number]['title']) ? __('Categories') : $options[$number]['title']; - - echo $before_widget; - echo $before_title . $title . $after_title; - - $cat_args = "orderby=name&show_count={$c}&hierarchical={$h}"; - - if ( $d ) { - wp_dropdown_categories($cat_args . '&show_option_none= ' . __('Select Category')); -?> + } - - - -- -
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
' . sprintf( __('RSS Error: %s'), $rss->get_error_message() ) . '
'; + return; + } + + $default_args = array( 'show_author' => 0, 'show_date' => 0, 'show_summary' => 0, 'items' => 0 ); + $args = wp_parse_args( $args, $default_args ); - $items = (int) $items; + $items = (int) $args['items']; if ( $items < 1 || 20 < $items ) $items = 10; - $show_summary = (int) $show_summary; - $show_author = (int) $show_author; - $show_date = (int) $show_date; - - if ( is_array( $rss->items ) && !empty( $rss->items ) ) { - $rss->items = array_slice($rss->items, 0, $items); - echo '- -
++
-- -
++
-- -
++
-- -
+/> +
-- -
+/> +
-- -
- +/> +
- + get_error_message(); } else { - $link = clean_url(strip_tags($rss->channel['link'])); - while ( strstr($link, 'http') != $link ) + $link = esc_url(strip_tags($rss->get_permalink())); + while ( stristr($link, 'http') != $link ) $link = substr($link, 1); + + $rss->__destruct(); + unset($rss); } } return compact( 'title', 'url', 'link', 'items', 'error', 'show_summary', 'show_author', 'show_date' ); } -function wp_widget_rss_register() { - if ( !$options = get_option('widget_rss') ) - $options = array(); - $widget_ops = array('classname' => 'widget_rss', 'description' => __( 'Entries from any RSS or Atom feed' )); - $control_ops = array('width' => 400, 'height' => 200, 'id_base' => 'rss'); - $name = __('RSS'); - - $id = false; - foreach ( array_keys($options) as $o ) { - // Old widgets can have null values for some reason - if ( !isset($options[$o]['url']) || !isset($options[$o]['title']) || !isset($options[$o]['items']) ) - continue; - $id = "rss-$o"; // Never never never translate an id - wp_register_sidebar_widget($id, $name, 'wp_widget_rss', $widget_ops, array( 'number' => $o )); - wp_register_widget_control($id, $name, 'wp_widget_rss_control', $control_ops, array( 'number' => $o )); - } - - // If there are none, we register the widget's existance with a generic template - if ( !$id ) { - wp_register_sidebar_widget( 'rss-1', $name, 'wp_widget_rss', $widget_ops, array( 'number' => -1 ) ); - wp_register_widget_control( 'rss-1', $name, 'wp_widget_rss_control', $control_ops, array( 'number' => -1 ) ); - } -} - -function wp_widget_tag_cloud($args) { - extract($args); - $options = get_option('widget_tag_cloud'); - $title = empty($options['title']) ? __('Tags') : $options['title']; - - echo $before_widget; - echo $before_title . $title . $after_title; - wp_tag_cloud(); - echo $after_widget; -} - -function wp_widget_tag_cloud_control() { - $options = $newoptions = get_option('widget_tag_cloud'); - - if ( $_POST['tag-cloud-submit'] ) { - $newoptions['title'] = strip_tags(stripslashes($_POST['tag-cloud-title'])); - } - - if ( $options != $newoptions ) { - $options = $newoptions; - update_option('widget_tag_cloud', $options); - } - - $title = attribute_escape( $options['title'] ); -?> --
- - 'widget_pages', 'description' => __( "Your blog's WordPress Pages") ); - wp_register_sidebar_widget('pages', __('Pages'), 'wp_widget_pages', $widget_ops); - wp_register_widget_control('pages', __('Pages'), 'wp_widget_pages_control' ); + register_widget('WP_Widget_Pages'); - $widget_ops = array('classname' => 'widget_calendar', 'description' => __( "A calendar of your blog's posts") ); - wp_register_sidebar_widget('calendar', __('Calendar'), 'wp_widget_calendar', $widget_ops); - wp_register_widget_control('calendar', __('Calendar'), 'wp_widget_calendar_control' ); + register_widget('WP_Widget_Calendar'); - $widget_ops = array('classname' => 'widget_archive', 'description' => __( "A monthly archive of your blog's posts") ); - wp_register_sidebar_widget('archives', __('Archives'), 'wp_widget_archives', $widget_ops); - wp_register_widget_control('archives', __('Archives'), 'wp_widget_archives_control' ); + register_widget('WP_Widget_Archives'); - $widget_ops = array('classname' => 'widget_links', 'description' => __( "Your blogroll") ); - wp_register_sidebar_widget('links', __('Links'), 'wp_widget_links', $widget_ops); + if ( get_option( 'link_manager_enabled' ) ) + register_widget('WP_Widget_Links'); - $widget_ops = array('classname' => 'widget_meta', 'description' => __( "Log in/out, admin, feed and WordPress links") ); - wp_register_sidebar_widget('meta', __('Meta'), 'wp_widget_meta', $widget_ops); - wp_register_widget_control('meta', __('Meta'), 'wp_widget_meta_control' ); + register_widget('WP_Widget_Meta'); - $widget_ops = array('classname' => 'widget_search', 'description' => __( "A search form for your blog") ); - wp_register_sidebar_widget('search', __('Search'), 'wp_widget_search', $widget_ops); + register_widget('WP_Widget_Search'); - $widget_ops = array('classname' => 'widget_recent_entries', 'description' => __( "The most recent posts on your blog") ); - wp_register_sidebar_widget('recent-posts', __('Recent Posts'), 'wp_widget_recent_entries', $widget_ops); - wp_register_widget_control('recent-posts', __('Recent Posts'), 'wp_widget_recent_entries_control' ); + register_widget('WP_Widget_Text'); - $widget_ops = array('classname' => 'widget_tag_cloud', 'description' => __( "Your most used tags in cloud format") ); - wp_register_sidebar_widget('tag_cloud', __('Tag Cloud'), 'wp_widget_tag_cloud', $widget_ops); - wp_register_widget_control('tag_cloud', __('Tag Cloud'), 'wp_widget_tag_cloud_control' ); + register_widget('WP_Widget_Categories'); - wp_widget_categories_register(); - wp_widget_text_register(); - wp_widget_rss_register(); - wp_widget_recent_comments_register(); + register_widget('WP_Widget_Recent_Posts'); - do_action('widgets_init'); -} - -add_action('init', 'wp_widgets_init', 1); + register_widget('WP_Widget_Recent_Comments'); -/* Pattern for multi-widget (allows multiple instances such as the text widget). + register_widget('WP_Widget_RSS'); -// Displays widget on blag -// $widget_args: number -// number: which of the several widgets of this type do we mean -function widget_many( $args, $widget_args = 1 ) { - extract( $args, EXTR_SKIP ); - if ( is_numeric($widget_args) ) - $widget_args = array( 'number' => $widget_args ); - $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); - extract( $widget_args, EXTR_SKIP ); + register_widget('WP_Widget_Tag_Cloud'); - // Data should be stored as array: array( number => data for that instance of the widget, ... ) - $options = get_option('widget_many'); - if ( !isset($options[$number]) ) - return; + register_widget('WP_Nav_Menu_Widget'); - echo $before_widget; - - // Do stuff for this widget, drawing data from $options[$number] - - echo $after_widget; + /** + * Fires after all default WordPress widgets have been registered. + * + * @since 2.2.0 + */ + do_action( 'widgets_init' ); } - -// Displays form for a particular instance of the widget. Also updates the data after a POST submit -// $widget_args: number -// number: which of the several widgets of this type do we mean -function widget_many_control( $widget_args = 1 ) { - global $wp_registered_widgets; - static $updated = false; // Whether or not we have already updated the data after a POST submit - - if ( is_numeric($widget_args) ) - $widget_args = array( 'number' => $widget_args ); - $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); - extract( $widget_args, EXTR_SKIP ); - - // Data should be stored as array: array( number => data for that instance of the widget, ... ) - $options = get_option('widget_many'); - if ( !is_array($options) ) - $options = array(); - - // We need to update the data - if ( !$updated && !empty($_POST['sidebar']) ) { - // Tells us what sidebar to put the data in - $sidebar = (string) $_POST['sidebar']; - - $sidebars_widgets = wp_get_sidebars_widgets(); - if ( isset($sidebars_widgets[$sidebar]) ) - $this_sidebar =& $sidebars_widgets[$sidebar]; - else - $this_sidebar = array(); - - foreach ( $this_sidebar as $_widget_id ) { - // Remove all widgets of this type from the sidebar. We'll add the new data in a second. This makes sure we don't get any duplicate data - // since widget ids aren't necessarily persistent across multiple updates - if ( 'widget_many' == $wp_registered_widgets[$_widget_id]['callback'] && isset($wp_registered_widgets[$_widget_id]['params'][0]['number']) ) { - $widget_number = $wp_registered_widgets[$_widget_id]['params'][0]['number']; - if ( !in_array( "many-$widget_number", $_POST['widget-id'] ) ) // the widget has been removed. "many-$widget_number" is "{id_base}-{widget_number} - unset($options[$widget_number]); - } - } - - foreach ( (array) $_POST['widget-many'] as $widget_number => $widget_many_instance ) { - // compile data from $widget_many_instance - if ( !isset($widget_many_instance['something']) && isset($options[$widget_number]) ) // user clicked cancel - continue; - $something = wp_specialchars( $widget_many_instance['something'] ); - $options[$widget_number] = array( 'something' => $something ); // Even simple widgets should store stuff in array, rather than in scalar - } - - update_option('widget_text', $options); - - $updated = true; // So that we don't go through this more than once - } - - - // Here we echo out the form - if ( -1 == $number ) { // We echo out a template for a form which can be converted to a specific form later via JS - $something = ''; - $number = '%i%'; - } else { - $something = attribute_escape($options[$number]['something']); - } - - // The form has inputs with names like widget-many[$number][something] so that all data for that instance of - // the widget are stored in one $_POST variable: $_POST['widget-many'][$number] -?> -- - -
- 'widget_many', 'description' => __('Widget which allows multiple instances')); - $control_ops = array('width' => 400, 'height' => 350, 'id_base' => 'many'); - $name = __('Many'); - - $registered = false; - foreach ( array_keys($options) as $o ) { - // Old widgets can have null values for some reason - if ( !isset($options[$o]['something']) ) // we used 'something' above in our exampple. Replace with with whatever your real data are. - continue; - - // $id should look like {$id_base}-{$o} - $id = "many-$o"; // Never never never translate an id - $registered = true; - wp_register_sidebar_widget( $id, $name, 'wp_widget_text', $widget_ops, array( 'number' => $o ) ); - wp_register_widget_control( $id, $name, 'wp_widget_text_control', $control_ops, array( 'number' => $o ) ); - } - - // If there are none, we register the widget's existance with a generic template - if ( !$registered ) { - wp_register_sidebar_widget( 'many-1', $name, 'widget_many', $widget_ops, array( 'number' => -1 ) ); - wp_register_widget_control( 'many-1', $name, 'widget_many_control', $control_ops, array( 'number' => -1 ) ); - } -} - -// This is important -add_action( 'widgets_init', 'widget_many_register' ) - -*/ - -?>