X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/11be8dc178e77d0b46189bbd8e33a216a9b90942..e0feb3b2e5b436a06bbb04fbc838d1cd6ec95399:/wp-includes/widgets.php diff --git a/wp-includes/widgets.php b/wp-includes/widgets.php index 2d654018..40de6c84 100644 --- a/wp-includes/widgets.php +++ b/wp-includes/widgets.php @@ -6,17 +6,633 @@ * This functionality was found in a plugin before WordPress 2.2 release which * included it in the core from that point on. * - * @link http://codex.wordpress.org/Plugins/WordPress_Widgets WordPress Widgets - * @link http://codex.wordpress.org/Plugins/WordPress_Widgets_Api Widgets API + * @link https://codex.wordpress.org/Plugins/WordPress_Widgets WordPress Widgets + * @link https://codex.wordpress.org/Plugins/WordPress_Widgets_Api Widgets API * * @package WordPress * @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.0 + */ +class WP_Widget { + + /** + * Root ID for all widgets of this type. + * + * @since 2.8.0 + * @access public + * @var mixed|string + */ + public $id_base; + + /** + * Name for this widget type. + * + * @since 2.8.0 + * @access public + * @var string + */ + public $name; + + /** + * Option array passed to {@see wp_register_sidebar_widget()}. + * + * @since 2.8.0 + * @access public + * @var array + */ + public $widget_options; + + /** + * Option array passed to {@see wp_register_widget_control()}. + * + * @since 2.8.0 + * @access public + * @var array + */ + public $control_options; + + /** + * Unique ID number of the current instance. + * + * @since 2.8.0 + * @access public + * @var bool|int + */ + public $number = false; + + /** + * Unique ID string of the current instance (id_base-number). + * + * @since 2.8.0 + * @access public + * @var bool|string + */ + public $id = false; + + /** + * Whether the widget data has been updated. + * + * Set to true when the data is updated after a POST submit - ensures it does + * not happen twice. + * + * @since 2.8.0 + * @access public + * @var bool + */ + public $updated = false; + + // Member functions that you must over-ride. + + /** + * Echo the widget content. + * + * Subclasses should over-ride this function to generate their widget code. + * + * @since 2.8.0 + * @access public + * + * @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. + */ + public 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. + * + * @since 2.8.0 + * @access public + * + * @param array $new_instance New settings for this instance as input by the user via + * {@see WP_Widget::form()}. + * @param array $old_instance Old settings for this instance. + * @return array Settings to save or bool false to cancel saving. + */ + public function update( $new_instance, $old_instance ) { + return $new_instance; + } + + /** + * Output the settings update form. + * + * @since 2.8.0 + * @access public + * + * @param array $instance Current settings. + * @return string Default return is 'noform'. + */ + public function form($instance) { + echo '
'; + return 'noform'; + } + + // Functions you'll need to call. + + /** + * PHP5 constructor. + * + * @since 2.8.0 + * @access public + * + * @param string $id_base Optional Base ID for the widget, lowercase and unique. 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. Widget options. See {@see wp_register_sidebar_widget()} for + * information on accepted arguments. Default empty array. + * @param array $control_options Optional. Widget control options. See {@see wp_register_widget_control()} + * for information on accepted arguments. Default empty array. + */ + public 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 + * + * @param string $id_base + * @param string $name + * @param array $widget_options + * @param array $control_options + */ + public function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) { + _deprecated_constructor( 'WP_Widget', '4.3.0' ); + 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 + */ + public function get_field_name($field_name) { + return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']'; + } + + /** + * Constructs id attributes for use in {@see WP_Widget::form()} fields. + * + * This function should be used in form() methods to create id attributes + * for fields to be saved by {@see WP_Widget::update()}. + * + * @since 2.8.0 + * @access public + * + * @param string $field_name Field name. + * @return string ID attribute for `$field_name`. + */ + public function get_field_id( $field_name ) { + return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name; + } + + /** + * Register all widget instances of this widget class. + * + * @since 2.8.0 + * @access private + */ + public function _register() { + $settings = $this->get_settings(); + $empty = true; + + // When $settings is an array-like object, get an intrinsic array for use with array_keys(). + if ( $settings instanceof ArrayObject || $settings instanceof ArrayIterator ) { + $settings = $settings->getArrayCopy(); + } + + 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(); + } + } + + /** + * Set the internal order number for the widget instance. + * + * @since 2.8.0 + * @access private + * + * @param int $number The unique order number of this widget instance compared to other + * instances of the same class. + */ + public function _set($number) { + $this->number = $number; + $this->id = $this->id_base . '-' . $number; + } + + /** + * @return callback + */ + public function _get_display_callback() { + return array($this, 'display_callback'); + } + /** + * @return callback + */ + public function _get_update_callback() { + return array($this, 'update_callback'); + } + /** + * @return callback + */ + public function _get_form_callback() { + return array($this, 'form_callback'); + } + + /** + * Determine whether the current request is inside the Customizer preview. + * + * If true -- the current request is inside the Customizer preview, then + * the object cache gets suspended and widgets should check this to decide + * whether they should store anything persistently to the object cache, + * to transients, or anywhere else. + * + * @since 3.9.0 + * @access public + * + * @global WP_Customize_Manager $wp_customize + * + * @return bool True if within the Customizer preview, false if not. + */ + public function is_preview() { + global $wp_customize; + return ( isset( $wp_customize ) && $wp_customize->is_preview() ) ; + } + + /** + * Generate the actual widget content (Do NOT override). + * + * Finds the instance and calls {@see WP_Widget::widget()}. + * + * @since 2.8.0 + * @access public + * + * @param array $args Display arguments. See {@see WP_Widget::widget()} for information + * on accepted arguments. + * @param int|array $widget_args { + * Optional. Internal order number of the widget instance, or array of multi-widget arguments. + * Default 1. + * + * @type int $number Number increment used for multiples of the same widget. + * } + */ + public 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'] ); + $instances = $this->get_settings(); + + if ( isset( $instances[ $this->number ] ) ) { + $instance = $instances[ $this->number ]; + + /** + * Filter the settings for a particular widget instance. + * + * Returning false will effectively short-circuit display of the widget. + * + * @since 2.8.0 + * + * @param array $instance The current widget instance's settings. + * @param WP_Widget $this The current widget instance. + * @param array $args An array of default widget arguments. + */ + $instance = apply_filters( 'widget_display_callback', $instance, $this, $args ); + + if ( false === $instance ) { + return; + } + + $was_cache_addition_suspended = wp_suspend_cache_addition(); + if ( $this->is_preview() && ! $was_cache_addition_suspended ) { + wp_suspend_cache_addition( true ); + } + + $this->widget( $args, $instance ); + + if ( $this->is_preview() ) { + wp_suspend_cache_addition( $was_cache_addition_suspended ); + } + } + } + + /** + * Deal with changed settings (Do NOT override). + * + * @since 2.8.0 + * @access public + * + * @global array $wp_registered_widgets + * + * @param int $deprecated Not used. + */ + public function update_callback( $deprecated = 1 ) { + global $wp_registered_widgets; + + $all_instances = $this->get_settings(); + + // We need to update the data + if ( $this->updated ) + return; + + 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(); + + $was_cache_addition_suspended = wp_suspend_cache_addition(); + if ( $this->is_preview() && ! $was_cache_addition_suspended ) { + wp_suspend_cache_addition( true ); + } + + $instance = $this->update( $new_instance, $old_instance ); + + if ( $this->is_preview() ) { + wp_suspend_cache_addition( $was_cache_addition_suspended ); + } + + /** + * Filter a widget's settings before saving. + * + * Returning false will effectively short-circuit the widget's ability + * to update settings. + * + * @since 2.8.0 + * + * @param array $instance The current widget instance's settings. + * @param array $new_instance Array of new widget settings. + * @param array $old_instance Array of old widget settings. + * @param WP_Widget $this The current widget instance. + */ + $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 widget control form (Do NOT override). + * + * @since 2.8.0 + * @access public + * + * @param int|array $widget_args Widget instance number or array of widget arguments. + * @return string|null + */ + public 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'] ]; + } + + /** + * Filter the widget instance's settings before displaying the control form. + * + * Returning false effectively short-circuits display of the control form. + * + * @since 2.8.0 + * + * @param array $instance The current widget instance's settings. + * @param WP_Widget $this The current widget instance. + */ + $instance = apply_filters( 'widget_form_callback', $instance, $this ); + + $return = null; + if ( false !== $instance ) { + $return = $this->form($instance); + + /** + * Fires at the end of the widget control form. + * + * Use this hook to add extra fields to the widget form. The hook + * is only fired if the value passed to the 'widget_form_callback' + * hook is not false. + * + * Note: If the widget has no form, the text echoed from the default + * form method can be hidden using CSS. + * + * @since 2.8.0 + * + * @param WP_Widget $this The widget instance, passed by reference. + * @param null $return Return null if new fields are added. + * @param array $instance An array of the widget's settings. + */ + do_action_ref_array( 'in_widget_form', array( &$this, &$return, $instance ) ); + } + return $return; + } + + /** + * Register an instance of the widget class. + * + * @since 2.8.0 + * @access private + * + * @param integer $number Optional. The unique order number of this widget instance + * compared to other instances of the same class. Default -1. + */ + public 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 ) ); + } + + /** + * Save the settings for all instances of the widget class. + * + * @since 2.8.0 + * @access public + * + * @param array $settings Multi-dimensional array of widget instance settings. + */ + public function save_settings( $settings ) { + $settings['_multiwidget'] = 1; + update_option( $this->option_name, $settings ); + } + + /** + * Get the settings for all instances of the widget class. + * + * @since 2.8.0 + * @access public + * + * @return array Multi-dimensional array of widget instance settings. + */ + public 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 instanceof ArrayObject || $settings instanceof ArrayIterator ) ) { + $settings = array(); + } + + if ( ! empty( $settings ) && ! isset( $settings['_multiwidget'] ) ) { + // 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.0 + */ +class WP_Widget_Factory { + public $widgets = array(); + + /** + * PHP5 constructor. + */ + public function __construct() { + add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 ); + } + + /** + * PHP4 constructor. + */ + public function WP_Widget_Factory() { + _deprecated_constructor( 'WP_Widget_Factory', '4.2.0' ); + self::__construct(); + } + + /** + * Register a widget subclass. + * + * @since 2.8.0 + * @access public + * + * @param string $widget_class The name of a {@see WP_Widget} subclass. + */ + public function register( $widget_class ) { + $this->widgets[$widget_class] = new $widget_class(); + } + + /** + * Un-register a widget subclass. + * + * @since 2.8.0 + * @access public + * + * @param string $widget_class The name of a {@see WP_Widget} subclass. + */ + public function unregister( $widget_class ) { + unset( $this->widgets[ $widget_class ] ); + } + + /** + * Utility method for adding widgets to the registered widgets global. + * + * @since 2.8.0 + * @access public + * + * @global array $wp_registered_widgets + */ + public 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,57 +657,143 @@ $wp_registered_widgets = array(); * @since 2.2.0 */ $wp_registered_widget_controls = array(); +/** + * @global array $wp_registered_widget_updates + */ +$wp_registered_widget_updates = array(); + +/** + * Private + * + * @global array $_wp_sidebars_widgets + */ +$_wp_sidebars_widgets = array(); + +/** + * Private + * + * @global array $_wp_deprecated_widgets_callbacks + */ +$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 + * + * @global WP_Widget_Factory $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 + * + * @global WP_Widget_Factory $wp_widget_factory + * + * @param string $widget_class The name of a class that extends WP_Widget + */ +function unregister_widget($widget_class) { + global $wp_widget_factory; + + $wp_widget_factory->unregister($widget_class); +} + /** * Creates multiple sidebars. * * If you wanted to quickly create multiple sidebars for a theme or internally. * This function will allow you to do so. If you don't pass the 'name' and/or - * 'id' in $args, then they will be built for you. - * - * 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. + * 'id' in `$args`, then they will be built for you. * * @since 2.2.0 * * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here. - * @uses parse_str() Converts a string to an array to be used in the rest of the function. - * @uses register_sidebar() Sends single sidebar information [name, id] to this - * function to handle building the sidebar. * - * @param int $number Number of sidebars to create. - * @param string|array $args Builds Sidebar based off of 'name' and 'id' values. + * @global array $wp_registered_sidebars + * + * @param int $number Optional. Number of sidebars to create. Default 1. + * @param array|string $args { + * Optional. Array or string of arguments for building a sidebar. + * + * @type string $id The base string of the unique identifier for each sidebar. If provided, and multiple + * sidebars are being defined, the id will have "-2" appended, and so on. + * Default 'sidebar-' followed by the number the sidebar creation is currently at. + * @type string $name The name or title for the sidebars displayed in the admin dashboard. If registering + * more than one sidebar, include '%d' in the string as a placeholder for the uniquely + * assigned number for each sidebar. + * Default 'Sidebar' for the first sidebar, otherwise 'Sidebar %d'. + * } */ -function register_sidebars($number = 1, $args = array()) { +function register_sidebars( $number = 1, $args = array() ) { global $wp_registered_sidebars; $number = (int) $number; if ( is_string($args) ) parse_str($args, $args); - for ( $i=1; $i <= $number; $i++ ) { + for ( $i = 1; $i <= $number; $i++ ) { $_args = $args; - if ( $number > 1 ) { + if ( $number > 1 ) $_args['name'] = isset($args['name']) ? sprintf($args['name'], $i) : sprintf(__('Sidebar %d'), $i); - } else { + else $_args['name'] = isset($args['name']) ? $args['name'] : __('Sidebar'); - } - if (isset($args['id'])) { + // Custom specified ID's are suffixed if they exist already. + // Automatically generated sidebar names need to be suffixed regardless starting at -0 + if ( isset($args['id']) ) { $_args['id'] = $args['id']; + $n = 2; // Start at -2 for conflicting custom ID's + while ( 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 +801,82 @@ 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()
*
* @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()
*
- * @param string|array $args Builds Sidebar based off of 'name' and 'id' values
- * @return string The sidebar id that was added.
+ * @global array $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
+ *
+ * @param array|string $args {
+ * Optional. Array or string of arguments for the sidebar being registered.
+ *
+ * @type string $name The name or title of the sidebar displayed in the Widgets
+ * interface. Default 'Sidebar $instance'.
+ * @type string $id The unique identifier by which the sidebar will be called.
+ * Default 'sidebar-$instance'.
+ * @type string $description Description of the sidebar, displayed in the Widgets interface.
+ * Default empty string.
+ * @type string $class Extra CSS class to assign to the sidebar in the Widgets interface.
+ * Default empty.
+ * @type string $before_widget HTML content to prepend to each widget's HTML output when
+ * assigned to this sidebar. Default is an opening list item element.
+ * @type string $after_widget HTML content to append to each widget's HTML output when
+ * assigned to this sidebar. Default is a closing list item element.
+ * @type string $before_title HTML content to prepend to the sidebar title when displayed.
+ * Default is an opening h2 element.
+ * @type string $after_title HTML content to append to the sidebar title when displayed.
+ * Default is a closing h2 element.
+ * }
+ * @return string Sidebar ID added to $wp_registered_sidebars global.
*/
function register_sidebar($args = array()) {
global $wp_registered_sidebars;
- if ( is_string($args) )
- parse_str($args, $args);
-
$i = count($wp_registered_sidebars) + 1;
+ $id_is_empty = empty( $args['id'] );
+
$defaults = array(
'name' => sprintf(__('Sidebar %d'), $i ),
'id' => "sidebar-$i",
+ 'description' => '',
+ 'class' => '',
'before_widget' => 'id
', $sidebar['name'], $sidebar['id'] ), '4.2.0' );
+ }
$wp_registered_sidebars[$sidebar['id']] = $sidebar;
+ add_theme_support('widgets');
+
+ /**
+ * Fires once a sidebar has been registered.
+ *
+ * @since 3.0.0
+ *
+ * @param array $sidebar Parsed arguments for the registered sidebar.
+ */
+ do_action( 'register_sidebar', $sidebar );
+
return $sidebar['id'];
}
@@ -159,78 +885,45 @@ function register_sidebar($args = array()) {
*
* @since 2.2.0
*
- * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
+ * @global array $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
*
* @param string $name The ID of the sidebar when it was added.
*/
function unregister_sidebar( $name ) {
global $wp_registered_sidebars;
- if ( isset( $wp_registered_sidebars[$name] ) )
- unset( $wp_registered_sidebars[$name] );
-}
-
-/**
- * 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);
+ unset( $wp_registered_sidebars[ $name ] );
}
/**
- * Register widget for use in sidebars.
+ * Register an instance of a widget.
*
- * The default widget option is 'classname' that can be override.
+ * The default widget option is 'classname' that can be overridden.
*
- * The function can also be used to unregister widgets when $output_callback
+ * The function can also be used to un-register widgets when `$output_callback`
* parameter is an empty string.
*
* @since 2.2.0
*
- * @uses $wp_registered_widgets Uses stored registered widgets.
- * @uses $wp_register_widget_defaults Retrieves widget defaults.
- *
- * @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 mixed $params,... Widget parameters to add to widget.
- * @return null Will return if $output_callback is empty after removing widget.
+ * @global array $wp_registered_widgets Uses stored registered widgets.
+ * @global array $wp_register_widget_defaults Retrieves widget defaults.
+ * @global array $wp_registered_widget_updates
+ * @global array $_wp_deprecated_widgets_callbacks
+ *
+ * @param int|string $id Widget ID.
+ * @param string $name Widget display title.
+ * @param callback $output_callback Run when widget is called.
+ * @param array $options {
+ * Optional. An array of supplementary widget options for the instance.
+ *
+ * @type string $classname Class name for the widget's HTML container. Default is a shortened
+ * version of the output callback name.
+ * @type string $description Widget description for display in the widget administration
+ * panel and/or theme.
+ * }
*/
-function wp_register_sidebar_widget($id, $name, $output_callback, $options = array()) {
- global $wp_registered_widgets;
+function wp_register_sidebar_widget( $id, $name, $output_callback, $options = array() ) {
+ global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks;
$id = strtolower($id);
@@ -239,6 +932,13 @@ 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) ) {
+ unset( $wp_registered_widget_controls[ $id ] );
+ unset( $wp_registered_widget_updates[ $id_base ] );
+ return;
+ }
+
$defaults = array('classname' => $output_callback);
$options = wp_parse_args($options, $defaults);
$widget = array(
@@ -249,8 +949,18 @@ function wp_register_sidebar_widget($id, $name, $output_callback, $options = arr
);
$widget = array_merge($widget, $options);
- if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) )
+ if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) ) {
+
+ /**
+ * Fires once for each registered widget.
+ *
+ * @since 3.0.0
+ *
+ * @param array $widget An array of default widget arguments.
+ */
+ do_action( 'wp_register_sidebar_widget', $widget );
$wp_registered_widgets[$id] = $widget;
+ }
}
/**
@@ -262,8 +972,10 @@ function wp_register_sidebar_widget($id, $name, $output_callback, $options = arr
*
* @since 2.5.0
*
+ * @global array $wp_registered_widgets
+ *
* @param int|string $id Widget ID.
- * @return string Widget description, if available. Null on failure to retrieve description.
+ * @return string|void Widget description, if available.
*/
function wp_widget_description( $id ) {
if ( !is_scalar($id) )
@@ -272,20 +984,30 @@ 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.
+ * @global array $wp_registered_sidebars
+ *
+ * @param string $id sidebar ID.
+ * @return string|void Sidebar description, if available.
*/
-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,48 +1018,18 @@ function unregister_sidebar_widget($id) {
* @param int|string $id Widget ID.
*/
function 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];
- }
+ /**
+ * Fires just before a widget is removed from a sidebar.
+ *
+ * @since 3.0.0
+ *
+ * @param int $id The widget ID.
+ */
+ do_action( 'wp_unregister_sidebar_widget', $id );
- $id = sanitize_title($name);
- $options = array();
- if ( !empty($width) )
- $options['width'] = $width;
- if ( !empty($height) )
- $options['height'] = $height;
- $params = array_slice(func_get_args(), 4);
- $args = array($id, $name, $control_callback, $options);
- if ( !empty($params) )
- $args = array_merge($args, $params);
-
- call_user_func_array('wp_register_widget_control', $args);
+ wp_register_sidebar_widget($id, '', '');
+ wp_unregister_widget_control($id);
}
/**
@@ -348,23 +1040,37 @@ function register_widget_control($name, $control_callback, $width = '', $height
* control form, but try hard to use the default width. The 'id_base' is for
* multi-widgets (widgets which allow multiple instances such as the text
* widget), an id_base must be provided. The widget id will end up looking like
- * {$id_base}-{$unique_number}.
+ * `{$id_base}-{$unique_number}`.
*
* @since 2.2.0
*
- * @param int|string $id Sidebar ID.
- * @param string $name Sidebar display name.
- * @param callback $control_callback Run when sidebar is displayed.
- * @param array|string $options Optional. Widget options. See above long description.
- * @param mixed $params,... Optional. Additional parameters to add to widget.
+ * @todo Document `$options` as a hash notation, re: WP_Widget::__construct() cross-reference.
+ * @todo `$params` parameter?
+ *
+ * @global array $wp_registered_widget_controls
+ * @global array $wp_registered_widget_updates
+ * @global array $wp_registered_widgets
+ * @global array $_wp_deprecated_widgets_callbacks
+ *
+ * @param int|string $id Sidebar ID.
+ * @param string $name Sidebar display name.
+ * @param callback $control_callback Run when sidebar is displayed.
+ * @param array|string $options Optional. Widget options. See description above. Default empty array.
*/
-function wp_register_widget_control($id, $name, $control_callback, $options = array()) {
- global $wp_registered_widget_controls;
+function wp_register_widget_control( $id, $name, $control_callback, $options = array() ) {
+ global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks;
$id = strtolower($id);
+ $id_base = _get_widget_id_base($id);
if ( empty($control_callback) ) {
unset($wp_registered_widget_controls[$id]);
+ unset($wp_registered_widget_updates[$id_base]);
+ return;
+ }
+
+ if ( in_array($control_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($control_callback) ) {
+ unset( $wp_registered_widgets[ $id ] );
return;
}
@@ -385,75 +1091,151 @@ function wp_register_widget_control($id, $name, $control_callback, $options = ar
$widget = array_merge($widget, $options);
$wp_registered_widget_controls[$id] = $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);
+ 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;
}
/**
- * Remove control callback for widget.
- *
- * @since 2.2.0
- * @uses wp_register_widget_control() Unregisters by using empty callback.
+ * @global array $wp_registered_widget_updates
*
- * @param int|string $id Widget ID.
+ * @param string $id_base
+ * @param callable $update_callback
+ * @param array $options
*/
-function wp_unregister_widget_control($id) {
- return wp_register_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;
}
/**
- * Display dynamic sidebar.
- *
- * By default it displays the default sidebar or 'sidebar-1'. The 'sidebar-1' is
- * not named by the theme, the actual name is '1', but 'sidebar-' is added to
- * the registered sidebars for the name. If you named your sidebar 'after-post',
- * then the parameter $index will still be 'after-post', but the lookup will be
- * for 'sidebar-after-post'.
- *
- * It is confusing for the $index parameter, but just know that it should just
- * work. When you register the sidebar in the theme, you will use the same name
- * for this function or "Pay no heed to the man behind the curtain." Just accept
- * it as an oddity of WordPress sidebar register and display.
*
- * @since 2.2.0
+ * @global array $wp_registered_widget_controls
*
- * @param int|string $index Optional, default is 1. Name or ID of dynamic sidebar.
- * @return bool True, if widget sidebar was found and called. False if not found or not called.
+ * @param int|string $id
+ * @param string $name
+ * @param callable $form_callback
+ * @param array $options
*/
-function dynamic_sidebar($index = 1) {
- global $wp_registered_sidebars, $wp_registered_widgets;
+function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {
+ global $wp_registered_widget_controls;
- if ( is_int($index) ) {
- $index = "sidebar-$index";
- } else {
- $index = sanitize_title($index);
- foreach ( (array) $wp_registered_sidebars as $key => $value ) {
- if ( sanitize_title($value['name']) == $index ) {
- $index = $key;
- break;
- }
- }
+ $id = strtolower($id);
+
+ if ( empty($form_callback) ) {
+ unset($wp_registered_widget_controls[$id]);
+ return;
}
- $sidebars_widgets = wp_get_sidebars_widgets();
+ if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) )
+ return;
+
+ $defaults = array('width' => 250, 'height' => 200 );
+ $options = wp_parse_args($options, $defaults);
+ $options['width'] = (int) $options['width'];
+ $options['height'] = (int) $options['height'];
+
+ $widget = array(
+ 'name' => $name,
+ 'id' => $id,
+ 'callback' => $form_callback,
+ 'params' => array_slice(func_get_args(), 4)
+ );
+ $widget = array_merge($widget, $options);
+
+ $wp_registered_widget_controls[$id] = $widget;
+}
+
+/**
+ * Remove control callback for widget.
+ *
+ * @since 2.2.0
+ *
+ * @param int|string $id Widget ID.
+ */
+function wp_unregister_widget_control($id) {
+ wp_register_widget_control( $id, '', '' );
+}
+
+/**
+ * Display dynamic sidebar.
+ *
+ * By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or
+ * 'name' parameter for its registered sidebars you can pass an id or name as the $index parameter.
+ * Otherwise, you can pass in a numerical index to display the sidebar at that index.
+ *
+ * @since 2.2.0
+ *
+ * @global array $wp_registered_sidebars
+ * @global array $wp_registered_widgets
+ *
+ * @param int|string $index Optional, default is 1. Index, name or ID of dynamic sidebar.
+ * @return bool True, if widget sidebar was found and called. False if not found or not called.
+ */
+function dynamic_sidebar($index = 1) {
+ global $wp_registered_sidebars, $wp_registered_widgets;
+
+ if ( is_int($index) ) {
+ $index = "sidebar-$index";
+ } else {
+ $index = sanitize_title($index);
+ foreach ( (array) $wp_registered_sidebars as $key => $value ) {
+ if ( sanitize_title($value['name']) == $index ) {
+ $index = $key;
+ break;
+ }
+ }
+ }
- if ( empty($wp_registered_sidebars[$index]) || !array_key_exists($index, $sidebars_widgets) || !is_array($sidebars_widgets[$index]) || empty($sidebars_widgets[$index]) )
- return false;
+ $sidebars_widgets = wp_get_sidebars_widgets();
+ if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) {
+ /** This action is documented in wp-includes/widgets.php */
+ do_action( 'dynamic_sidebar_before', $index, false );
+ /** This action is documented in wp-includes/widgets.php */
+ do_action( 'dynamic_sidebar_after', $index, false );
+ /** This filter is documented in wp-includes/widgets.php */
+ return apply_filters( 'dynamic_sidebar_has_widgets', false, $index );
+ }
+ /**
+ * Fires before widgets are rendered in a dynamic sidebar.
+ *
+ * Note: The action also fires for empty sidebars, and on both the front-end
+ * and back-end, including the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * @since 3.9.0
+ *
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ * @param bool $has_widgets Whether the sidebar is populated with widgets.
+ * Default true.
+ */
+ do_action( 'dynamic_sidebar_before', $index, true );
$sidebar = $wp_registered_sidebars[$index];
$did_one = false;
foreach ( (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']
@@ -470,44 +1252,148 @@ function dynamic_sidebar($index = 1) {
$classname_ = ltrim($classname_, '_');
$params[0]['before_widget'] = sprintf($params[0]['before_widget'], $id, $classname_);
+ /**
+ * Filter the parameters passed to a widget's display callback.
+ *
+ * Note: The filter is evaluated on both the front-end and back-end,
+ * including for the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * @since 2.5.0
+ *
+ * @see register_sidebar()
+ *
+ * @param array $params {
+ * @type array $args {
+ * An array of widget display arguments.
+ *
+ * @type string $name Name of the sidebar the widget is assigned to.
+ * @type string $id ID of the sidebar the widget is assigned to.
+ * @type string $description The sidebar description.
+ * @type string $class CSS class applied to the sidebar container.
+ * @type string $before_widget HTML markup to prepend to each widget in the sidebar.
+ * @type string $after_widget HTML markup to append to each widget in the sidebar.
+ * @type string $before_title HTML markup to prepend to the widget title when displayed.
+ * @type string $after_title HTML markup to append to the widget title when displayed.
+ * @type string $widget_id ID of the widget.
+ * @type string $widget_name Name of the widget.
+ * }
+ * @type array $widget_args {
+ * An array of multi-widget arguments.
+ *
+ * @type int $number Number increment used for multiples of the same widget.
+ * }
+ * }
+ */
$params = apply_filters( 'dynamic_sidebar_params', $params );
$callback = $wp_registered_widgets[$id]['callback'];
+ /**
+ * Fires before a widget's display callback is called.
+ *
+ * Note: The action fires on both the front-end and back-end, including
+ * for widgets in the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * The action is not fired for empty sidebars.
+ *
+ * @since 3.0.0
+ *
+ * @param array $widget_id {
+ * An associative array of widget arguments.
+ *
+ * @type string $name Name of the widget.
+ * @type string $id Widget ID.
+ * @type array|callback $callback When the hook is fired on the front-end, $callback is an array
+ * containing the widget object. Fired on the back-end, $callback
+ * is 'wp_widget_control', see $_callback.
+ * @type array $params An associative array of multi-widget arguments.
+ * @type string $classname CSS class applied to the widget container.
+ * @type string $description The widget description.
+ * @type array $_callback When the hook is fired on the back-end, $_callback is populated
+ * with an array containing the widget object, see $callback.
+ * }
+ */
+ do_action( 'dynamic_sidebar', $wp_registered_widgets[ $id ] );
+
if ( is_callable($callback) ) {
call_user_func_array($callback, $params);
$did_one = true;
}
}
- return $did_one;
+ /**
+ * Fires after widgets are rendered in a dynamic sidebar.
+ *
+ * Note: The action also fires for empty sidebars, and on both the front-end
+ * and back-end, including the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * @since 3.9.0
+ *
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ * @param bool $has_widgets Whether the sidebar is populated with widgets.
+ * Default true.
+ */
+ do_action( 'dynamic_sidebar_after', $index, true );
+
+ /**
+ * Filter whether a sidebar has widgets.
+ *
+ * Note: The filter is also evaluated for empty sidebars, and on both the front-end
+ * and back-end, including the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * @since 3.9.0
+ *
+ * @param bool $did_one Whether at least one widget was rendered in the sidebar.
+ * Default false.
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ */
+ return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index );
}
/**
- * Whether widget is registered using callback with widget ID.
+ * Whether widget is displayed on the front-end.
*
- * 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.
+ * Either $callback or $id_base can be used
+ * $id_base is the first argument when extending WP_Widget class
+ * Without the optional $widget_id parameter, returns the ID of the first sidebar
+ * in which the first instance of the widget with the given callback or $id_base is found.
+ * With the $widget_id parameter, returns the ID of the sidebar where
+ * the widget with that callback/$id_base AND that ID is found.
+ *
+ * NOTE: $widget_id and $id_base are the same for single widgets. To be effective
+ * this function has to run after widgets have initialized, at action 'init' or later.
*
* @since 2.2.0
*
- * @param callback $callback 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.
+ * @global array $wp_registered_widgets
+ *
+ * @param string $callback Optional, Widget callback to check.
+ * @param int $widget_id Optional, but needed for checking. Widget ID.
+ * @param string $id_base Optional, the base ID of a widget created by extending WP_Widget.
+ * @param bool $skip_inactive Optional, whether to check in 'wp_inactive_widgets'.
+ * @return string|false False if widget is not active or id of sidebar in which the widget is active.
*/
-function is_active_widget($callback, $widget_id = false) {
+function is_active_widget($callback = false, $widget_id = false, $id_base = false, $skip_inactive = true) {
global $wp_registered_widgets;
- $sidebars_widgets = wp_get_sidebars_widgets(false);
-
- if ( is_array($sidebars_widgets) ) foreach ( $sidebars_widgets as $sidebar => $widgets )
- if ( is_array($widgets) ) foreach ( $widgets as $widget )
- if ( isset($wp_registered_widgets[$widget]['callback']) && $wp_registered_widgets[$widget]['callback'] == $callback )
- if ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] )
- return $sidebar;
+ $sidebars_widgets = wp_get_sidebars_widgets();
+ if ( is_array($sidebars_widgets) ) {
+ foreach ( $sidebars_widgets as $sidebar => $widgets ) {
+ if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) ) {
+ continue;
+ }
+ if ( is_array($widgets) ) {
+ foreach ( $widgets as $widget ) {
+ if ( ( $callback && isset($wp_registered_widgets[$widget]['callback']) && $wp_registered_widgets[$widget]['callback'] == $callback ) || ( $id_base && _get_widget_id_base($widget) == $id_base ) ) {
+ if ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] )
+ return $sidebar;
+ }
+ }
+ }
+ }
+ }
return false;
}
@@ -516,6 +1402,9 @@ function is_active_widget($callback, $widget_id = false) {
*
* @since 2.2.0
*
+ * @global array $wp_registered_widgets
+ * @global array $wp_registered_sidebars
+ *
* @return bool True, if using widgets. False, if not using widgets.
*/
function is_dynamic_sidebar() {
@@ -531,10 +1420,35 @@ function is_dynamic_sidebar() {
return false;
}
+/**
+ * Whether a sidebar is in use.
+ *
+ * @since 2.8.0
+ *
+ * @param string|int $index Sidebar name, id or number to check.
+ * @return bool true if the sidebar is in use, false otherwise.
+ */
+function is_active_sidebar( $index ) {
+ $index = ( is_int($index) ) ? "sidebar-$index" : sanitize_title($index);
+ $sidebars_widgets = wp_get_sidebars_widgets();
+ $is_active_sidebar = ! empty( $sidebars_widgets[$index] );
+
+ /**
+ * Filter whether a dynamic sidebar is considered "active".
+ *
+ * @since 3.9.0
+ *
+ * @param bool $is_active_sidebar Whether or not the sidebar should be considered "active".
+ * In other words, whether the sidebar contains any widgets.
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ */
+ return apply_filters( 'is_active_sidebar', $is_active_sidebar, $index );
+}
+
/* Internal Functions */
/**
- * Retrieve full list of sidebars and their widgets.
+ * Retrieve full list of sidebars and their widget instance IDs.
*
* Will upgrade sidebar widget list, if needed. Will also save updated list, if
* needed.
@@ -542,87 +1456,40 @@ function is_dynamic_sidebar() {
* @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.
+ * @global array $_wp_sidebars_widgets
+ * @global array $sidebars_widgets
+ *
+ * @param bool $deprecated Not used (argument deprecated).
+ * @return array Upgraded list of widgets to version 3 array format when called from the admin.
*/
-function wp_get_sidebars_widgets($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;
- }
-
- $found = false;
-
- foreach ( $wp_registered_widgets as $widget_id => $widget ) {
- if ( strtolower($widget['name']) == strtolower($name) ) {
- $_sidebars_widgets[$index][$i] = $widget['id'];
- $found = true;
- break;
- } elseif ( sanitize_title($widget['name']) == sanitize_title($name) ) {
- $_sidebars_widgets[$index][$i] = $widget['id'];
- $found = true;
- break;
- }
- }
-
- if ( $found )
- continue;
-
- unset($_sidebars_widgets[$index][$i]);
- }
- $_sidebars_widgets['array_version'] = 2;
- $sidebars_widgets = $_sidebars_widgets;
- unset($_sidebars_widgets);
-
- case 2 :
- $sidebars = array_keys( $wp_registered_sidebars );
- if ( !empty( $sidebars ) ) {
- // Move the known-good ones first
- foreach ( (array) $sidebars as $id ) {
- if ( array_key_exists( $id, $sidebars_widgets ) ) {
- $_sidebars_widgets[$id] = $sidebars_widgets[$id];
- unset($sidebars_widgets[$id], $sidebars[$id]);
- }
- }
+function wp_get_sidebars_widgets( $deprecated = true ) {
+ if ( $deprecated !== true )
+ _deprecated_argument( __FUNCTION__, '2.8.1' );
- // Assign to each unmatched registered sidebar the first available orphan
- unset( $sidebars_widgets[ 'array_version' ] );
- while ( ( $sidebar = array_shift( $sidebars ) ) && $widgets = array_shift( $sidebars_widgets ) )
- $_sidebars_widgets[ $sidebar ] = $widgets;
+ global $_wp_sidebars_widgets, $sidebars_widgets;
- $_sidebars_widgets['array_version'] = 3;
- $sidebars_widgets = $_sidebars_widgets;
- unset($_sidebars_widgets);
- }
+ // If loading from front page, consult $_wp_sidebars_widgets rather than options
+ // to see if wp_convert_widget_settings() has made manipulations in memory.
+ if ( !is_admin() ) {
+ if ( empty($_wp_sidebars_widgets) )
+ $_wp_sidebars_widgets = get_option('sidebars_widgets', array());
- if ( $update )
- update_option('sidebars_widgets', $sidebars_widgets);
+ $sidebars_widgets = $_wp_sidebars_widgets;
+ } else {
+ $sidebars_widgets = get_option('sidebars_widgets', array());
}
- 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);
- return $sidebars_widgets;
+ /**
+ * Filter the list of sidebars and their widgets.
+ *
+ * @since 2.7.0
+ *
+ * @param array $sidebars_widgets An associative array of sidebars and their widgets.
+ */
+ return apply_filters( 'sidebars_widgets', $sidebars_widgets );
}
/**
@@ -645,6 +1512,8 @@ function wp_set_sidebars_widgets( $sidebars_widgets ) {
* @since 2.2.0
* @access private
*
+ * @global array $wp_registered_sidebars
+ *
* @return array
*/
function wp_get_widget_defaults() {
@@ -658,1443 +1527,259 @@ function wp_get_widget_defaults() {
return $defaults;
}
-/* Default Widgets */
-
/**
- * Display pages widget.
+ * Convert the widget settings from single to multi-widget format.
*
- * @since 2.2.0
+ * @since 2.8.0
+ *
+ * @global array $_wp_sidebars_widgets
*
- * @param array $args Widget arguments.
+ * @param string $base_name
+ * @param string $option_name
+ * @param array $settings
+ * @return array
*/
-function wp_widget_pages( $args ) {
- extract( $args );
- $options = get_option( 'widget_pages' );
+function wp_convert_widget_settings($base_name, $option_name, $settings) {
+ // This test may need expanding.
+ $single = $changed = false;
+ if ( empty($settings) ) {
+ $single = true;
+ } else {
+ foreach ( array_keys($settings) as $number ) {
+ if ( 'number' == $number )
+ continue;
+ if ( !is_numeric($number) ) {
+ $single = true;
+ break;
+ }
+ }
+ }
- $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 ( $single ) {
+ $settings = array( 2 => $settings );
- if ( $sortby == 'menu_order' ) {
- $sortby = 'menu_order, post_title';
- }
+ // If loading from the front page, update sidebar in memory but don't save to options
+ if ( is_admin() ) {
+ $sidebars_widgets = get_option('sidebars_widgets');
+ } else {
+ if ( empty($GLOBALS['_wp_sidebars_widgets']) )
+ $GLOBALS['_wp_sidebars_widgets'] = get_option('sidebars_widgets', array());
+ $sidebars_widgets = &$GLOBALS['_wp_sidebars_widgets'];
+ }
- $out = wp_list_pages( array('title_li' => '', 'echo' => 0, 'sort_column' => $sortby, 'exclude' => $exclude) );
+ 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;
+ }
+ }
+ }
+ }
- if ( !empty( $out ) ) {
-?>
-
-
- - -
-
-
-
-
-
-
-
-
-
- - - -
- 'widget_text', 'description' => __('Arbitrary text or HTML')); - $control_ops = array('width' => 400, 'height' => 350, 'id_base' => 'text'); - $name = __('Text'); - - $id = false; - foreach ( (array) array_keys($options) as $o ) { - // Old widgets can have null values for some reason - if ( !isset($options[$o]['title']) || !isset($options[$o]['text']) ) + foreach ( $_sidebars_widgets as $sidebar => $widgets ) { + if ( !is_array($widgets) ) 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; + $_widgets = array(); + foreach ( $widgets as $widget ) { + if ( isset($wp_registered_widgets[$widget]) ) + $_widgets[] = $widget; + } - $c = $options[$number]['count'] ? '1' : '0'; - $h = $options[$number]['hierarchical'] ? '1' : '0'; - $d = $options[$number]['dropdown'] ? '1' : '0'; + $_sidebars_widgets[$sidebar] = $_widgets; + $shown_widgets = array_merge($shown_widgets, $_widgets); + } - $title = empty($options[$number]['title']) ? __('Categories') : apply_filters('widget_title', $options[$number]['title']); + $sidebars_widgets = $_sidebars_widgets; + unset($_sidebars_widgets, $_widgets); - echo $before_widget; - echo $before_title . $title . $after_title; + // find hidden/lost multi-widget instances + $lost_widgets = array(); + foreach ( $wp_registered_widgets as $key => $val ) { + if ( in_array($key, $shown_widgets, true) ) + continue; - $cat_args = array('orderby' => 'name', 'show_count' => $c, 'hierarchical' => $h); + $number = preg_replace('/.+?-([0-9]+)$/', '$1', $key); - if ( $d ) { - $cat_args['show_option_none'] = __('Select Category'); - wp_dropdown_categories($cat_args); -?> + if ( 2 > (int) $number ) + continue; - - -- -
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
- -- -
- -- -
- -- -
- -- -
- -- -
- - - -channel['link'])); - while ( strstr($link, 'http') != $link ) - $link = substr($link, 1); - } - } - - return compact( 'title', 'url', 'link', 'items', 'error', 'show_summary', 'show_author', 'show_date' ); -} - -/** - * 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']) ) - 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 - } - - update_option('widget_many', $options); - - $updated = true; // So that we don't go through this more than once - } - - - // Here we echo out the form - if ( -1 == $number ) { // We echo out a template for a form which can be converted to a specific form later via JS - $something = ''; - $number = '%i%'; - } else { - $something = attribute_escape($options[$number]['something']); - } - - // The form has inputs with names like widget-many[$number][something] so that all data for that instance of - // the widget are stored in one $_POST variable: $_POST['widget-many'][$number] -?> -- - -
- 'widget_many', 'description' => __('Widget which allows multiple instances')); - $control_ops = array('width' => 400, 'height' => 350, 'id_base' => 'many'); - $name = __('Many'); - - $registered = false; - foreach ( array_keys($options) as $o ) { - // Old widgets can have null values for some reason - if ( !isset($options[$o]['something']) ) // we used 'something' above in our exampple. Replace with with whatever your real data are. - continue; - - // $id should look like {$id_base}-{$o} - $id = "many-$o"; // Never never never translate an id - $registered = true; - wp_register_sidebar_widget( $id, $name, '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 ) ); - } -} - -// This is important -add_action( 'widgets_init', 'widget_many_register' ); - -*/ - -?>