X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/1c09677af04c9e37714e09b73eb9dbc5b2e3eb13..a7cd4c052013b423c6301153f68c7fdbaa2a447b:/wp-includes/widgets.php?ds=sidebyside
diff --git a/wp-includes/widgets.php b/wp-includes/widgets.php
index 47c0e6fc..2e710ccb 100644
--- a/wp-includes/widgets.php
+++ b/wp-includes/widgets.php
@@ -19,51 +19,123 @@
*
* @package WordPress
* @subpackage Widgets
- * @since 2.8
+ * @since 2.8.0
*/
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()
+ /**
+ * 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;
- 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.
+ /**
+ * 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.
+ /**
+ * 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
+ * @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.
*/
- function widget($args, $instance) {
+ public function widget( $args, $instance ) {
die('function WP_Widget::widget() must be over-ridden in a sub-class.');
}
- /** Update a particular instance.
+ /**
+ * 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.
*
- * 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 form()
- * @param array $old_instance Old settings for this instance
- * @return array Settings to save or bool false to cancel saving
+ * @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.
*/
- function update($new_instance, $old_instance) {
+ public function update( $new_instance, $old_instance ) {
return $new_instance;
}
- /** Echo the settings update form
+ /**
+ * Output the settings update form.
*
- * @param array $instance Current settings
+ * @since 2.8.0
+ * @access public
+ *
+ * @param array $instance Current settings.
+ * @return string Default return is 'noform'.
*/
- function form($instance) {
+ public function form($instance) {
echo '
' . __('There are no options for this widget.') . '
';
return 'noform';
}
@@ -71,26 +143,20 @@ class WP_Widget {
// Functions you'll need to call.
/**
- * PHP4 constructor
- */
- function WP_Widget( $id_base = false, $name, $widget_options = array(), $control_options = array() ) {
- $this->__construct( $id_base, $name, $widget_options, $control_options );
- }
-
- /**
- * 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
+ * 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.
*/
- function __construct( $id_base = false, $name, $widget_options = array(), $control_options = 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;
@@ -98,6 +164,18 @@ class WP_Widget {
$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() ) {
+ WP_Widget::__construct( $id_base, $name, $widget_options, $control_options );
+ }
+
/**
* Constructs name attributes for use in form() fields
*
@@ -106,25 +184,33 @@ class WP_Widget {
* @param string $field_name Field name
* @return string Name attribute for $field_name
*/
- function get_field_name($field_name) {
+ public function get_field_name($field_name) {
return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']';
}
/**
- * Constructs id attributes for use in form() fields
+ * 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 update()
+ * This function should be used in form() methods to create id attributes
+ * for fields to be saved by {@see WP_Widget::update()}.
*
- * @param string $field_name Field name
- * @return string ID attribute for $field_name
+ * @since 2.8.0
+ * @access public
+ *
+ * @param string $field_name Field name.
+ * @return string ID attribute for `$field_name`.
*/
- function get_field_id($field_name) {
+ public function get_field_id( $field_name ) {
return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name;
}
- // Private Functions. Don't worry about these.
-
- function _register() {
+ /**
+ * Register all widget instances of this widget class.
+ *
+ * @since 2.8.0
+ * @access private
+ */
+ public function _register() {
$settings = $this->get_settings();
$empty = true;
@@ -139,34 +225,75 @@ class WP_Widget {
}
if ( $empty ) {
- // If there are none, we register the widget's existance with a
+ // If there are none, we register the widget's existence with a
// generic template
$this->_set(1);
$this->_register_one();
}
}
- function _set($number) {
+ /**
+ * 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;
}
- function _get_display_callback() {
- return array(&$this, 'display_callback');
+ public function _get_display_callback() {
+ return array($this, 'display_callback');
+ }
+
+ public function _get_update_callback() {
+ return array($this, 'update_callback');
}
- function _get_update_callback() {
- return array(&$this, 'update_callback');
+ public function _get_form_callback() {
+ return array($this, 'form_callback');
}
- 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
+ *
+ * @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.
- * Just finds the instance and calls widget().
- * Do NOT over-ride this function. */
- function display_callback( $args, $widget_args = 1 ) {
+ /**
+ * 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 );
@@ -176,30 +303,54 @@ class WP_Widget {
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);
+
+ /**
+ * 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 over-ride this function. */
- function update_callback( $widget_args = 1 ) {
+ /**
+ * Deal with changed settings (Do NOT override).
+ *
+ * @since 2.8.0
+ * @access public
+ *
+ * @param int $deprecated Not used.
+ */
+ public function update_callback( $deprecated = 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']) )
@@ -229,12 +380,34 @@ class WP_Widget {
$old_instance = isset($all_instances[$number]) ? $all_instances[$number] : array();
- $instance = $this->update($new_instance, $old_instance);
+ $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 );
- // 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 )
+ 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
}
@@ -244,9 +417,15 @@ class WP_Widget {
$this->updated = true;
}
- /** Generate the control form.
- * Do NOT over-ride this function. */
- function form_callback( $widget_args = 1 ) {
+ /**
+ * 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.
+ */
+ public function form_callback( $widget_args = 1 ) {
if ( is_numeric($widget_args) )
$widget_args = array( 'number' => $widget_args );
@@ -262,32 +441,81 @@ class WP_Widget {
$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);
+ /**
+ * 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);
- // 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) );
+
+ /**
+ * 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;
}
- /** Helper function: Registers a single instance. */
- function _register_one($number = -1) {
+ /**
+ * 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 ) );
}
- function save_settings($settings) {
+ /**
+ * 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 );
}
- function get_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) )
@@ -296,8 +524,8 @@ class WP_Widget {
if ( !is_array($settings) )
$settings = array();
- if ( !array_key_exists('_multiwidget', $settings) ) {
- // old format, conver if single widget
+ 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);
}
@@ -311,25 +539,47 @@ class WP_Widget {
*
* @package WordPress
* @subpackage Widgets
- * @since 2.8
+ * @since 2.8.0
*/
class WP_Widget_Factory {
- var $widgets = array();
+ public $widgets = array();
- function WP_Widget_Factory() {
- add_action( 'widgets_init', array( &$this, '_register_widgets' ), 100 );
+ public function WP_Widget_Factory() {
+ add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 );
}
- function register($widget_class) {
- $this->widgets[$widget_class] = & new $widget_class();
+ /**
+ * 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();
}
- function unregister($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 ) {
if ( isset($this->widgets[$widget_class]) )
unset($this->widgets[$widget_class]);
}
- function _register_widgets() {
+ /**
+ * Utility method for adding widgets to the registered widgets global.
+ *
+ * @since 2.8.0
+ * @access public
+ */
+ public function _register_widgets() {
global $wp_registered_widgets;
$keys = array_keys($this->widgets);
$registered = array_keys($wp_registered_widgets);
@@ -385,8 +635,8 @@ $_wp_sidebars_widgets = array();
/**
* Private
*/
- $_wp_deprecated_widgets_callbacks = array(
- 'wp_widget_pages',
+$GLOBALS['_wp_deprecated_widgets_callbacks'] = array(
+ 'wp_widget_pages',
'wp_widget_pages_control',
'wp_widget_calendar',
'wp_widget_calendar_control',
@@ -408,7 +658,7 @@ $_wp_sidebars_widgets = array();
'wp_widget_rss_control',
'wp_widget_recent_comments',
'wp_widget_recent_comments_control'
- );
+);
/* Template tags & API functions */
@@ -456,49 +706,53 @@ function unregister_widget($widget_class) {
*
* 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.
+ * @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);
}
}
@@ -506,59 +760,75 @@ 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;
$defaults = array(
'name' => sprintf(__('Sidebar %d'), $i ),
'id' => "sidebar-$i",
'description' => '',
+ 'class' => '',
'before_widget' => '',
'after_widget' => "\n",
'before_title' => '\n",
);
- $sidebar = array_merge($defaults, (array) $args);
+ $sidebar = wp_parse_args( $args, $defaults );
$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'];
}
@@ -579,26 +849,32 @@ function unregister_sidebar( $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.
+ *
+ * @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.
+ * }
+ * @return null Will return if `$output_callback` is empty after removing widget.
*/
-function wp_register_sidebar_widget($id, $name, $output_callback, $options = array()) {
+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);
@@ -629,8 +905,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;
+ }
}
/**
@@ -663,7 +949,7 @@ function wp_widget_description( $id ) {
*
* @since 2.9.0
*
- * @param int|string $id sidebar ID.
+ * @param string $id sidebar ID.
* @return string Sidebar description, if available. Null on failure to retrieve description.
*/
function wp_sidebar_description( $id ) {
@@ -676,7 +962,6 @@ function wp_sidebar_description( $id ) {
return esc_html( $wp_registered_sidebars[$id]['description'] );
}
-
/**
* Remove widget from sidebar.
*
@@ -685,6 +970,16 @@ function wp_sidebar_description( $id ) {
* @param int|string $id Widget ID.
*/
function wp_unregister_sidebar_widget($id) {
+
+ /**
+ * 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 );
+
wp_register_sidebar_widget($id, '', '');
wp_unregister_widget_control($id);
}
@@ -697,17 +992,19 @@ function wp_unregister_sidebar_widget($id) {
* 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?
+ *
+ * @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()) {
+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);
@@ -754,6 +1051,13 @@ function wp_register_widget_control($id, $name, $control_callback, $options = ar
$wp_registered_widget_updates[$id_base] = $widget;
}
+/**
+ *
+ * @global array $wp_registered_widget_updates
+ * @param string $id_base
+ * @param callable $update_callback
+ * @param array $options
+ */
function _register_widget_update_callback($id_base, $update_callback, $options = array()) {
global $wp_registered_widget_updates;
@@ -772,6 +1076,15 @@ function _register_widget_update_callback($id_base, $update_callback, $options =
$wp_registered_widget_updates[$id_base] = $widget;
}
+/**
+ *
+ * @global array $wp_registered_widget_controls
+ * @param int|string $id
+ * @param string $name
+ * @param callable $form_callback
+ * @param array $options
+ * @return null
+ */
function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {
global $wp_registered_widget_controls;
@@ -805,7 +1118,6 @@ function _register_widget_form_callback($id, $name, $form_callback, $options = a
* Remove control callback for widget.
*
* @since 2.2.0
- * @uses wp_register_widget_control() Unregisters by using empty callback.
*
* @param int|string $id Widget ID.
*/
@@ -816,20 +1128,13 @@ function wp_unregister_widget_control($id) {
/**
* 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.
+ * 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
*
- * @param int|string $index Optional, default is 1. Name or ID of dynamic sidebar.
+ * @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) {
@@ -848,10 +1153,28 @@ function dynamic_sidebar($index = 1) {
}
$sidebars_widgets = wp_get_sidebars_widgets();
+ if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) {
+ /** This action is documented in wp-includes/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 );
+ }
- if ( empty($wp_registered_sidebars[$index]) || !array_key_exists($index, $sidebars_widgets) || !is_array($sidebars_widgets[$index]) || empty($sidebars_widgets[$index]) )
- return false;
-
+ /**
+ * Fires before widgets are rendered in a dynamic sidebar.
+ *
+ * Note: The action also fires for empty sidebars, and on both the front-end
+ * and back-end, including the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * @since 3.9.0
+ *
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ * @param bool $has_widgets Whether the sidebar is populated with widgets.
+ * Default true.
+ */
+ do_action( 'dynamic_sidebar_before', $index, true );
$sidebar = $wp_registered_sidebars[$index];
$did_one = false;
@@ -875,21 +1198,109 @@ 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;
}
}
+ /**
+ * 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.
+ */
+
+ $did_one = apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index );
+
return $did_one;
}
/**
- * Whether widget is displayied on the front-end.
+ * Whether widget is displayed on the front-end.
*
* Either $callback or $id_base can be used
* $id_base is the first argument when extending WP_Widget class
@@ -903,7 +1314,7 @@ function dynamic_sidebar($index = 1) {
*
* @since 2.2.0
*
- * @param callback Optional, Widget callback to check.
+ * @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'.
@@ -916,8 +1327,9 @@ function is_active_widget($callback = false, $widget_id = false, $id_base = fals
if ( is_array($sidebars_widgets) ) {
foreach ( $sidebars_widgets as $sidebar => $widgets ) {
- if ( $skip_inactive && 'wp_inactive_widgets' == $sidebar )
+ if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) ) {
continue;
+ }
if ( is_array($widgets) ) {
foreach ( $widgets as $widget ) {
@@ -955,24 +1367,32 @@ function is_dynamic_sidebar() {
/**
* Whether a sidebar is in use.
*
- * @since 2.8
+ * @since 2.8.0
*
- * @param mixed $index, sidebar name, id or number to check.
+ * @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();
- if ( isset($sidebars_widgets[$index]) && !empty($sidebars_widgets[$index]) )
- return true;
+ $is_active_sidebar = ! empty( $sidebars_widgets[$index] );
- return false;
+ /**
+ * 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.
@@ -980,11 +1400,14 @@ function is_active_sidebar( $index ) {
* @since 2.2.0
* @access private
*
- * @param bool $update Optional, deprecated.
+ * @param bool $deprecated Not used (argument deprecated).
* @return array Upgraded list of widgets to version 3 array format when called from the admin.
*/
-function wp_get_sidebars_widgets($deprecated = true) {
- global $wp_registered_widgets, $wp_registered_sidebars, $_wp_sidebars_widgets;
+function wp_get_sidebars_widgets( $deprecated = true ) {
+ if ( $deprecated !== true )
+ _deprecated_argument( __FUNCTION__, '2.8.1' );
+
+ global $_wp_sidebars_widgets, $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.
@@ -995,84 +1418,19 @@ function wp_get_sidebars_widgets($deprecated = true) {
$sidebars_widgets = $_wp_sidebars_widgets;
} else {
$sidebars_widgets = get_option('sidebars_widgets', array());
- $_sidebars_widgets = array();
-
- if ( isset($sidebars_widgets['wp_inactive_widgets']) || empty($sidebars_widgets) )
- $sidebars_widgets['array_version'] = 3;
- elseif ( !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]);
- }
- }
-
- // move the rest to wp_inactive_widgets
- if ( !isset($_sidebars_widgets['wp_inactive_widgets']) )
- $_sidebars_widgets['wp_inactive_widgets'] = array();
-
- if ( !empty($sidebars_widgets) ) {
- foreach ( $sidebars_widgets as $lost => $val ) {
- if ( is_array($val) )
- $_sidebars_widgets['wp_inactive_widgets'] = array_merge( (array) $_sidebars_widgets['wp_inactive_widgets'], $val );
- }
- }
-
- $sidebars_widgets = $_sidebars_widgets;
- unset($_sidebars_widgets);
- }
- }
}
- 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);
+ /**
+ * Filter the list of sidebars and their widgets.
+ *
+ * @since 2.7.0
+ *
+ * @param array $sidebars_widgets An associative array of sidebars and their widgets.
+ */
+ $sidebars_widgets = apply_filters( 'sidebars_widgets', $sidebars_widgets );
return $sidebars_widgets;
}
@@ -1114,6 +1472,9 @@ function wp_get_widget_defaults() {
*
* @since 2.8.0
*
+ * @param string $base_name
+ * @param string $option_name
+ * @param array $settings
* @return array
*/
function wp_convert_widget_settings($base_name, $option_name, $settings) {
@@ -1168,143 +1529,184 @@ function wp_convert_widget_settings($base_name, $option_name, $settings) {
}
/**
- * Deprecated API
- */
-
-/**
- * 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.
+ * Output an arbitrary widget as a template tag.
*
- * 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.
+ * @since 2.8.0
*
- * @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.
+ * @param string $widget The widget's PHP class name (see default-widgets.php).
+ * @param array $instance Optional. The widget's instance settings. Default empty array.
+ * @param array $args {
+ * Optional. Array of arguments to configure the display of the widget.
+ *
+ * @type string $before_widget HTML content that will be prepended to the widget's HTML output.
+ * Default ``, where `%s` is the widget's class name.
+ * @type string $after_widget HTML content that will be appended to the widget's HTML output.
+ * Default `
`.
+ * @type string $before_title HTML content that will be prepended to the widget's title when displayed.
+ * Default ``.
+ * }
*/
-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];
- }
+function the_widget( $widget, $instance = array(), $args = array() ) {
+ global $wp_widget_factory;
+
+ $widget_obj = $wp_widget_factory->widgets[$widget];
+ if ( !is_a($widget_obj, 'WP_Widget') )
+ return;
- $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);
+ $before_widget = sprintf('', $widget_obj->widget_options['classname'] );
+ $default_args = array( 'before_widget' => $before_widget, 'after_widget' => "
", 'before_title' => '' );
- call_user_func_array('wp_register_sidebar_widget', $args);
+ $args = wp_parse_args($args, $default_args);
+ $instance = wp_parse_args($instance);
+
+ /**
+ * Fires before rendering the requested widget.
+ *
+ * @since 3.0.0
+ *
+ * @param string $widget The widget's class name.
+ * @param array $instance The current widget instance's settings.
+ * @param array $args An array of the widget's sidebar arguments.
+ */
+ do_action( 'the_widget', $widget, $instance, $args );
+
+ $widget_obj->_set(-1);
+ $widget_obj->widget($args, $instance);
}
/**
- * Alias of {@link wp_unregister_sidebar_widget()}.
- *
- * @see wp_unregister_sidebar_widget()
- *
- * @since 2.2.0
- *
- * @param int|string $id Widget ID.
+ * Private
*/
-function unregister_sidebar_widget($id) {
- return wp_unregister_sidebar_widget($id);
+function _get_widget_id_base($id) {
+ return preg_replace( '/-[0-9]+$/', '', $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.
+ * Handle sidebars config after theme change
*
- * @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.
+ * @access private
+ * @since 3.3.0
*/
-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];
- }
+function _wp_sidebars_changed() {
+ global $sidebars_widgets;
- $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);
+ if ( ! is_array( $sidebars_widgets ) )
+ $sidebars_widgets = wp_get_sidebars_widgets();
+
+ retrieve_widgets(true);
}
/**
- * Alias of {@link wp_unregister_widget_control()}.
+ * Look for "lost" widgets, this has to run at least on each theme change.
*
- * @since 2.2.0
- * @see wp_unregister_widget_control()
+ * @since 2.8.0
*
- * @param int|string $id Widget ID.
+ * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value
+ * of 'customize' defers updates for the Customizer.
+ * @return array
*/
-function unregister_widget_control($id) {
- return wp_unregister_widget_control($id);
-}
+function retrieve_widgets( $theme_changed = false ) {
+ global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;
-/**
- * Output an arbitrary widget as a template tag
- *
- * @since 2.8
- *
- * @param string $widget the widget's PHP class name (see default-widgets.php)
- * @param array $instance the widget's instance settings
- * @param array $args the widget's sidebar args
- * @return void
- **/
-function the_widget($widget, $instance = array(), $args = array()) {
- global $wp_widget_factory;
+ $registered_sidebar_keys = array_keys( $wp_registered_sidebars );
+ $orphaned = 0;
- $widget_obj = $wp_widget_factory->widgets[$widget];
- if ( !is_a($widget_obj, 'WP_Widget') )
- return;
+ $old_sidebars_widgets = get_theme_mod( 'sidebars_widgets' );
+ if ( is_array( $old_sidebars_widgets ) ) {
+ // time() that sidebars were stored is in $old_sidebars_widgets['time']
+ $_sidebars_widgets = $old_sidebars_widgets['data'];
- $before_widget = sprintf('', $widget_obj->widget_options['classname']);
- $default_args = array('before_widget' => $before_widget, 'after_widget' => "
", 'before_title' => '');
+ if ( 'customize' !== $theme_changed ) {
+ remove_theme_mod( 'sidebars_widgets' );
+ }
- $args = wp_parse_args($args, $default_args);
- $instance = wp_parse_args($instance);
+ foreach ( $_sidebars_widgets as $sidebar => $widgets ) {
+ if ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
+ continue;
+ }
- $widget_obj->_set(-1);
- $widget_obj->widget($args, $instance);
-}
+ if ( !in_array( $sidebar, $registered_sidebar_keys ) ) {
+ $_sidebars_widgets['orphaned_widgets_' . ++$orphaned] = $widgets;
+ unset( $_sidebars_widgets[$sidebar] );
+ }
+ }
+ } else {
+ if ( empty( $sidebars_widgets ) )
+ return;
-/**
- * Private
- */
-function _get_widget_id_base($id) {
- return preg_replace( '/-[0-9]+$/', '', $id );
+ unset( $sidebars_widgets['array_version'] );
+
+ $old = array_keys($sidebars_widgets);
+ sort($old);
+ sort($registered_sidebar_keys);
+
+ if ( $old == $registered_sidebar_keys )
+ return;
+
+ $_sidebars_widgets = array(
+ 'wp_inactive_widgets' => !empty( $sidebars_widgets['wp_inactive_widgets'] ) ? $sidebars_widgets['wp_inactive_widgets'] : array()
+ );
+
+ unset( $sidebars_widgets['wp_inactive_widgets'] );
+
+ 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 ( $sidebars_widgets as $val ) {
+ if ( is_array($val) && ! empty( $val ) )
+ $_sidebars_widgets['orphaned_widgets_' . ++$orphaned] = $val;
+ }
+ }
+
+ // discard invalid, theme-specific widgets from sidebars
+ $shown_widgets = array();
+
+ foreach ( $_sidebars_widgets as $sidebar => $widgets ) {
+ if ( !is_array($widgets) )
+ continue;
+
+ $_widgets = array();
+ foreach ( $widgets as $widget ) {
+ if ( isset($wp_registered_widgets[$widget]) )
+ $_widgets[] = $widget;
+ }
+
+ $_sidebars_widgets[$sidebar] = $_widgets;
+ $shown_widgets = array_merge($shown_widgets, $_widgets);
+ }
+
+ $sidebars_widgets = $_sidebars_widgets;
+ unset($_sidebars_widgets, $_widgets);
+
+ // find hidden/lost multi-widget instances
+ $lost_widgets = array();
+ foreach ( $wp_registered_widgets as $key => $val ) {
+ if ( in_array($key, $shown_widgets, true) )
+ continue;
+
+ $number = preg_replace('/.+?-([0-9]+)$/', '$1', $key);
+
+ if ( 2 > (int) $number )
+ continue;
+
+ $lost_widgets[] = $key;
+ }
+
+ $sidebars_widgets['wp_inactive_widgets'] = array_merge($lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets']);
+ if ( 'customize' !== $theme_changed ) {
+ wp_set_sidebars_widgets( $sidebars_widgets );
+ }
+
+ return $sidebars_widgets;
}