X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/449d082fcc4873c1f7d363a0d9f7409be7f6e77d..11be15bd505d66a91e2c80062190b13e315a04a9:/wp-includes/widgets.php diff --git a/wp-includes/widgets.php b/wp-includes/widgets.php index 2d654018..d6f213a1 100644 --- a/wp-includes/widgets.php +++ b/wp-includes/widgets.php @@ -13,10 +13,344 @@ * @subpackage Widgets */ +/** + * This class must be extended for each widget and WP_Widget::widget(), WP_Widget::update() + * and WP_Widget::form() need to be over-ridden. + * + * @package WordPress + * @subpackage Widgets + * @since 2.8 + */ +class WP_Widget { + + var $id_base; // Root id for all widgets of this type. + var $name; // Name for this widget type. + var $widget_options; // Option array passed to wp_register_sidebar_widget() + var $control_options; // Option array passed to wp_register_widget_control() + + var $number = false; // Unique ID number of the current instance. + var $id = false; // Unique ID string of the current instance (id_base-number) + var $updated = false; // Set true when we update the data after a POST submit - makes sure we don't do it twice. + + // Member functions that you must over-ride. + + /** Echo the widget content. + * + * Subclasses should over-ride this function to generate their widget code. + * + * @param array $args Display arguments including before_title, after_title, before_widget, and after_widget. + * @param array $instance The settings for the particular instance of the widget + */ + function widget($args, $instance) { + die('function WP_Widget::widget() must be over-ridden in a sub-class.'); + } + + /** Update a particular instance. + * + * This function should check that $new_instance is set correctly. + * The newly calculated value of $instance should be returned. + * If "false" is returned, the instance won't be saved/updated. + * + * @param array $new_instance New settings for this instance as input by the user via form() + * @param array $old_instance Old settings for this instance + * @return array Settings to save or bool false to cancel saving + */ + function update($new_instance, $old_instance) { + return $new_instance; + } + + /** Echo the settings update form + * + * @param array $instance Current settings + */ + function form($instance) { + echo '

' . __('There are no options for this widget.') . '

'; + return 'noform'; + } + + // Functions you'll need to call. + + /** + * PHP5 constructor + * + * @param string $id_base Optional Base ID for the widget, lower case, + * if left empty a portion of the widget's class name will be used. Has to be unique. + * @param string $name Name for the widget displayed on the configuration page. + * @param array $widget_options Optional Passed to wp_register_sidebar_widget() + * - description: shown on the configuration page + * - classname + * @param array $control_options Optional Passed to wp_register_widget_control() + * - width: required if more than 250px + * - height: currently not used but may be needed in the future + */ + function __construct( $id_base, $name, $widget_options = array(), $control_options = array() ) { + $this->id_base = empty($id_base) ? preg_replace( '/(wp_)?widget_/', '', strtolower(get_class($this)) ) : strtolower($id_base); + $this->name = $name; + $this->option_name = 'widget_' . $this->id_base; + $this->widget_options = wp_parse_args( $widget_options, array('classname' => $this->option_name) ); + $this->control_options = wp_parse_args( $control_options, array('id_base' => $this->id_base) ); + } + + /** + * PHP4 constructor + */ + function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) { + WP_Widget::__construct( $id_base, $name, $widget_options, $control_options ); + } + + /** + * Constructs name attributes for use in form() fields + * + * This function should be used in form() methods to create name attributes for fields to be saved by update() + * + * @param string $field_name Field name + * @return string Name attribute for $field_name + */ + function get_field_name($field_name) { + return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']'; + } + + /** + * Constructs id attributes for use in form() fields + * + * This function should be used in form() methods to create id attributes for fields to be saved by update() + * + * @param string $field_name Field name + * @return string ID attribute for $field_name + */ + function get_field_id($field_name) { + return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name; + } + + // Private Functions. Don't worry about these. + + function _register() { + $settings = $this->get_settings(); + $empty = true; + + if ( is_array($settings) ) { + foreach ( array_keys($settings) as $number ) { + if ( is_numeric($number) ) { + $this->_set($number); + $this->_register_one($number); + $empty = false; + } + } + } + + if ( $empty ) { + // If there are none, we register the widget's existence with a + // generic template + $this->_set(1); + $this->_register_one(); + } + } + + function _set($number) { + $this->number = $number; + $this->id = $this->id_base . '-' . $number; + } + + function _get_display_callback() { + return array($this, 'display_callback'); + } + + function _get_update_callback() { + return array($this, 'update_callback'); + } + + function _get_form_callback() { + return array($this, 'form_callback'); + } + + /** Generate the actual widget content. + * Just finds the instance and calls widget(). + * Do NOT over-ride this function. */ + function display_callback( $args, $widget_args = 1 ) { + if ( is_numeric($widget_args) ) + $widget_args = array( 'number' => $widget_args ); + + $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); + $this->_set( $widget_args['number'] ); + $instance = $this->get_settings(); + + if ( array_key_exists( $this->number, $instance ) ) { + $instance = $instance[$this->number]; + // filters the widget's settings, return false to stop displaying the widget + $instance = apply_filters('widget_display_callback', $instance, $this, $args); + if ( false !== $instance ) + $this->widget($args, $instance); + } + } + + /** Deal with changed settings. + * Do NOT over-ride this function. */ + function update_callback( $widget_args = 1 ) { + global $wp_registered_widgets; + + if ( is_numeric($widget_args) ) + $widget_args = array( 'number' => $widget_args ); + + $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); + $all_instances = $this->get_settings(); + + // We need to update the data + if ( $this->updated ) + return; + + $sidebars_widgets = wp_get_sidebars_widgets(); + + if ( isset($_POST['delete_widget']) && $_POST['delete_widget'] ) { + // Delete the settings for this instance of the widget + if ( isset($_POST['the-widget-id']) ) + $del_id = $_POST['the-widget-id']; + else + return; + + if ( isset($wp_registered_widgets[$del_id]['params'][0]['number']) ) { + $number = $wp_registered_widgets[$del_id]['params'][0]['number']; + + if ( $this->id_base . '-' . $number == $del_id ) + unset($all_instances[$number]); + } + } else { + if ( isset($_POST['widget-' . $this->id_base]) && is_array($_POST['widget-' . $this->id_base]) ) { + $settings = $_POST['widget-' . $this->id_base]; + } elseif ( isset($_POST['id_base']) && $_POST['id_base'] == $this->id_base ) { + $num = $_POST['multi_number'] ? (int) $_POST['multi_number'] : (int) $_POST['widget_number']; + $settings = array( $num => array() ); + } else { + return; + } + + foreach ( $settings as $number => $new_instance ) { + $new_instance = stripslashes_deep($new_instance); + $this->_set($number); + + $old_instance = isset($all_instances[$number]) ? $all_instances[$number] : array(); + + $instance = $this->update($new_instance, $old_instance); + + // filters the widget's settings before saving, return false to cancel saving (keep the old settings if updating) + $instance = apply_filters('widget_update_callback', $instance, $new_instance, $old_instance, $this); + if ( false !== $instance ) + $all_instances[$number] = $instance; + + break; // run only once + } + } + + $this->save_settings($all_instances); + $this->updated = true; + } + + /** Generate the control form. + * Do NOT over-ride this function. */ + function form_callback( $widget_args = 1 ) { + if ( is_numeric($widget_args) ) + $widget_args = array( 'number' => $widget_args ); + + $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); + $all_instances = $this->get_settings(); + + if ( -1 == $widget_args['number'] ) { + // We echo out a form where 'number' can be set later + $this->_set('__i__'); + $instance = array(); + } else { + $this->_set($widget_args['number']); + $instance = $all_instances[ $widget_args['number'] ]; + } + + // filters the widget admin form before displaying, return false to stop displaying it + $instance = apply_filters('widget_form_callback', $instance, $this); + + $return = null; + if ( false !== $instance ) { + $return = $this->form($instance); + // add extra fields in the widget form - be sure to set $return to null if you add any + // if the widget has no form the text echoed from the default form method can be hidden using css + do_action_ref_array( 'in_widget_form', array(&$this, &$return, $instance) ); + } + return $return; + } + + /** Helper function: Registers a single instance. */ + function _register_one($number = -1) { + wp_register_sidebar_widget( $this->id, $this->name, $this->_get_display_callback(), $this->widget_options, array( 'number' => $number ) ); + _register_widget_update_callback( $this->id_base, $this->_get_update_callback(), $this->control_options, array( 'number' => -1 ) ); + _register_widget_form_callback( $this->id, $this->name, $this->_get_form_callback(), $this->control_options, array( 'number' => $number ) ); + } + + function save_settings($settings) { + $settings['_multiwidget'] = 1; + update_option( $this->option_name, $settings ); + } + + function get_settings() { + $settings = get_option($this->option_name); + + if ( false === $settings && isset($this->alt_option_name) ) + $settings = get_option($this->alt_option_name); + + if ( !is_array($settings) ) + $settings = array(); + + if ( !empty($settings) && !array_key_exists('_multiwidget', $settings) ) { + // old format, convert if single widget + $settings = wp_convert_widget_settings($this->id_base, $this->option_name, $settings); + } + + unset($settings['_multiwidget'], $settings['__i__']); + return $settings; + } +} + +/** + * Singleton that registers and instantiates WP_Widget classes. + * + * @package WordPress + * @subpackage Widgets + * @since 2.8 + */ +class WP_Widget_Factory { + var $widgets = array(); + + function WP_Widget_Factory() { + add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 ); + } + + function register($widget_class) { + $this->widgets[$widget_class] = new $widget_class(); + } + + function unregister($widget_class) { + if ( isset($this->widgets[$widget_class]) ) + unset($this->widgets[$widget_class]); + } + + function _register_widgets() { + global $wp_registered_widgets; + $keys = array_keys($this->widgets); + $registered = array_keys($wp_registered_widgets); + $registered = array_map('_get_widget_id_base', $registered); + + foreach ( $keys as $key ) { + // don't register new widget if old widget with the same id is already registered + if ( in_array($this->widgets[$key]->id_base, $registered, true) ) { + unset($this->widgets[$key]); + continue; + } + + $this->widgets[$key]->_register(); + } + } +} + /* Global Variables */ /** @ignore */ -global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls; +global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates; /** * Stores the sidebars, since many themes can have more than one. @@ -41,9 +375,82 @@ $wp_registered_widgets = array(); * @since 2.2.0 */ $wp_registered_widget_controls = array(); +$wp_registered_widget_updates = array(); + +/** + * Private + */ +$_wp_sidebars_widgets = array(); + +/** + * Private + */ + $GLOBALS['_wp_deprecated_widgets_callbacks'] = array( + 'wp_widget_pages', + 'wp_widget_pages_control', + 'wp_widget_calendar', + 'wp_widget_calendar_control', + 'wp_widget_archives', + 'wp_widget_archives_control', + 'wp_widget_links', + 'wp_widget_meta', + 'wp_widget_meta_control', + 'wp_widget_search', + 'wp_widget_recent_entries', + 'wp_widget_recent_entries_control', + 'wp_widget_tag_cloud', + 'wp_widget_tag_cloud_control', + 'wp_widget_categories', + 'wp_widget_categories_control', + 'wp_widget_text', + 'wp_widget_text_control', + 'wp_widget_rss', + 'wp_widget_rss_control', + 'wp_widget_recent_comments', + 'wp_widget_recent_comments_control' + ); /* Template tags & API functions */ +/** + * Register a widget + * + * Registers a WP_Widget widget + * + * @since 2.8.0 + * + * @see WP_Widget + * @see WP_Widget_Factory + * @uses WP_Widget_Factory + * + * @param string $widget_class The name of a class that extends WP_Widget + */ +function register_widget($widget_class) { + global $wp_widget_factory; + + $wp_widget_factory->register($widget_class); +} + +/** + * Unregister a widget + * + * Unregisters a WP_Widget widget. Useful for unregistering default widgets. + * Run within a function hooked to the widgets_init action. + * + * @since 2.8.0 + * + * @see WP_Widget + * @see WP_Widget_Factory + * @uses 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. * @@ -54,7 +461,8 @@ $wp_registered_widget_controls = array(); * The default for the name is "Sidebar #", with '#' being replaced with the * number the sidebar is currently when greater than one. If first sidebar, the * name will be just "Sidebar". The default for id is "sidebar-" followed by the - * number the sidebar creation is currently at. + * number the sidebar creation is currently at. If the id is provided, and multiple + * sidebars are being defined, the id will have "-2" appended, and so on. * * @since 2.2.0 * @@ -73,25 +481,27 @@ function register_sidebars($number = 1, $args = array()) { 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 ( isset($wp_registered_sidebars[$_args['id']]) ) + $_args['id'] = $args['id'] . '-' . $n++; } else { $n = count($wp_registered_sidebars); do { - $n++; - $_args['id'] = "sidebar-$n"; - } while (isset($wp_registered_sidebars[$_args['id']])); + $_args['id'] = 'sidebar-' . ++$n; + } while ( isset($wp_registered_sidebars[$_args['id']]) ); } - register_sidebar($_args); } } @@ -99,58 +509,70 @@ function register_sidebars($number = 1, $args = array()) { /** * Builds the definition for a single sidebar and returns the ID. * - * The $args parameter takes either a string or an array with 'name' and 'id' - * contained in either usage. It will be noted that the values will be applied - * to all sidebars, so if creating more than one, it will be advised to allow - * for WordPress to create the defaults for you. - * - * Example for string would be 'name=whatever;id=whatever1' and for - * the array it would be array( - * 'name' => 'whatever', - * 'id' => 'whatever1'). - * - * name - The name of the sidebar, which presumably the title which will be - * displayed. - * id - The unique identifier by which the sidebar will be called by. - * before_widget - The content that will prepended to the widgets when they are - * displayed. - * after_widget - The content that will be appended to the widgets when they are - * displayed. - * before_title - The content that will be prepended to the title when displayed. - * after_title - the content that will be appended to the title when displayed. - * - * Content is assumed to be HTML and should be formatted as such, but - * doesn't have to be. + * 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() + * + * Arguments passed as a string should be separated by '&': + * + * e.g. 'name=Sidebar&id=my_prefix_sidebar' + * + * The same arguments passed as an array: + * + * array( + * 'name' => 'Sidebar', + * 'id' => 'my_prefix_sidebar', + * ) + * + * Arguments: + * name - The name or title of the sidebar displayed in the admin dashboard. + * id - The unique identifier by which the sidebar will be called. + * before_widget - HTML content that will be prepended to each widget's HTML output + * when assigned to this sidebar. + * after_widget - HTML content that will be appended to each widget's HTML output + * when assigned to this sidebar. + * before_title - HTML content that will be prepended to the sidebar title when displayed. + * after_title - HTML content that will be appended to the sidebar title when displayed. * * @since 2.2.0 * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID. - * @uses parse_str() Converts a string to an array to be used in the rest of the function. - * @usedby register_sidebars() + * @uses add_theme_support() to ensure widget support has been added. * - * @param string|array $args Builds Sidebar based off of 'name' and 'id' values - * @return string The sidebar id that was added. + * @param string|array $args Arguments for the sidebar being registered. + * @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; $defaults = array( 'name' => sprintf(__('Sidebar %d'), $i ), 'id' => "sidebar-$i", + 'description' => '', + 'class' => '', 'before_widget' => '
  • ', 'after_widget' => "
    • \n", 'before_title' => '

    ', 'after_title' => "

    \n", ); - $sidebar = array_merge($defaults, (array) $args); + $sidebar = wp_parse_args( $args, $defaults ); $wp_registered_sidebars[$sidebar['id']] = $sidebar; + add_theme_support('widgets'); + + do_action( 'register_sidebar', $sidebar ); + return $sidebar['id']; } @@ -170,45 +592,6 @@ function unregister_sidebar( $name ) { unset( $wp_registered_sidebars[$name] ); } -/** - * Register widget for sidebar with backwards compatibility. - * - * Allows $name to be an array that accepts either three elements to grab the - * first element and the third for the name or just uses the first element of - * the array for the name. - * - * Passes to {@link wp_register_sidebar_widget()} after argument list and - * backwards compatibility is complete. - * - * @since 2.2.0 - * @uses wp_register_sidebar_widget() Passes the compiled arguments. - * - * @param string|int $name Widget ID. - * @param callback $output_callback Run when widget is called. - * @param string $classname Classname widget option. - * @param mixed $params,... Widget parameters. - */ -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); - - call_user_func_array('wp_register_sidebar_widget', $args); -} - /** * Register widget for use in sidebars. * @@ -225,12 +608,12 @@ function register_sidebar_widget($name, $output_callback, $classname = '') { * @param int|string $id Widget ID. * @param string $name Widget display title. * @param callback $output_callback Run when widget is called. - * @param array|string Optional. $options Widget Options. + * @param array|string $options Optional. Widget Options. * @param mixed $params,... Widget parameters to add to widget. * @return null Will return if $output_callback is empty after removing widget. */ function wp_register_sidebar_widget($id, $name, $output_callback, $options = array()) { - global $wp_registered_widgets; + global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks; $id = strtolower($id); @@ -239,6 +622,17 @@ function wp_register_sidebar_widget($id, $name, $output_callback, $options = arr return; } + $id_base = _get_widget_id_base($id); + if ( in_array($output_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($output_callback) ) { + if ( isset($wp_registered_widget_controls[$id]) ) + unset($wp_registered_widget_controls[$id]); + + if ( isset($wp_registered_widget_updates[$id_base]) ) + unset($wp_registered_widget_updates[$id_base]); + + return; + } + $defaults = array('classname' => $output_callback); $options = wp_parse_args($options, $defaults); $widget = array( @@ -249,8 +643,10 @@ 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' ) ) ) { + do_action( 'wp_register_sidebar_widget', $widget ); $wp_registered_widgets[$id] = $widget; + } } /** @@ -272,20 +668,28 @@ 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'] ); } /** - * Alias of {@link wp_unregister_sidebar_widget()}. + * Retrieve description for a sidebar. * - * @see wp_unregister_sidebar_widget() + * When registering sidebars a 'description' parameter can be included that + * describes the sidebar for display on the widget administration panel. * - * @since 2.2.0 + * @since 2.9.0 * - * @param int|string $id Widget ID. + * @param int|string $id sidebar ID. + * @return string Sidebar description, if available. Null on failure to retrieve description. */ -function unregister_sidebar_widget($id) { - return wp_unregister_sidebar_widget($id); +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'] ); } /** @@ -296,50 +700,12 @@ function unregister_sidebar_widget($id) { * @param int|string $id Widget ID. */ function wp_unregister_sidebar_widget($id) { + do_action( 'wp_unregister_sidebar_widget', $id ); + wp_register_sidebar_widget($id, '', ''); wp_unregister_widget_control($id); } -/** - * Registers widget control callback for customizing options. - * - * Allows $name to be an array that accepts either three elements to grab the - * first element and the third for the name or just uses the first element of - * the array for the name. - * - * Passes to {@link wp_register_widget_control()} after the argument list has - * been compiled. - * - * @since 2.2.0 - * - * @param int|string $name Sidebar ID. - * @param callback $control_callback Widget control callback to display and process form. - * @param int $width Widget width. - * @param int $height Widget height. - */ -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]; - } - - $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); -} - /** * Registers widget control callback for customizing options. * @@ -359,12 +725,21 @@ function register_widget_control($name, $control_callback, $width = '', $height * @param mixed $params,... Optional. Additional parameters to add to widget. */ function wp_register_widget_control($id, $name, $control_callback, $options = array()) { - global $wp_registered_widget_controls; + 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) ) { + if ( isset($wp_registered_widgets[$id]) ) + unset($wp_registered_widgets[$id]); + return; } @@ -385,18 +760,62 @@ 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; } -/** - * Alias of {@link wp_unregister_widget_control()}. - * - * @since 2.2.0 - * @see wp_unregister_widget_control() - * - * @param int|string $id Widget ID. - */ -function unregister_widget_control($id) { - return wp_unregister_widget_control($id); +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; +} + +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; } /** @@ -446,6 +865,8 @@ function dynamic_sidebar($index = 1) { } $sidebars_widgets = wp_get_sidebars_widgets(); + if ( empty( $sidebars_widgets ) ) + return false; if ( empty($wp_registered_sidebars[$index]) || !array_key_exists($index, $sidebars_widgets) || !is_array($sidebars_widgets[$index]) || empty($sidebars_widgets[$index]) ) return false; @@ -454,6 +875,9 @@ function dynamic_sidebar($index = 1) { $did_one = false; 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'] @@ -474,6 +898,8 @@ function dynamic_sidebar($index = 1) { $callback = $wp_registered_widgets[$id]['callback']; + do_action( 'dynamic_sidebar', $wp_registered_widgets[$id] ); + if ( is_callable($callback) ) { call_user_func_array($callback, $params); $did_one = true; @@ -484,30 +910,46 @@ function dynamic_sidebar($index = 1) { } /** - * Whether widget is registered using callback with widget ID. + * 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. * - * Will only check if both parameters are used. Used to find which sidebar the - * widget is located in, but requires that both the callback and the widget ID - * be known. + * 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. * * @since 2.2.0 * - * @param callback $callback Widget callback to check. + * @param string $callback Optional, Widget callback to check. * @param int $widget_id Optional, but needed for checking. Widget ID. -/* @return mixed false if widget is not active or id of sidebar in which the widget is active. + * @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'. + * @return mixed 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 ) + 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; } @@ -531,94 +973,55 @@ function is_dynamic_sidebar() { return false; } -/* Internal Functions */ - /** - * Retrieve full list of sidebars and their widgets. + * Whether a sidebar is in use. * - * Will upgrade sidebar widget list, if needed. Will also save updated list, if - * needed. + * @since 2.8 * - * @since 2.2.0 - * @access private - * - * @param bool $update Optional, default is true. Whether to save upgrade of widget array list. - * @return array Upgraded list of widgets to version 2 array format. + * @param mixed $index Sidebar name, id or number to check. + * @return bool true if the sidebar is in use, false otherwise. */ -function wp_get_sidebars_widgets($update = true) { - global $wp_registered_widgets, $wp_registered_sidebars; - - $sidebars_widgets = get_option('sidebars_widgets', array()); - $_sidebars_widgets = array(); - - if ( !isset($sidebars_widgets['array_version']) ) - $sidebars_widgets['array_version'] = 1; - - switch ( $sidebars_widgets['array_version'] ) { - case 1 : - foreach ( (array) $sidebars_widgets as $index => $sidebar ) - if ( is_array($sidebar) ) - foreach ( (array) $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; - } +function is_active_sidebar( $index ) { + $index = ( is_int($index) ) ? "sidebar-$index" : sanitize_title($index); + $sidebars_widgets = wp_get_sidebars_widgets(); + if ( !empty($sidebars_widgets[$index]) ) + return true; - $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; - } - } + return false; +} - if ( $found ) - continue; +/* Internal Functions */ - 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 ( (array) $sidebars as $id ) { - if ( array_key_exists( $id, $sidebars_widgets ) ) { - $_sidebars_widgets[$id] = $sidebars_widgets[$id]; - unset($sidebars_widgets[$id], $sidebars[$id]); - } - } +/** + * Retrieve full list of sidebars and their widgets. + * + * Will upgrade sidebar widget list, if needed. Will also save updated list, if + * needed. + * + * @since 2.2.0 + * @access private + * + * @param bool $deprecated Not used (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_registered_widgets, $_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()); } - if ( isset($sidebars_widgets['array_version']) ) + if ( is_array( $sidebars_widgets ) && isset($sidebars_widgets['array_version']) ) unset($sidebars_widgets['array_version']); $sidebars_widgets = apply_filters('sidebars_widgets', $sidebars_widgets); @@ -658,1443 +1061,210 @@ function wp_get_widget_defaults() { return $defaults; } -/* Default Widgets */ - -/** - * Display pages widget. - * - * @since 2.2.0 - * - * @param array $args Widget arguments. - */ -function wp_widget_pages( $args ) { - extract( $args ); - $options = get_option( 'widget_pages' ); - - $title = empty( $options['title'] ) ? __( 'Pages' ) : apply_filters('widget_title', $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 ) ) { -?> - - - - - -

    -

    - -

    -

    - -
    - -

    - - $before_title, 'title_after' => $after_title, - 'category_before' => $before_widget, 'category_after' => $after_widget, - 'show_images' => true, 'class' => 'linkcat widget' - ))); -} - -/** - * Display search widget. - * - * @since 2.2.0 - * - * @param array $args Widget arguments. - */ -function wp_widget_search($args) { - extract($args); - echo $before_widget; - - // Use current theme search form if it exists - get_search_form(); - - echo $after_widget; -} - /** - * Display archives widget. + * Convert the widget settings from single to multi-widget format. * - * @since 2.2.0 + * @since 2.8.0 * - * @param array $args Widget arguments. + * @return array */ -function wp_widget_archives($args) { - extract($args); - $options = get_option('widget_archives'); - $c = $options['count'] ? '1' : '0'; - $d = $options['dropdown'] ? '1' : '0'; - $title = empty($options['title']) ? __('Archives') : apply_filters('widget_title', $options['title']); - - echo $before_widget; - echo $before_title . $title . $after_title; - - if($d) { -?> - - - - -

    -

    - -
    - -

    - - - - - - - -

    - -'; - get_calendar(); - echo ''; - echo $after_widget; -} - -/** - * Display and process calendar widget options form. - * - * @since 2.2.0 - */ -function wp_widget_calendar_control() { - $options = $newoptions = get_option('widget_calendar'); - if ( isset($_POST["calendar-submit"]) ) { - $newoptions['title'] = strip_tags(stripslashes($_POST["calendar-title"])); - } - if ( $options != $newoptions ) { - $options = $newoptions; - update_option('widget_calendar', $options); - } - $title = attribute_escape($options['title']); -?> -

    - - $widget_args ); - $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); - extract( $widget_args, EXTR_SKIP ); - - $options = get_option('widget_text'); - if ( !isset($options[$number]) ) - return; - - $title = apply_filters('widget_title', $options[$number]['title']); - $text = apply_filters( 'widget_text', $options[$number]['text'] ); -?> - - -
    - - $widget_args ); - $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); - extract( $widget_args, EXTR_SKIP ); - - $options = get_option('widget_text'); - if ( !is_array($options) ) - $options = array(); - - if ( !$updated && !empty($_POST['sidebar']) ) { - $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 ( (array) $this_sidebar as $_widget_id ) { - if ( 'wp_widget_text' == $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( "text-$widget_number", $_POST['widget-id'] ) ) // the widget has been removed. - unset($options[$widget_number]); - } - } - - foreach ( (array) $_POST['widget-text'] as $widget_number => $widget_text ) { - if ( !isset($widget_text['text']) && isset($options[$widget_number]) ) // user clicked cancel + foreach ( array_keys($settings) as $number ) { + if ( 'number' == $number ) continue; - $title = strip_tags(stripslashes($widget_text['title'])); - if ( current_user_can('unfiltered_html') ) - $text = stripslashes( $widget_text['text'] ); - else - $text = stripslashes(wp_filter_post_kses( $widget_text['text'] )); - $options[$widget_number] = compact( 'title', 'text' ); + if ( !is_numeric($number) ) { + $single = true; + break; + } } - - update_option('widget_text', $options); - $updated = true; - } - - if ( -1 == $number ) { - $title = ''; - $text = ''; - $number = '%i%'; - } else { - $title = attribute_escape($options[$number]['title']); - $text = format_to_edit($options[$number]['text']); - } -?> -

    - - - -

    - 'widget_text', 'description' => __('Arbitrary text or HTML')); - $control_ops = array('width' => 400, 'height' => 350, 'id_base' => 'text'); - $name = __('Text'); - - $id = false; - foreach ( (array) 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 ) ); - } -} - -/** - * Display categories widget. - * - * Allows multiple category widgets. - * - * @since 2.2.0 - * - * @param array $args Widget arguments. - * @param int $number Widget number. - */ -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; + if ( $single ) { + $settings = array( 2 => $settings ); - $c = $options[$number]['count'] ? '1' : '0'; - $h = $options[$number]['hierarchical'] ? '1' : '0'; - $d = $options[$number]['dropdown'] ? '1' : '0'; - - $title = empty($options[$number]['title']) ? __('Categories') : apply_filters('widget_title', $options[$number]['title']); - - echo $before_widget; - echo $before_title . $title . $after_title; - - $cat_args = array('orderby' => 'name', 'show_count' => $c, 'hierarchical' => $h); - - if ( $d ) { - $cat_args['show_option_none'] = __('Select Category'); - wp_dropdown_categories($cat_args); -?> - - - - - - $widget_args ); - $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); - extract($widget_args, EXTR_SKIP); - - $options = get_option('widget_categories'); - - if ( !is_array( $options ) ) - $options = array(); - - if ( !$updated && !empty($_POST['sidebar']) ) { - $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 ( (array) $this_sidebar as $_widget_id ) { - if ( 'wp_widget_categories' == $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( "categories-$widget_number", $_POST['widget-id'] ) ) // the widget has been removed. - unset($options[$widget_number]); + foreach ( (array) $sidebars_widgets as $index => $sidebar ) { + if ( is_array($sidebar) ) { + foreach ( $sidebar as $i => $name ) { + if ( $base_name == $name ) { + $sidebars_widgets[$index][$i] = "$name-2"; + $changed = true; + break 2; + } + } } } - foreach ( (array) $_POST['widget-categories'] as $widget_number => $widget_cat ) { - if ( !isset($widget_cat['title']) && isset($options[$widget_number]) ) // user clicked cancel - continue; - $title = trim(strip_tags(stripslashes($widget_cat['title']))); - $count = isset($widget_cat['count']); - $hierarchical = isset($widget_cat['hierarchical']); - $dropdown = isset($widget_cat['dropdown']); - $options[$widget_number] = compact( 'title', 'count', 'hierarchical', 'dropdown' ); - } - - update_option('widget_categories', $options); - $updated = true; - } - - if ( -1 == $number ) { - $title = ''; - $count = false; - $hierarchical = false; - $dropdown = false; - $number = '%i%'; - } else { - $title = attribute_escape( $options[$number]['title'] ); - $count = (bool) $options[$number]['count']; - $hierarchical = (bool) $options[$number]['hierarchical']; - $dropdown = (bool) $options[$number]['dropdown']; - } -?> -

    - -

    - -

    - -
    - -
    - -

    - - - 'widget_categories', 'description' => __( "A list or dropdown of categories" ) ); - - $name = __( 'Categories' ); - - $id = false; - foreach ( (array) array_keys($options) as $o ) { - // Old widgets can have null values for some reason - if ( !isset($options[$o]['title']) ) - continue; - $id = "categories-$o"; - wp_register_sidebar_widget( $id, $name, 'wp_widget_categories', $widget_ops, array( 'number' => $o ) ); - wp_register_widget_control( $id, $name, 'wp_widget_categories_control', array( 'id_base' => 'categories' ), array( 'number' => $o ) ); - } - - // If there are none, we register the widget's existance with a generic template - if ( !$id ) { - wp_register_sidebar_widget( 'categories-1', $name, 'wp_widget_categories', $widget_ops, array( 'number' => -1 ) ); - wp_register_widget_control( 'categories-1', $name, 'wp_widget_categories_control', array( 'id_base' => 'categories' ), array( 'number' => -1 ) ); + if ( is_admin() && $changed ) + update_option('sidebars_widgets', $sidebars_widgets); } -} - -/** - * Upgrade previous category widget to current version. - * - * @since 2.3.0 - * - * @return array - */ -function wp_widget_categories_upgrade() { - $options = get_option( 'widget_categories' ); - - if ( !isset( $options['title'] ) ) - return $options; - - $newoptions = array( 1 => $options ); - - update_option( 'widget_categories', $newoptions ); - $sidebars_widgets = get_option( 'sidebars_widgets' ); - if ( is_array( $sidebars_widgets ) ) { - foreach ( $sidebars_widgets as $sidebar => $widgets ) { - if ( is_array( $widgets ) ) { - foreach ( $widgets as $widget ) - $new_widgets[$sidebar][] = ( $widget == 'categories' ) ? 'categories-1' : $widget; - } else { - $new_widgets[$sidebar] = $widgets; - } - } - if ( $new_widgets != $sidebars_widgets ) - update_option( 'sidebars_widgets', $new_widgets ); - } + $settings['_multiwidget'] = 1; + if ( is_admin() ) + update_option( $option_name, $settings ); - return $newoptions; + return $settings; } /** - * Display recent entries widget. - * - * @since 2.2.0 + * Output an arbitrary widget as a template tag * - * @param array $args Widget arguments. - * @return int Displayed cache. - */ -function wp_widget_recent_entries($args) { - if ( '%BEG_OF_TITLE%' != $args['before_title'] ) { - if ( $output = wp_cache_get('widget_recent_entries', 'widget') ) - return print($output); - ob_start(); - } - - extract($args); - $options = get_option('widget_recent_entries'); - $title = empty($options['title']) ? __('Recent Posts') : apply_filters('widget_title', $options['title']); - if ( !$number = (int) $options['number'] ) - $number = 10; - else if ( $number < 1 ) - $number = 1; - else if ( $number > 15 ) - $number = 15; - - $r = new WP_Query(array('showposts' => $number, 'what_to_show' => 'posts', 'nopaging' => 0, 'post_status' => 'publish', 'caller_get_posts' => 1)); - if ($r->have_posts()) : -?> - - - - - - -

    -

    - -
    - -

    - -widgets[$widget]; + if ( !is_a($widget_obj, 'WP_Widget') ) + return; -/** - * Display recent comments widget. - * - * @since 2.2.0 - * - * @param array $args Widget arguments. - */ -function wp_widget_recent_comments($args) { - global $wpdb, $comments, $comment; - extract($args, EXTR_SKIP); - $options = get_option('widget_recent_comments'); - $title = empty($options['title']) ? __('Recent Comments') : apply_filters('widget_title', $options['title']); - if ( !$number = (int) $options['number'] ) - $number = 5; - else if ( $number < 1 ) - $number = 1; - else if ( $number > 15 ) - $number = 15; - - if ( !$comments = wp_cache_get( 'recent_comments', 'widget' ) ) { - $comments = $wpdb->get_results("SELECT * FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT $number"); - wp_cache_add( 'recent_comments', $comments, 'widget' ); - } -?> - - - - - -', $widget_obj->widget_options['classname'] ); + $default_args = array( 'before_widget' => $before_widget, 'after_widget' => "", 'before_title' => '

    ', 'after_title' => '

    ' ); -/** - * Remove the cache for recent comments widget. - * - * @since 2.2.0 - */ -function wp_delete_recent_comments_cache() { - wp_cache_delete( 'recent_comments', 'widget' ); -} -add_action( 'comment_post', 'wp_delete_recent_comments_cache' ); -add_action( 'wp_set_comment_status', 'wp_delete_recent_comments_cache' ); + $args = wp_parse_args($args, $default_args); + $instance = wp_parse_args($instance); -/** - * Display and process recent comments widget options form. - * - * @since 2.2.0 - */ -function wp_widget_recent_comments_control() { - $options = $newoptions = get_option('widget_recent_comments'); - if ( isset($_POST["recent-comments-submit"]) ) { - $newoptions['title'] = strip_tags(stripslashes($_POST["recent-comments-title"])); - $newoptions['number'] = (int) $_POST["recent-comments-number"]; - } - if ( $options != $newoptions ) { - $options = $newoptions; - update_option('widget_recent_comments', $options); - wp_delete_recent_comments_cache(); - } - $title = attribute_escape($options['title']); - if ( !$number = (int) $options['number'] ) - $number = 5; -?> -

    -

    - -
    - -

    - - - -_set(-1); + $widget_obj->widget($args, $instance); } /** - * Register recent comments with control and hook for 'wp_head' action. - * - * @since 2.2.0 + * Private */ -function wp_widget_recent_comments_register() { - $widget_ops = array('classname' => 'widget_recent_comments', 'description' => __( 'The most recent comments' ) ); - wp_register_sidebar_widget('recent-comments', __('Recent Comments'), 'wp_widget_recent_comments', $widget_ops); - wp_register_widget_control('recent-comments', __('Recent Comments'), 'wp_widget_recent_comments_control'); - - if ( is_active_widget('wp_widget_recent_comments') ) - add_action('wp_head', 'wp_widget_recent_comments_style'); +function _get_widget_id_base($id) { + return preg_replace( '/-[0-9]+$/', '', $id ); } /** - * Display RSS widget. - * - * Allows for multiple widgets to be displayed. - * - * @since 2.2.0 + * Handle sidebars config after theme change * - * @param array $args Widget arguments. - * @param int $number Widget number. + * @access private + * @since 3.3.0 */ -function wp_widget_rss($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_rss'); - - if ( !isset($options[$number]) ) - return; - - if ( isset($options[$number]['error']) && $options[$number]['error'] ) - return; +function _wp_sidebars_changed() { + global $sidebars_widgets; - $url = $options[$number]['url']; - while ( strstr($url, 'http') != $url ) - $url = substr($url, 1); - if ( empty($url) ) - return; + if ( ! is_array( $sidebars_widgets ) ) + $sidebars_widgets = wp_get_sidebars_widgets(); - require_once(ABSPATH . WPINC . '/rss.php'); - - $rss = fetch_rss($url); - $link = clean_url(strip_tags($rss->channel['link'])); - while ( strstr($link, 'http') != $link ) - $link = substr($link, 1); - $desc = attribute_escape(strip_tags(html_entity_decode($rss->channel['description'], ENT_QUOTES))); - $title = $options[$number]['title']; - if ( empty($title) ) - $title = htmlentities(strip_tags($rss->channel['title'])); - if ( empty($title) ) - $title = $desc; - if ( empty($title) ) - $title = __('Unknown Feed'); - $title = apply_filters('widget_title', $title ); - $url = clean_url(strip_tags($url)); - if ( file_exists(dirname(__FILE__) . '/rss.png') ) - $icon = str_replace(ABSPATH, site_url() . '/', dirname(__FILE__)) . '/rss.png'; - else - $icon = includes_url('images/rss.png'); - $title = "RSS $title"; - - echo $before_widget; - echo $before_title . $title . $after_title; - - wp_widget_rss_output( $rss, $options[$number] ); - - echo $after_widget; + retrieve_widgets(true); } -/** - * Display the RSS entries in a list. - * - * @since 2.5.0 - * - * @param string|array|object $rss RSS url. - * @param array $args Widget arguments. - */ -function wp_widget_rss_output( $rss, $args = array() ) { - if ( is_string( $rss ) ) { - require_once(ABSPATH . WPINC . '/rss.php'); - if ( !$rss = fetch_rss($rss) ) - return; - } elseif ( is_array($rss) && isset($rss['url']) ) { - require_once(ABSPATH . WPINC . '/rss.php'); - $args = $rss; - if ( !$rss = fetch_rss($rss['url']) ) - return; - } elseif ( !is_object($rss) ) { - return; - } +// look for "lost" widgets, this has to run at least on each theme change +function retrieve_widgets($theme_changed = false) { + global $wp_registered_widget_updates, $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets; - $default_args = array( 'show_author' => 0, 'show_date' => 0, 'show_summary' => 0 ); - $args = wp_parse_args( $args, $default_args ); - extract( $args, EXTR_SKIP ); - - $items = (int) $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 ''; + } } else { - echo ''; - } -} - -/** - * Display and process RSS widget control form. - * - * @since 2.2.0 - * - * @param int $widget_args Widget number. - */ -function wp_widget_rss_control($widget_args) { - global $wp_registered_widgets; - static $updated = false; + if ( empty( $sidebars_widgets ) ) + return; - 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); + unset( $sidebars_widgets['array_version'] ); - $options = get_option('widget_rss'); - if ( !is_array($options) ) - $options = array(); + $old = array_keys($sidebars_widgets); + sort($old); + sort($registered_sidebar_keys); - $urls = array(); - foreach ( (array) $options as $option ) - if ( isset($option['url']) ) - $urls[$option['url']] = true; + if ( $old == $registered_sidebar_keys ) + return; - if ( !$updated && 'POST' == $_SERVER['REQUEST_METHOD'] && !empty($_POST['sidebar']) ) { - $sidebar = (string) $_POST['sidebar']; + $_sidebars_widgets = array( + 'wp_inactive_widgets' => !empty( $sidebars_widgets['wp_inactive_widgets'] ) ? $sidebars_widgets['wp_inactive_widgets'] : array() + ); - $sidebars_widgets = wp_get_sidebars_widgets(); - if ( isset($sidebars_widgets[$sidebar]) ) - $this_sidebar =& $sidebars_widgets[$sidebar]; - else - $this_sidebar = array(); + unset( $sidebars_widgets['wp_inactive_widgets'] ); - foreach ( (array) $this_sidebar as $_widget_id ) { - if ( 'wp_widget_rss' == $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( "rss-$widget_number", $_POST['widget-id'] ) ) // the widget has been removed. - unset($options[$widget_number]); + foreach ( $wp_registered_sidebars as $id => $settings ) { + if ( $theme_changed ) { + $_sidebars_widgets[$id] = array_shift( $sidebars_widgets ); + } else { + // no theme change, grab only sidebars that are currently registered + if ( isset( $sidebars_widgets[$id] ) ) { + $_sidebars_widgets[$id] = $sidebars_widgets[$id]; + unset( $sidebars_widgets[$id] ); + } } } - foreach( (array) $_POST['widget-rss'] as $widget_number => $widget_rss ) { - if ( !isset($widget_rss['url']) && isset($options[$widget_number]) ) // user clicked cancel - continue; - $widget_rss = stripslashes_deep( $widget_rss ); - $url = sanitize_url(strip_tags($widget_rss['url'])); - $options[$widget_number] = wp_widget_rss_process( $widget_rss, !isset($urls[$url]) ); - } - - update_option('widget_rss', $options); - $updated = true; - } - - if ( -1 == $number ) { - $title = ''; - $url = ''; - $items = 10; - $error = false; - $number = '%i%'; - $show_summary = 0; - $show_author = 0; - $show_date = 0; - } else { - extract( (array) $options[$number] ); - } - - wp_widget_rss_form( compact( 'number', 'title', 'url', 'items', 'error', 'show_summary', 'show_author', 'show_date' ) ); -} - -/** - * Display RSS widget options form. - * - * The options for what fields are displayed for the RSS form are all booleans - * and are as follows: 'url', 'title', 'items', 'show_summary', 'show_author', - * 'show_date'. - * - * @since 2.5.0 - * - * @param array|string $args Values for input fields. - * @param array $inputs Override default display options. - */ -function wp_widget_rss_form( $args, $inputs = null ) { - - $default_inputs = array( 'url' => true, 'title' => true, 'items' => true, 'show_summary' => true, 'show_author' => true, 'show_date' => true ); - $inputs = wp_parse_args( $inputs, $default_inputs ); - extract( $args ); - extract( $inputs, EXTR_SKIP); - - $number = attribute_escape( $number ); - $title = attribute_escape( $title ); - $url = attribute_escape( $url ); - $items = (int) $items; - if ( $items < 1 || 20 < $items ) - $items = 10; - $show_summary = (int) $show_summary; - $show_author = (int) $show_author; - $show_date = (int) $show_date; - - if ( $inputs['url'] ) : -?> -

    - -

    - -

    - -

    - -

    - -

    - -

    - -

    - -

    - -

    - -

    - -

    - - - -channel['link'])); - while ( strstr($link, 'http') != $link ) - $link = substr($link, 1); + foreach ( $sidebars_widgets as $val ) { + if ( is_array($val) && ! empty( $val ) ) + $_sidebars_widgets['orphaned_widgets_' . ++$orphaned] = $val; } } - return compact( 'title', 'url', 'link', 'items', 'error', 'show_summary', 'show_author', 'show_date' ); -} + // discard invalid, theme-specific widgets from sidebars + $shown_widgets = array(); -/** - * Register RSS widget to allow multiple RSS widgets on startup. - * - * @since 2.2.0 - */ -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) 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']) ) + foreach ( $_sidebars_widgets as $sidebar => $widgets ) { + if ( !is_array($widgets) ) 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 ) ); - } -} - -/** - * Display tag cloud widget. - * - * @since 2.3.0 - * - * @param array $args Widget arguments. - */ -function wp_widget_tag_cloud($args) { - extract($args); - $options = get_option('widget_tag_cloud'); - $title = empty($options['title']) ? __('Tags') : apply_filters('widget_title', $options['title']); - - echo $before_widget; - echo $before_title . $title . $after_title; - wp_tag_cloud(); - echo $after_widget; -} - -/** - * Manage WordPress Tag Cloud widget options. - * - * Displays management form for changing the tag cloud widget title. - * - * @since 2.3.0 - */ -function wp_widget_tag_cloud_control() { - $options = $newoptions = get_option('widget_tag_cloud'); - - if ( isset($_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' ); - - $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' ); - - $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' ); - - $widget_ops = array('classname' => 'widget_links', 'description' => __( "Your blogroll") ); - wp_register_sidebar_widget('links', __('Links'), 'wp_widget_links', $widget_ops); - - $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' ); - - $widget_ops = array('classname' => 'widget_search', 'description' => __( "A search form for your blog") ); - wp_register_sidebar_widget('search', __('Search'), 'wp_widget_search', $widget_ops); - - $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' ); - - $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' ); - - wp_widget_categories_register(); - wp_widget_text_register(); - wp_widget_rss_register(); - wp_widget_recent_comments_register(); - - do_action('widgets_init'); -} - -add_action('init', 'wp_widgets_init', 1); - -/* - * Pattern for multi-widget (allows multiple instances such as the text widget). - * - * Make sure to close the comments after copying. - -/** - * Displays widget. - * - * Supports multiple widgets. - * - * @param array $args Widget arguments. - * @param array|int $widget_args Widget 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 ); - - // 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; - - echo $before_widget; - - // Do stuff for this widget, drawing data from $options[$number] - - echo $after_widget; -} - -/** - * Displays form for a particular instance of the widget. - * - * Also updates the data after a POST submit. - * - * @param array|int $widget_args Widget 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 + $_widgets = array(); + foreach ( $widgets as $widget ) { + if ( isset($wp_registered_widgets[$widget]) ) + $_widgets[] = $widget; } - update_option('widget_many', $options); - - $updated = true; // So that we don't go through this more than once + $_sidebars_widgets[$sidebar] = $_widgets; + $shown_widgets = array_merge($shown_widgets, $_widgets); } + $sidebars_widgets = $_sidebars_widgets; + unset($_sidebars_widgets, $_widgets); - // 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']); - } + // find hidden/lost multi-widget instances + $lost_widgets = array(); + foreach ( $wp_registered_widgets as $key => $val ) { + if ( in_array($key, $shown_widgets, true) ) + continue; - // 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. + if ( 2 > (int) $number ) 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, 'widget_many', $widget_ops, array( 'number' => $o ) ); - wp_register_widget_control( $id, $name, 'widget_many_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 ) ); + $lost_widgets[] = $key; } -} -// This is important -add_action( 'widgets_init', 'widget_many_register' ); + $sidebars_widgets['wp_inactive_widgets'] = array_merge($lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets']); + wp_set_sidebars_widgets($sidebars_widgets); -*/ - -?> + return $sidebars_widgets; +}