3 * API for creating dynamic sidebar without hardcoding functionality into
4 * themes. Includes both internal WordPress routines and theme use routines.
6 * This functionality was found in a plugin before WordPress 2.2 release which
7 * included it in the core from that point on.
9 * @link http://codex.wordpress.org/Plugins/WordPress_Widgets WordPress Widgets
10 * @link http://codex.wordpress.org/Plugins/WordPress_Widgets_Api Widgets API
17 * This class must be extended for each widget and WP_Widget::widget(), WP_Widget::update()
18 * and WP_Widget::form() need to be over-ridden.
26 var $id_base; // Root id for all widgets of this type.
27 var $name; // Name for this widget type.
28 var $widget_options; // Option array passed to wp_register_sidebar_widget()
29 var $control_options; // Option array passed to wp_register_widget_control()
31 var $number = false; // Unique ID number of the current instance.
32 var $id = false; // Unique ID string of the current instance (id_base-number)
33 var $updated = false; // Set true when we update the data after a POST submit - makes sure we don't do it twice.
35 // Member functions that you must over-ride.
37 /** Echo the widget content.
39 * Subclasses should over-ride this function to generate their widget code.
41 * @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
42 * @param array $instance The settings for the particular instance of the widget
44 function widget($args, $instance) {
45 die('function WP_Widget::widget() must be over-ridden in a sub-class.');
48 /** Update a particular instance.
50 * This function should check that $new_instance is set correctly.
51 * The newly calculated value of $instance should be returned.
52 * If "false" is returned, the instance won't be saved/updated.
54 * @param array $new_instance New settings for this instance as input by the user via form()
55 * @param array $old_instance Old settings for this instance
56 * @return array Settings to save or bool false to cancel saving
58 function update($new_instance, $old_instance) {
62 /** Echo the settings update form
64 * @param array $instance Current settings
66 function form($instance) {
67 echo '<p class="no-options-widget">' . __('There are no options for this widget.') . '</p>';
71 // Functions you'll need to call.
76 function WP_Widget( $id_base = false, $name, $widget_options = array(), $control_options = array() ) {
77 $this->__construct( $id_base, $name, $widget_options, $control_options );
83 * @param string $id_base Optional Base ID for the widget, lower case,
84 * if left empty a portion of the widget's class name will be used. Has to be unique.
85 * @param string $name Name for the widget displayed on the configuration page.
86 * @param array $widget_options Optional Passed to wp_register_sidebar_widget()
87 * - description: shown on the configuration page
89 * @param array $control_options Optional Passed to wp_register_widget_control()
90 * - width: required if more than 250px
91 * - height: currently not used but may be needed in the future
93 function __construct( $id_base = false, $name, $widget_options = array(), $control_options = array() ) {
94 $this->id_base = empty($id_base) ? preg_replace( '/(wp_)?widget_/', '', strtolower(get_class($this)) ) : strtolower($id_base);
96 $this->option_name = 'widget_' . $this->id_base;
97 $this->widget_options = wp_parse_args( $widget_options, array('classname' => $this->option_name) );
98 $this->control_options = wp_parse_args( $control_options, array('id_base' => $this->id_base) );
102 * Constructs name attributes for use in form() fields
104 * This function should be used in form() methods to create name attributes for fields to be saved by update()
106 * @param string $field_name Field name
107 * @return string Name attribute for $field_name
109 function get_field_name($field_name) {
110 return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']';
114 * Constructs id attributes for use in form() fields
116 * This function should be used in form() methods to create id attributes for fields to be saved by update()
118 * @param string $field_name Field name
119 * @return string ID attribute for $field_name
121 function get_field_id($field_name) {
122 return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name;
125 // Private Functions. Don't worry about these.
127 function _register() {
128 $settings = $this->get_settings();
130 if ( empty($settings) ) {
131 // If there are none, we register the widget's existance with a
134 $this->_register_one();
135 } elseif ( is_array($settings) ) {
136 foreach ( array_keys($settings) as $number ) {
137 if ( is_numeric($number) ) {
138 $this->_set($number);
139 $this->_register_one($number);
145 function _set($number) {
146 $this->number = $number;
147 $this->id = $this->id_base . '-' . $number;
150 function _get_display_callback() {
151 return array(&$this, 'display_callback');
154 function _get_update_callback() {
155 return array(&$this, 'update_callback');
158 function _get_form_callback() {
159 return array(&$this, 'form_callback');
162 /** Generate the actual widget content.
163 * Just finds the instance and calls widget().
164 * Do NOT over-ride this function. */
165 function display_callback( $args, $widget_args = 1 ) {
166 if ( is_numeric($widget_args) )
167 $widget_args = array( 'number' => $widget_args );
169 $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
170 $this->_set( $widget_args['number'] );
171 $instance = $this->get_settings();
173 if ( array_key_exists( $this->number, $instance ) ) {
174 $instance = $instance[$this->number];
175 // filters the widget's settings, return false to stop displaying the widget
176 $instance = apply_filters('widget_display_callback', $instance, $this, $args);
177 if ( false !== $instance )
178 $this->widget($args, $instance);
182 /** Deal with changed settings.
183 * Do NOT over-ride this function. */
184 function update_callback( $widget_args = 1 ) {
185 global $wp_registered_widgets;
187 if ( is_numeric($widget_args) )
188 $widget_args = array( 'number' => $widget_args );
190 $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
191 $all_instances = $this->get_settings();
193 // We need to update the data
194 if ( $this->updated )
197 $sidebars_widgets = wp_get_sidebars_widgets();
199 if ( isset($_POST['delete_widget']) && $_POST['delete_widget'] ) {
200 // Delete the settings for this instance of the widget
201 if ( isset($_POST['the-widget-id']) )
202 $del_id = $_POST['the-widget-id'];
206 if ( isset($wp_registered_widgets[$del_id]['params'][0]['number']) ) {
207 $number = $wp_registered_widgets[$del_id]['params'][0]['number'];
209 if ( $this->id_base . '-' . $number == $del_id )
210 unset($all_instances[$number]);
213 if ( isset($_POST['widget-' . $this->id_base]) && is_array($_POST['widget-' . $this->id_base]) ) {
214 $settings = $_POST['widget-' . $this->id_base];
215 } elseif ( isset($_POST['id_base']) && $_POST['id_base'] == $this->id_base ) {
216 $num = $_POST['multi_number'] ? (int) $_POST['multi_number'] : (int) $_POST['widget_number'];
217 $settings = array( $num => array() );
222 foreach ( $settings as $number => $new_instance ) {
223 $new_instance = stripslashes_deep($new_instance);
224 $this->_set($number);
226 $old_instance = isset($all_instances[$number]) ? $all_instances[$number] : array();
228 $instance = $this->update($new_instance, $old_instance);
230 // filters the widget's settings before saving, return false to cancel saving (keep the old settings if updating)
231 $instance = apply_filters('widget_update_callback', $instance, $new_instance, $old_instance, $this);
232 if ( false !== $instance )
233 $all_instances[$number] = $instance;
235 break; // run only once
239 $this->save_settings($all_instances);
240 $this->updated = true;
243 /** Generate the control form.
244 * Do NOT over-ride this function. */
245 function form_callback( $widget_args = 1 ) {
246 if ( is_numeric($widget_args) )
247 $widget_args = array( 'number' => $widget_args );
249 $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
250 $all_instances = $this->get_settings();
252 if ( -1 == $widget_args['number'] ) {
253 // We echo out a form where 'number' can be set later
254 $this->_set('__i__');
257 $this->_set($widget_args['number']);
258 $instance = $all_instances[ $widget_args['number'] ];
261 // filters the widget admin form before displaying, return false to stop displaying it
262 $instance = apply_filters('widget_form_callback', $instance, $this);
265 if ( false !== $instance ) {
266 $return = $this->form($instance);
267 // add extra fields in the widget form - be sure to set $return to null if you add any
268 // if the widget has no form the text echoed from the default form method can be hidden using css
269 do_action_ref_array( 'in_widget_form', array(&$this, &$return, $instance) );
274 /** Helper function: Registers a single instance. */
275 function _register_one($number = -1) {
276 wp_register_sidebar_widget( $this->id, $this->name, $this->_get_display_callback(), $this->widget_options, array( 'number' => $number ) );
277 _register_widget_update_callback( $this->id_base, $this->_get_update_callback(), $this->control_options, array( 'number' => -1 ) );
278 _register_widget_form_callback( $this->id, $this->name, $this->_get_form_callback(), $this->control_options, array( 'number' => $number ) );
281 function save_settings($settings) {
282 $settings['_multiwidget'] = 1;
283 update_option( $this->option_name, $settings );
286 function get_settings() {
287 $settings = get_option($this->option_name);
289 if ( false === $settings && isset($this->alt_option_name) )
290 $settings = get_option($this->alt_option_name);
292 if ( !is_array($settings) )
295 if ( !array_key_exists('_multiwidget', $settings) ) {
296 // old format, conver if single widget
297 $settings = wp_convert_widget_settings($this->id_base, $this->option_name, $settings);
300 unset($settings['_multiwidget'], $settings['__i__']);
306 * Singleton that registers and instantiates WP_Widget classes.
309 * @subpackage Widgets
312 class WP_Widget_Factory {
313 var $widgets = array();
315 function WP_Widget_Factory() {
316 add_action( 'widgets_init', array( &$this, '_register_widgets' ), 100 );
319 function register($widget_class) {
320 $this->widgets[$widget_class] = & new $widget_class();
323 function unregister($widget_class) {
324 if ( isset($this->widgets[$widget_class]) )
325 unset($this->widgets[$widget_class]);
328 function _register_widgets() {
329 global $wp_registered_widgets;
330 $keys = array_keys($this->widgets);
331 $registered = array_keys($wp_registered_widgets);
332 $registered = array_map('_get_widget_id_base', $registered);
334 foreach ( $keys as $key ) {
335 // don't register new widget if old widget with the same id is already registered
336 if ( in_array($this->widgets[$key]->id_base, $registered, true) ) {
337 unset($this->widgets[$key]);
341 $this->widgets[$key]->_register();
346 /* Global Variables */
349 global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
352 * Stores the sidebars, since many themes can have more than one.
354 * @global array $wp_registered_sidebars
357 $wp_registered_sidebars = array();
360 * Stores the registered widgets.
362 * @global array $wp_registered_widgets
365 $wp_registered_widgets = array();
368 * Stores the registered widget control (options).
370 * @global array $wp_registered_widget_controls
373 $wp_registered_widget_controls = array();
374 $wp_registered_widget_updates = array();
379 $_wp_sidebars_widgets = array();
384 $_wp_deprecated_widgets_callbacks = array(
386 'wp_widget_pages_control',
387 'wp_widget_calendar',
388 'wp_widget_calendar_control',
389 'wp_widget_archives',
390 'wp_widget_archives_control',
393 'wp_widget_meta_control',
395 'wp_widget_recent_entries',
396 'wp_widget_recent_entries_control',
397 'wp_widget_tag_cloud',
398 'wp_widget_tag_cloud_control',
399 'wp_widget_categories',
400 'wp_widget_categories_control',
402 'wp_widget_text_control',
404 'wp_widget_rss_control',
405 'wp_widget_recent_comments',
406 'wp_widget_recent_comments_control'
409 /* Template tags & API functions */
414 * Registers a WP_Widget widget
419 * @see WP_Widget_Factory
420 * @uses WP_Widget_Factory
422 * @param string $widget_class The name of a class that extends WP_Widget
424 function register_widget($widget_class) {
425 global $wp_widget_factory;
427 $wp_widget_factory->register($widget_class);
431 * Unregister a widget
433 * Unregisters a WP_Widget widget. Useful for unregistering default widgets.
434 * Run within a function hooked to the widgets_init action.
439 * @see WP_Widget_Factory
440 * @uses WP_Widget_Factory
442 * @param string $widget_class The name of a class that extends WP_Widget
444 function unregister_widget($widget_class) {
445 global $wp_widget_factory;
447 $wp_widget_factory->unregister($widget_class);
451 * Creates multiple sidebars.
453 * If you wanted to quickly create multiple sidebars for a theme or internally.
454 * This function will allow you to do so. If you don't pass the 'name' and/or
455 * 'id' in $args, then they will be built for you.
457 * The default for the name is "Sidebar #", with '#' being replaced with the
458 * number the sidebar is currently when greater than one. If first sidebar, the
459 * name will be just "Sidebar". The default for id is "sidebar-" followed by the
460 * number the sidebar creation is currently at.
464 * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here.
465 * @uses parse_str() Converts a string to an array to be used in the rest of the function.
466 * @uses register_sidebar() Sends single sidebar information [name, id] to this
467 * function to handle building the sidebar.
469 * @param int $number Number of sidebars to create.
470 * @param string|array $args Builds Sidebar based off of 'name' and 'id' values.
472 function register_sidebars($number = 1, $args = array()) {
473 global $wp_registered_sidebars;
474 $number = (int) $number;
476 if ( is_string($args) )
477 parse_str($args, $args);
479 for ( $i=1; $i <= $number; $i++ ) {
483 $_args['name'] = isset($args['name']) ? sprintf($args['name'], $i) : sprintf(__('Sidebar %d'), $i);
485 $_args['name'] = isset($args['name']) ? $args['name'] : __('Sidebar');
488 if (isset($args['id'])) {
489 $_args['id'] = $args['id'];
491 $n = count($wp_registered_sidebars);
494 $_args['id'] = "sidebar-$n";
495 } while (isset($wp_registered_sidebars[$_args['id']]));
498 register_sidebar($_args);
503 * Builds the definition for a single sidebar and returns the ID.
505 * The $args parameter takes either a string or an array with 'name' and 'id'
506 * contained in either usage. It will be noted that the values will be applied
507 * to all sidebars, so if creating more than one, it will be advised to allow
508 * for WordPress to create the defaults for you.
510 * Example for string would be <code>'name=whatever;id=whatever1'</code> and for
511 * the array it would be <code>array(
512 * 'name' => 'whatever',
513 * 'id' => 'whatever1')</code>.
515 * name - The name of the sidebar, which presumably the title which will be
517 * id - The unique identifier by which the sidebar will be called by.
518 * before_widget - The content that will prepended to the widgets when they are
520 * after_widget - The content that will be appended to the widgets when they are
522 * before_title - The content that will be prepended to the title when displayed.
523 * after_title - the content that will be appended to the title when displayed.
525 * <em>Content</em> is assumed to be HTML and should be formatted as such, but
526 * doesn't have to be.
529 * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
530 * @uses parse_str() Converts a string to an array to be used in the rest of the function.
531 * @usedby register_sidebars()
533 * @param string|array $args Builds Sidebar based off of 'name' and 'id' values
534 * @return string The sidebar id that was added.
536 function register_sidebar($args = array()) {
537 global $wp_registered_sidebars;
539 if ( is_string($args) )
540 parse_str($args, $args);
542 $i = count($wp_registered_sidebars) + 1;
545 'name' => sprintf(__('Sidebar %d'), $i ),
546 'id' => "sidebar-$i",
547 'before_widget' => '<li id="%1$s" class="widget %2$s">',
548 'after_widget' => "</li>\n",
549 'before_title' => '<h2 class="widgettitle">',
550 'after_title' => "</h2>\n",
553 $sidebar = array_merge($defaults, (array) $args);
555 $wp_registered_sidebars[$sidebar['id']] = $sidebar;
557 return $sidebar['id'];
561 * Removes a sidebar from the list.
565 * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
567 * @param string $name The ID of the sidebar when it was added.
569 function unregister_sidebar( $name ) {
570 global $wp_registered_sidebars;
572 if ( isset( $wp_registered_sidebars[$name] ) )
573 unset( $wp_registered_sidebars[$name] );
577 * Register widget for use in sidebars.
579 * The default widget option is 'classname' that can be override.
581 * The function can also be used to unregister widgets when $output_callback
582 * parameter is an empty string.
586 * @uses $wp_registered_widgets Uses stored registered widgets.
587 * @uses $wp_register_widget_defaults Retrieves widget defaults.
589 * @param int|string $id Widget ID.
590 * @param string $name Widget display title.
591 * @param callback $output_callback Run when widget is called.
592 * @param array|string Optional. $options Widget Options.
593 * @param mixed $params,... Widget parameters to add to widget.
594 * @return null Will return if $output_callback is empty after removing widget.
596 function wp_register_sidebar_widget($id, $name, $output_callback, $options = array()) {
597 global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks;
599 $id = strtolower($id);
601 if ( empty($output_callback) ) {
602 unset($wp_registered_widgets[$id]);
606 $id_base = _get_widget_id_base($id);
607 if ( in_array($output_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($output_callback) ) {
608 if ( isset($wp_registered_widget_controls[$id]) )
609 unset($wp_registered_widget_controls[$id]);
611 if ( isset($wp_registered_widget_updates[$id_base]) )
612 unset($wp_registered_widget_updates[$id_base]);
617 $defaults = array('classname' => $output_callback);
618 $options = wp_parse_args($options, $defaults);
622 'callback' => $output_callback,
623 'params' => array_slice(func_get_args(), 4)
625 $widget = array_merge($widget, $options);
627 if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) )
628 $wp_registered_widgets[$id] = $widget;
632 * Retrieve description for widget.
634 * When registering widgets, the options can also include 'description' that
635 * describes the widget for display on the widget administration panel or
640 * @param int|string $id Widget ID.
641 * @return string Widget description, if available. Null on failure to retrieve description.
643 function wp_widget_description( $id ) {
644 if ( !is_scalar($id) )
647 global $wp_registered_widgets;
649 if ( isset($wp_registered_widgets[$id]['description']) )
650 return esc_html( $wp_registered_widgets[$id]['description'] );
654 * Remove widget from sidebar.
658 * @param int|string $id Widget ID.
660 function wp_unregister_sidebar_widget($id) {
661 wp_register_sidebar_widget($id, '', '');
662 wp_unregister_widget_control($id);
666 * Registers widget control callback for customizing options.
668 * The options contains the 'height', 'width', and 'id_base' keys. The 'height'
669 * option is never used. The 'width' option is the width of the fully expanded
670 * control form, but try hard to use the default width. The 'id_base' is for
671 * multi-widgets (widgets which allow multiple instances such as the text
672 * widget), an id_base must be provided. The widget id will end up looking like
673 * {$id_base}-{$unique_number}.
677 * @param int|string $id Sidebar ID.
678 * @param string $name Sidebar display name.
679 * @param callback $control_callback Run when sidebar is displayed.
680 * @param array|string $options Optional. Widget options. See above long description.
681 * @param mixed $params,... Optional. Additional parameters to add to widget.
683 function wp_register_widget_control($id, $name, $control_callback, $options = array()) {
684 global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks;
686 $id = strtolower($id);
687 $id_base = _get_widget_id_base($id);
689 if ( empty($control_callback) ) {
690 unset($wp_registered_widget_controls[$id]);
691 unset($wp_registered_widget_updates[$id_base]);
695 if ( in_array($control_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($control_callback) ) {
696 if ( isset($wp_registered_widgets[$id]) )
697 unset($wp_registered_widgets[$id]);
702 if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) )
705 $defaults = array('width' => 250, 'height' => 200 ); // height is never used
706 $options = wp_parse_args($options, $defaults);
707 $options['width'] = (int) $options['width'];
708 $options['height'] = (int) $options['height'];
713 'callback' => $control_callback,
714 'params' => array_slice(func_get_args(), 4)
716 $widget = array_merge($widget, $options);
718 $wp_registered_widget_controls[$id] = $widget;
720 if ( isset($wp_registered_widget_updates[$id_base]) )
723 if ( isset($widget['params'][0]['number']) )
724 $widget['params'][0]['number'] = -1;
726 unset($widget['width'], $widget['height'], $widget['name'], $widget['id']);
727 $wp_registered_widget_updates[$id_base] = $widget;
730 function _register_widget_update_callback($id_base, $update_callback, $options = array()) {
731 global $wp_registered_widget_updates;
733 if ( isset($wp_registered_widget_updates[$id_base]) ) {
734 if ( empty($update_callback) )
735 unset($wp_registered_widget_updates[$id_base]);
740 'callback' => $update_callback,
741 'params' => array_slice(func_get_args(), 3)
744 $widget = array_merge($widget, $options);
745 $wp_registered_widget_updates[$id_base] = $widget;
748 function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {
749 global $wp_registered_widget_controls;
751 $id = strtolower($id);
753 if ( empty($form_callback) ) {
754 unset($wp_registered_widget_controls[$id]);
758 if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) )
761 $defaults = array('width' => 250, 'height' => 200 );
762 $options = wp_parse_args($options, $defaults);
763 $options['width'] = (int) $options['width'];
764 $options['height'] = (int) $options['height'];
769 'callback' => $form_callback,
770 'params' => array_slice(func_get_args(), 4)
772 $widget = array_merge($widget, $options);
774 $wp_registered_widget_controls[$id] = $widget;
778 * Remove control callback for widget.
781 * @uses wp_register_widget_control() Unregisters by using empty callback.
783 * @param int|string $id Widget ID.
785 function wp_unregister_widget_control($id) {
786 return wp_register_widget_control($id, '', '');
790 * Display dynamic sidebar.
792 * By default it displays the default sidebar or 'sidebar-1'. The 'sidebar-1' is
793 * not named by the theme, the actual name is '1', but 'sidebar-' is added to
794 * the registered sidebars for the name. If you named your sidebar 'after-post',
795 * then the parameter $index will still be 'after-post', but the lookup will be
796 * for 'sidebar-after-post'.
798 * It is confusing for the $index parameter, but just know that it should just
799 * work. When you register the sidebar in the theme, you will use the same name
800 * for this function or "Pay no heed to the man behind the curtain." Just accept
801 * it as an oddity of WordPress sidebar register and display.
805 * @param int|string $index Optional, default is 1. Name or ID of dynamic sidebar.
806 * @return bool True, if widget sidebar was found and called. False if not found or not called.
808 function dynamic_sidebar($index = 1) {
809 global $wp_registered_sidebars, $wp_registered_widgets;
811 if ( is_int($index) ) {
812 $index = "sidebar-$index";
814 $index = sanitize_title($index);
815 foreach ( (array) $wp_registered_sidebars as $key => $value ) {
816 if ( sanitize_title($value['name']) == $index ) {
823 $sidebars_widgets = wp_get_sidebars_widgets();
825 if ( empty($wp_registered_sidebars[$index]) || !array_key_exists($index, $sidebars_widgets) || !is_array($sidebars_widgets[$index]) || empty($sidebars_widgets[$index]) )
828 $sidebar = $wp_registered_sidebars[$index];
831 foreach ( (array) $sidebars_widgets[$index] as $id ) {
833 if ( !isset($wp_registered_widgets[$id]) ) continue;
835 $params = array_merge(
836 array( array_merge( $sidebar, array('widget_id' => $id, 'widget_name' => $wp_registered_widgets[$id]['name']) ) ),
837 (array) $wp_registered_widgets[$id]['params']
840 // Substitute HTML id and class attributes into before_widget
842 foreach ( (array) $wp_registered_widgets[$id]['classname'] as $cn ) {
843 if ( is_string($cn) )
844 $classname_ .= '_' . $cn;
845 elseif ( is_object($cn) )
846 $classname_ .= '_' . get_class($cn);
848 $classname_ = ltrim($classname_, '_');
849 $params[0]['before_widget'] = sprintf($params[0]['before_widget'], $id, $classname_);
851 $params = apply_filters( 'dynamic_sidebar_params', $params );
853 $callback = $wp_registered_widgets[$id]['callback'];
855 if ( is_callable($callback) ) {
856 call_user_func_array($callback, $params);
865 * Whether widget is displayied on the front-end.
867 * Either $callback or $id_base can be used
868 * $id_base is the first argument when extending WP_Widget class
869 * Without the optional $widget_id parameter, returns the ID of the first sidebar
870 * in which the first instance of the widget with the given callback or $id_base is found.
871 * With the $widget_id parameter, returns the ID of the sidebar where
872 * the widget with that callback/$id_base AND that ID is found.
874 * NOTE: $widget_id and $id_base are the same for single widgets. To be effective
875 * this function has to run after widgets have initialized, at action 'init' or later.
879 * @param callback Optional, Widget callback to check.
880 * @param int $widget_id Optional, but needed for checking. Widget ID.
881 * @param string $id_base Optional, the base ID of a widget created by extending WP_Widget.
882 * @param bool $skip_inactive Optional, whether to check in 'wp_inactive_widgets'.
883 * @return mixed false if widget is not active or id of sidebar in which the widget is active.
885 function is_active_widget($callback = false, $widget_id = false, $id_base = false, $skip_inactive = true) {
886 global $wp_registered_widgets;
888 $sidebars_widgets = wp_get_sidebars_widgets();
890 if ( is_array($sidebars_widgets) ) {
891 foreach ( $sidebars_widgets as $sidebar => $widgets ) {
892 if ( $skip_inactive && 'wp_inactive_widgets' == $sidebar )
895 if ( is_array($widgets) ) {
896 foreach ( $widgets as $widget ) {
897 if ( ( $callback && isset($wp_registered_widgets[$widget]['callback']) && $wp_registered_widgets[$widget]['callback'] == $callback ) || ( $id_base && _get_widget_id_base($widget) == $id_base ) ) {
898 if ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] )
909 * Whether the dynamic sidebar is enabled and used by theme.
913 * @return bool True, if using widgets. False, if not using widgets.
915 function is_dynamic_sidebar() {
916 global $wp_registered_widgets, $wp_registered_sidebars;
917 $sidebars_widgets = get_option('sidebars_widgets');
918 foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
919 if ( count($sidebars_widgets[$index]) ) {
920 foreach ( (array) $sidebars_widgets[$index] as $widget )
921 if ( array_key_exists($widget, $wp_registered_widgets) )
929 * Whether a sidebar is in use.
933 * @param mixed $index, sidebar name, id or number to check.
934 * @return bool true if the sidebar is in use, false otherwise.
936 function is_active_sidebar( $index ) {
937 $index = ( is_int($index) ) ? "sidebar-$index" : sanitize_title($index);
938 $sidebars_widgets = wp_get_sidebars_widgets();
939 if ( isset($sidebars_widgets[$index]) && !empty($sidebars_widgets[$index]) )
945 /* Internal Functions */
948 * Retrieve full list of sidebars and their widgets.
950 * Will upgrade sidebar widget list, if needed. Will also save updated list, if
956 * @param bool $update Optional, deprecated.
957 * @return array Upgraded list of widgets to version 3 array format when called from the admin.
959 function wp_get_sidebars_widgets($deprecated = true) {
960 global $wp_registered_widgets, $wp_registered_sidebars, $_wp_sidebars_widgets;
962 // If loading from front page, consult $_wp_sidebars_widgets rather than options
963 // to see if wp_convert_widget_settings() has made manipulations in memory.
965 if ( empty($_wp_sidebars_widgets) )
966 $_wp_sidebars_widgets = get_option('sidebars_widgets', array());
968 $sidebars_widgets = $_wp_sidebars_widgets;
970 $sidebars_widgets = get_option('sidebars_widgets', array());
971 $_sidebars_widgets = array();
973 if ( isset($sidebars_widgets['wp_inactive_widgets']) )
974 $sidebars_widgets['array_version'] = 3;
975 elseif ( !isset($sidebars_widgets['array_version']) )
976 $sidebars_widgets['array_version'] = 1;
978 switch ( $sidebars_widgets['array_version'] ) {
980 foreach ( (array) $sidebars_widgets as $index => $sidebar )
981 if ( is_array($sidebar) )
982 foreach ( (array) $sidebar as $i => $name ) {
983 $id = strtolower($name);
984 if ( isset($wp_registered_widgets[$id]) ) {
985 $_sidebars_widgets[$index][$i] = $id;
988 $id = sanitize_title($name);
989 if ( isset($wp_registered_widgets[$id]) ) {
990 $_sidebars_widgets[$index][$i] = $id;
996 foreach ( $wp_registered_widgets as $widget_id => $widget ) {
997 if ( strtolower($widget['name']) == strtolower($name) ) {
998 $_sidebars_widgets[$index][$i] = $widget['id'];
1001 } elseif ( sanitize_title($widget['name']) == sanitize_title($name) ) {
1002 $_sidebars_widgets[$index][$i] = $widget['id'];
1011 unset($_sidebars_widgets[$index][$i]);
1013 $_sidebars_widgets['array_version'] = 2;
1014 $sidebars_widgets = $_sidebars_widgets;
1015 unset($_sidebars_widgets);
1018 $sidebars = array_keys( $wp_registered_sidebars );
1019 if ( !empty( $sidebars ) ) {
1020 // Move the known-good ones first
1021 foreach ( (array) $sidebars as $id ) {
1022 if ( array_key_exists( $id, $sidebars_widgets ) ) {
1023 $_sidebars_widgets[$id] = $sidebars_widgets[$id];
1024 unset($sidebars_widgets[$id], $sidebars[$id]);
1028 // move the rest to wp_inactive_widgets
1029 if ( !isset($_sidebars_widgets['wp_inactive_widgets']) )
1030 $_sidebars_widgets['wp_inactive_widgets'] = array();
1032 if ( !empty($sidebars_widgets) ) {
1033 foreach ( $sidebars_widgets as $lost => $val ) {
1034 if ( is_array($val) )
1035 $_sidebars_widgets['wp_inactive_widgets'] = array_merge( (array) $_sidebars_widgets['wp_inactive_widgets'], $val );
1039 $sidebars_widgets = $_sidebars_widgets;
1040 unset($_sidebars_widgets);
1045 if ( isset($sidebars_widgets['array_version']) )
1046 unset($sidebars_widgets['array_version']);
1048 $sidebars_widgets = apply_filters('sidebars_widgets', $sidebars_widgets);
1049 return $sidebars_widgets;
1053 * Set the sidebar widget option to update sidebars.
1058 * @param array $sidebars_widgets Sidebar widgets and their settings.
1060 function wp_set_sidebars_widgets( $sidebars_widgets ) {
1061 if ( !isset( $sidebars_widgets['array_version'] ) )
1062 $sidebars_widgets['array_version'] = 3;
1063 update_option( 'sidebars_widgets', $sidebars_widgets );
1067 * Retrieve default registered sidebars list.
1074 function wp_get_widget_defaults() {
1075 global $wp_registered_sidebars;
1077 $defaults = array();
1079 foreach ( (array) $wp_registered_sidebars as $index => $sidebar )
1080 $defaults[$index] = array();
1086 * Convert the widget settings from single to multi-widget format.
1092 function wp_convert_widget_settings($base_name, $option_name, $settings) {
1093 // This test may need expanding.
1094 $single = $changed = false;
1095 if ( empty($settings) ) {
1098 foreach ( array_keys($settings) as $number ) {
1099 if ( 'number' == $number )
1101 if ( !is_numeric($number) ) {
1109 $settings = array( 2 => $settings );
1111 // If loading from the front page, update sidebar in memory but don't save to options
1113 $sidebars_widgets = get_option('sidebars_widgets');
1115 if ( empty($GLOBALS['_wp_sidebars_widgets']) )
1116 $GLOBALS['_wp_sidebars_widgets'] = get_option('sidebars_widgets', array());
1117 $sidebars_widgets = &$GLOBALS['_wp_sidebars_widgets'];
1120 foreach ( (array) $sidebars_widgets as $index => $sidebar ) {
1121 if ( is_array($sidebar) ) {
1122 foreach ( $sidebar as $i => $name ) {
1123 if ( $base_name == $name ) {
1124 $sidebars_widgets[$index][$i] = "$name-2";
1132 if ( is_admin() && $changed )
1133 update_option('sidebars_widgets', $sidebars_widgets);
1136 $settings['_multiwidget'] = 1;
1138 update_option( $option_name, $settings );
1148 * Register widget for sidebar with backwards compatibility.
1150 * Allows $name to be an array that accepts either three elements to grab the
1151 * first element and the third for the name or just uses the first element of
1152 * the array for the name.
1154 * Passes to {@link wp_register_sidebar_widget()} after argument list and
1155 * backwards compatibility is complete.
1158 * @uses wp_register_sidebar_widget() Passes the compiled arguments.
1160 * @param string|int $name Widget ID.
1161 * @param callback $output_callback Run when widget is called.
1162 * @param string $classname Classname widget option.
1163 * @param mixed $params,... Widget parameters.
1165 function register_sidebar_widget($name, $output_callback, $classname = '') {
1167 if ( is_array($name) ) {
1168 if ( count($name) == 3 )
1169 $name = sprintf($name[0], $name[2]);
1174 $id = sanitize_title($name);
1176 if ( !empty($classname) && is_string($classname) )
1177 $options['classname'] = $classname;
1178 $params = array_slice(func_get_args(), 2);
1179 $args = array($id, $name, $output_callback, $options);
1180 if ( !empty($params) )
1181 $args = array_merge($args, $params);
1183 call_user_func_array('wp_register_sidebar_widget', $args);
1187 * Alias of {@link wp_unregister_sidebar_widget()}.
1189 * @see wp_unregister_sidebar_widget()
1193 * @param int|string $id Widget ID.
1195 function unregister_sidebar_widget($id) {
1196 return wp_unregister_sidebar_widget($id);
1200 * Registers widget control callback for customizing options.
1202 * Allows $name to be an array that accepts either three elements to grab the
1203 * first element and the third for the name or just uses the first element of
1204 * the array for the name.
1206 * Passes to {@link wp_register_widget_control()} after the argument list has
1211 * @param int|string $name Sidebar ID.
1212 * @param callback $control_callback Widget control callback to display and process form.
1213 * @param int $width Widget width.
1214 * @param int $height Widget height.
1216 function register_widget_control($name, $control_callback, $width = '', $height = '') {
1218 if ( is_array($name) ) {
1219 if ( count($name) == 3 )
1220 $name = sprintf($name[0], $name[2]);
1225 $id = sanitize_title($name);
1227 if ( !empty($width) )
1228 $options['width'] = $width;
1229 if ( !empty($height) )
1230 $options['height'] = $height;
1231 $params = array_slice(func_get_args(), 4);
1232 $args = array($id, $name, $control_callback, $options);
1233 if ( !empty($params) )
1234 $args = array_merge($args, $params);
1236 call_user_func_array('wp_register_widget_control', $args);
1240 * Alias of {@link wp_unregister_widget_control()}.
1243 * @see wp_unregister_widget_control()
1245 * @param int|string $id Widget ID.
1247 function unregister_widget_control($id) {
1248 return wp_unregister_widget_control($id);
1252 * Output an arbitrary widget as a template tag
1256 * @param string $widget the widget's PHP class name (see default-widgets.php)
1257 * @param array $instance the widget's instance settings
1258 * @param array $args the widget's sidebar args
1261 function the_widget($widget, $instance = array(), $args = array()) {
1262 global $wp_widget_factory;
1264 $widget_obj = $wp_widget_factory->widgets[$widget];
1265 if ( !is_a($widget_obj, 'WP_Widget') )
1268 $before_widget = sprintf('<div class="widget %s">', $widget_obj->widget_options['classname']);
1269 $default_args = array('before_widget' => $before_widget, 'after_widget' => "</div>", 'before_title' => '<h2 class="widgettitle">', 'after_title' => '</h2>');
1271 $args = wp_parse_args($args, $default_args);
1272 $instance = wp_parse_args($instance);
1274 $widget_obj->_set(-1);
1275 $widget_obj->widget($args, $instance);
1281 function _get_widget_id_base($id) {
1282 return preg_replace( '/-[0-9]+$/', '', $id );