WordPress 4.4.1
[autoinstalls/wordpress.git] / wp-includes / widgets.php
index 765bbffcfce17850a80c550a0ec86e7df801d546..cfc5b93cc298879447b588ceddf8e4cd4ea96a4b 100644 (file)
 <?php
 /**
- * API for creating dynamic sidebar without hardcoding functionality into
- * themes. Includes both internal WordPress routines and theme use routines.
+ * Core Widgets API
  *
- * This functionality was found in a plugin before WordPress 2.2 release which
- * included it in the core from that point on.
+ * This API is used for creating dynamic sidebar without hardcoding functionality into
+ * themes
  *
- * @link http://codex.wordpress.org/Plugins/WordPress_Widgets WordPress Widgets
- * @link http://codex.wordpress.org/Plugins/WordPress_Widgets_Api Widgets API
+ * Includes both internal WordPress routines and theme-use routines.
  *
- * @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.
+ * This functionality was found in a plugin before the WordPress 2.2 release, which
+ * included it in the core from that point on.
  *
- * @package WordPress
- * @subpackage Widgets
- * @since 2.8
- */
-class WP_Widget {
-
-       var $id_base;                   // Root id for all widgets of this type.
-       var $name;                              // Name for this widget type.
-       var $widget_options;    // Option array passed to wp_register_sidebar_widget()
-       var $control_options;   // Option array passed to wp_register_widget_control()
-
-       var $number = false;    // Unique ID number of the current instance.
-       var $id = false;                // Unique ID string of the current instance (id_base-number)
-       var $updated = false;   // Set true when we update the data after a POST submit - makes sure we don't do it twice.
-
-       // Member functions that you must over-ride.
-
-       /** Echo the widget content.
-        *
-        * Subclasses should over-ride this function to generate their widget code.
-        *
-        * @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
-        * @param array $instance The settings for the particular instance of the widget
-        */
-       function widget($args, $instance) {
-               die('function WP_Widget::widget() must be over-ridden in a sub-class.');
-       }
-
-       /** Update a particular instance.
-        *
-        * This function should check that $new_instance is set correctly.
-        * The newly calculated value of $instance should be returned.
-        * If "false" is returned, the instance won't be saved/updated.
-        *
-        * @param array $new_instance New settings for this instance as input by the user via form()
-        * @param array $old_instance Old settings for this instance
-        * @return array Settings to save or bool false to cancel saving
-        */
-       function update($new_instance, $old_instance) {
-               return $new_instance;
-       }
-
-       /** Echo the settings update form
-        *
-        * @param array $instance Current settings
-        */
-       function form($instance) {
-               echo '<p class="no-options-widget">' . __('There are no options for this widget.') . '</p>';
-               return 'noform';
-       }
-
-       // Functions you'll need to call.
-
-       /**
-        * PHP4 constructor
-        */
-       function WP_Widget( $id_base = false, $name, $widget_options = array(), $control_options = array() ) {
-               WP_Widget::__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
-        */
-       function __construct( $id_base = false, $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) );
-       }
-
-       /**
-        * Constructs name attributes for use in form() fields
-        *
-        * This function should be used in form() methods to create name attributes for fields to be saved by update()
-        *
-        * @param string $field_name Field name
-        * @return string Name attribute for $field_name
-        */
-       function get_field_name($field_name) {
-               return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']';
-       }
-
-       /**
-        * Constructs id attributes for use in form() fields
-        *
-        * This function should be used in form() methods to create id attributes for fields to be saved by update()
-        *
-        * @param string $field_name Field name
-        * @return string ID attribute for $field_name
-        */
-       function get_field_id($field_name) {
-               return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name;
-       }
-
-       // Private Functions. Don't worry about these.
-
-       function _register() {
-               $settings = $this->get_settings();
-               $empty = true;
-
-               if ( is_array($settings) ) {
-                       foreach ( array_keys($settings) as $number ) {
-                               if ( is_numeric($number) ) {
-                                       $this->_set($number);
-                                       $this->_register_one($number);
-                                       $empty = false;
-                               }
-                       }
-               }
-
-               if ( $empty ) {
-                       // If there are none, we register the widget's existence with a
-                       // generic template
-                       $this->_set(1);
-                       $this->_register_one();
-               }
-       }
-
-       function _set($number) {
-               $this->number = $number;
-               $this->id = $this->id_base . '-' . $number;
-       }
-
-       function _get_display_callback() {
-               return array(&$this, 'display_callback');
-       }
-
-       function _get_update_callback() {
-               return array(&$this, 'update_callback');
-       }
-
-       function _get_form_callback() {
-               return array(&$this, 'form_callback');
-       }
-
-       /** Generate the actual widget content.
-        *      Just finds the instance and calls widget().
-        *      Do NOT over-ride this function. */
-       function display_callback( $args, $widget_args = 1 ) {
-               if ( is_numeric($widget_args) )
-                       $widget_args = array( 'number' => $widget_args );
-
-               $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
-               $this->_set( $widget_args['number'] );
-               $instance = $this->get_settings();
-
-               if ( array_key_exists( $this->number, $instance ) ) {
-                       $instance = $instance[$this->number];
-                       // filters the widget's settings, return false to stop displaying the widget
-                       $instance = apply_filters('widget_display_callback', $instance, $this, $args);
-                       if ( false !== $instance )
-                               $this->widget($args, $instance);
-               }
-       }
-
-       /** Deal with changed settings.
-        *      Do NOT over-ride this function. */
-       function update_callback( $widget_args = 1 ) {
-               global $wp_registered_widgets;
-
-               if ( is_numeric($widget_args) )
-                       $widget_args = array( 'number' => $widget_args );
-
-               $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
-               $all_instances = $this->get_settings();
-
-               // We need to update the data
-               if ( $this->updated )
-                       return;
-
-               $sidebars_widgets = wp_get_sidebars_widgets();
-
-               if ( isset($_POST['delete_widget']) && $_POST['delete_widget'] ) {
-                       // Delete the settings for this instance of the widget
-                       if ( isset($_POST['the-widget-id']) )
-                               $del_id = $_POST['the-widget-id'];
-                       else
-                               return;
-
-                       if ( isset($wp_registered_widgets[$del_id]['params'][0]['number']) ) {
-                               $number = $wp_registered_widgets[$del_id]['params'][0]['number'];
-
-                               if ( $this->id_base . '-' . $number == $del_id )
-                                       unset($all_instances[$number]);
-                       }
-               } else {
-                       if ( isset($_POST['widget-' . $this->id_base]) && is_array($_POST['widget-' . $this->id_base]) ) {
-                               $settings = $_POST['widget-' . $this->id_base];
-                       } elseif ( isset($_POST['id_base']) && $_POST['id_base'] == $this->id_base ) {
-                               $num = $_POST['multi_number'] ? (int) $_POST['multi_number'] : (int) $_POST['widget_number'];
-                               $settings = array( $num => array() );
-                       } else {
-                               return;
-                       }
-
-                       foreach ( $settings as $number => $new_instance ) {
-                               $new_instance = stripslashes_deep($new_instance);
-                               $this->_set($number);
-
-                               $old_instance = isset($all_instances[$number]) ? $all_instances[$number] : array();
-
-                               $instance = $this->update($new_instance, $old_instance);
-
-                               // filters the widget's settings before saving, return false to cancel saving (keep the old settings if updating)
-                               $instance = apply_filters('widget_update_callback', $instance, $new_instance, $old_instance, $this);
-                               if ( false !== $instance )
-                                       $all_instances[$number] = $instance;
-
-                               break; // run only once
-                       }
-               }
-
-               $this->save_settings($all_instances);
-               $this->updated = true;
-       }
-
-       /** Generate the control form.
-        *      Do NOT over-ride this function. */
-       function form_callback( $widget_args = 1 ) {
-               if ( is_numeric($widget_args) )
-                       $widget_args = array( 'number' => $widget_args );
-
-               $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
-               $all_instances = $this->get_settings();
-
-               if ( -1 == $widget_args['number'] ) {
-                       // We echo out a form where 'number' can be set later
-                       $this->_set('__i__');
-                       $instance = array();
-               } else {
-                       $this->_set($widget_args['number']);
-                       $instance = $all_instances[ $widget_args['number'] ];
-               }
-
-               // filters the widget admin form before displaying, return false to stop displaying it
-               $instance = apply_filters('widget_form_callback', $instance, $this);
-
-               $return = null;
-               if ( false !== $instance ) {
-                       $return = $this->form($instance);
-                       // add extra fields in the widget form - be sure to set $return to null if you add any
-                       // if the widget has no form the text echoed from the default form method can be hidden using css
-                       do_action_ref_array( 'in_widget_form', array(&$this, &$return, $instance) );
-               }
-               return $return;
-       }
-
-       /** Helper function: Registers a single instance. */
-       function _register_one($number = -1) {
-               wp_register_sidebar_widget(     $this->id, $this->name, $this->_get_display_callback(), $this->widget_options, array( 'number' => $number ) );
-               _register_widget_update_callback( $this->id_base, $this->_get_update_callback(), $this->control_options, array( 'number' => -1 ) );
-               _register_widget_form_callback( $this->id, $this->name, $this->_get_form_callback(), $this->control_options, array( 'number' => $number ) );
-       }
-
-       function save_settings($settings) {
-               $settings['_multiwidget'] = 1;
-               update_option( $this->option_name, $settings );
-       }
-
-       function get_settings() {
-               $settings = get_option($this->option_name);
-
-               if ( false === $settings && isset($this->alt_option_name) )
-                       $settings = get_option($this->alt_option_name);
-
-               if ( !is_array($settings) )
-                       $settings = array();
-
-               if ( !empty($settings) && !array_key_exists('_multiwidget', $settings) ) {
-                       // old format, convert if single widget
-                       $settings = wp_convert_widget_settings($this->id_base, $this->option_name, $settings);
-               }
-
-               unset($settings['_multiwidget'], $settings['__i__']);
-               return $settings;
-       }
-}
-
-/**
- * Singleton that registers and instantiates WP_Widget classes.
+ * @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
- * @since 2.8
+ * @since 2.2.0
  */
-class WP_Widget_Factory {
-       var $widgets = array();
-
-       function WP_Widget_Factory() {
-               add_action( 'widgets_init', array( &$this, '_register_widgets' ), 100 );
-       }
-
-       function register($widget_class) {
-               $this->widgets[$widget_class] = new $widget_class();
-       }
 
-       function unregister($widget_class) {
-               if ( isset($this->widgets[$widget_class]) )
-                       unset($this->widgets[$widget_class]);
-       }
-
-       function _register_widgets() {
-               global $wp_registered_widgets;
-               $keys = array_keys($this->widgets);
-               $registered = array_keys($wp_registered_widgets);
-               $registered = array_map('_get_widget_id_base', $registered);
-
-               foreach ( $keys as $key ) {
-                       // don't register new widget if old widget with the same id is already registered
-                       if ( in_array($this->widgets[$key]->id_base, $registered, true) ) {
-                               unset($this->widgets[$key]);
-                               continue;
-                       }
-
-                       $this->widgets[$key]->_register();
-               }
-       }
-}
-
-/* Global Variables */
+//
+// Global Variables
+//
 
 /** @ignore */
 global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
@@ -375,18 +48,25 @@ $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',
+$GLOBALS['_wp_deprecated_widgets_callbacks'] = array(
+       'wp_widget_pages',
        'wp_widget_pages_control',
        'wp_widget_calendar',
        'wp_widget_calendar_control',
@@ -408,9 +88,11 @@ $_wp_sidebars_widgets = array();
        'wp_widget_rss_control',
        'wp_widget_recent_comments',
        'wp_widget_recent_comments_control'
- );
+);
 
-/* Template tags & API functions */
+//
+// Template tags & API functions
+//
 
 /**
  * Register a widget
@@ -420,8 +102,8 @@ $_wp_sidebars_widgets = array();
  * @since 2.8.0
  *
  * @see WP_Widget
- * @see WP_Widget_Factory
- * @uses WP_Widget_Factory
+ *
+ * @global WP_Widget_Factory $wp_widget_factory
  *
  * @param string $widget_class The name of a class that extends WP_Widget
  */
@@ -440,8 +122,8 @@ function register_widget($widget_class) {
  * @since 2.8.0
  *
  * @see WP_Widget
- * @see WP_Widget_Factory
- * @uses WP_Widget_Factory
+ *
+ * @global WP_Widget_Factory $wp_widget_factory
  *
  * @param string $widget_class The name of a class that extends WP_Widget
  */
@@ -456,25 +138,28 @@ 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. If the id is provided, and multiple
- * sidebars are being defined, the id will have "-2" appended, and so on.
+ * '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;
 
@@ -494,13 +179,14 @@ function register_sidebars($number = 1, $args = array()) {
                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']]) )
+                       while ( is_registered_sidebar( $_args['id'] ) ) {
                                $_args['id'] = $args['id'] . '-' . $n++;
+                       }
                } else {
-                       $n = count($wp_registered_sidebars);
+                       $n = count( $wp_registered_sidebars );
                        do {
                                $_args['id'] = 'sidebar-' . ++$n;
-                       } while ( isset($wp_registered_sidebars[$_args['id']]) );
+                       } while ( is_registered_sidebar( $_args['id'] ) );
                }
                register_sidebar($_args);
        }
@@ -509,40 +195,51 @@ 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 <code>'name=whatever;id=whatever1'</code> and for
- * the array it would be <code>array(
- *    'name' => 'whatever',
- *    'id' => 'whatever1')</code>.
- *
- * 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.
- *
- * <em>Content</em> 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.
  *
- * @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;
 
        $i = count($wp_registered_sidebars) + 1;
 
+       $id_is_empty = empty( $args['id'] );
+
        $defaults = array(
                'name' => sprintf(__('Sidebar %d'), $i ),
                'id' => "sidebar-$i",
@@ -556,10 +253,22 @@ function register_sidebar($args = array()) {
 
        $sidebar = wp_parse_args( $args, $defaults );
 
+       if ( $id_is_empty ) {
+               /* translators: 1: the id argument, 2: sidebar name, 3: recommended id value */
+               _doing_it_wrong( __FUNCTION__, sprintf( __( 'No %1$s was set in the arguments array for the "%2$s" sidebar. Defaulting to "%3$s". Manually set the %1$s to "%3$s" to silence this notice and keep existing sidebar content.' ), '<code>id</code>', $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'];
@@ -570,38 +279,60 @@ 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] );
+       unset( $wp_registered_sidebars[ $name ] );
 }
 
 /**
- * Register widget for use in sidebars.
+ * Checks if a sidebar is registered.
+ *
+ * @since 4.4.0
  *
- * The default widget option is 'classname' that can be override.
+ * @global array $wp_registered_sidebars Registered sidebars.
  *
- * The function can also be used to unregister widgets when $output_callback
+ * @param string|int $sidebar_id The ID of the sidebar when it was registered.
+ * @return bool True if the sidebar is registered, false otherwise.
+ */
+function is_registered_sidebar( $sidebar_id ) {
+       global $wp_registered_sidebars;
+
+       return isset( $wp_registered_sidebars[ $sidebar_id ] );
+}
+
+/**
+ * Register an instance of a widget.
+ *
+ * The default widget option is 'classname' that can be overridden.
+ *
+ * The function can also be used to un-register widgets when `$output_callback`
  * parameter is an empty string.
  *
  * @since 2.2.0
  *
- * @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 $options Optional. Widget Options.
- * @param mixed $params,... Widget parameters to add to widget.
- * @return null Will return if $output_callback is empty after removing widget.
+ * @global array $wp_registered_widgets       Uses stored registered widgets.
+ * @global array $wp_register_widget_defaults Retrieves widget defaults.
+ * @global array $wp_registered_widget_updates
+ * @global array $_wp_deprecated_widgets_callbacks
+ *
+ * @param int|string $id              Widget ID.
+ * @param string     $name            Widget display title.
+ * @param callable   $output_callback Run when widget is called.
+ * @param array      $options {
+ *     Optional. An array of supplementary widget options for the instance.
+ *
+ *     @type string $classname   Class name for the widget's HTML container. Default is a shortened
+ *                               version of the output callback name.
+ *     @type string $description Widget description for display in the widget administration
+ *                               panel and/or theme.
+ * }
  */
-function wp_register_sidebar_widget($id, $name, $output_callback, $options = array()) {
+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);
@@ -613,12 +344,8 @@ function wp_register_sidebar_widget($id, $name, $output_callback, $options = arr
 
        $id_base = _get_widget_id_base($id);
        if ( in_array($output_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($output_callback) ) {
-               if ( isset($wp_registered_widget_controls[$id]) )
-                       unset($wp_registered_widget_controls[$id]);
-
-               if ( isset($wp_registered_widget_updates[$id_base]) )
-                       unset($wp_registered_widget_updates[$id_base]);
-
+               unset( $wp_registered_widget_controls[ $id ] );
+               unset( $wp_registered_widget_updates[ $id_base ] );
                return;
        }
 
@@ -633,6 +360,14 @@ 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' ) ) ) {
+
+               /**
+                * 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;
        }
@@ -647,8 +382,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) )
@@ -668,8 +405,10 @@ function wp_widget_description( $id ) {
  *
  * @since 2.9.0
  *
- * @param int|string $id sidebar ID.
- * @return string Sidebar description, if available. Null on failure to retrieve description.
+ * @global array $wp_registered_sidebars
+ *
+ * @param string $id sidebar ID.
+ * @return string|void Sidebar description, if available.
  */
 function wp_sidebar_description( $id ) {
        if ( !is_scalar($id) )
@@ -689,6 +428,14 @@ 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, '', '');
@@ -703,17 +450,24 @@ 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?
+ *
+ * @global array $wp_registered_widget_controls
+ * @global array $wp_registered_widget_updates
+ * @global array $wp_registered_widgets
+ * @global array $_wp_deprecated_widgets_callbacks
+ *
+ * @param int|string   $id               Sidebar ID.
+ * @param string       $name             Sidebar display name.
+ * @param callable     $control_callback Run when sidebar is displayed.
+ * @param array|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);
@@ -726,9 +480,7 @@ function wp_register_widget_control($id, $name, $control_callback, $options = ar
        }
 
        if ( in_array($control_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($control_callback) ) {
-               if ( isset($wp_registered_widgets[$id]) )
-                       unset($wp_registered_widgets[$id]);
-
+               unset( $wp_registered_widgets[ $id ] );
                return;
        }
 
@@ -760,6 +512,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;
 
@@ -778,6 +537,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
+ */
 function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {
        global $wp_registered_widget_controls;
 
@@ -811,42 +579,37 @@ 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.
  */
 function wp_unregister_widget_control($id) {
-       return wp_register_widget_control($id, '', '');
+       wp_register_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.
+ * @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) {
+function dynamic_sidebar( $index = 1 ) {
        global $wp_registered_sidebars, $wp_registered_widgets;
 
-       if ( is_int($index) ) {
+       if ( is_int( $index ) ) {
                $index = "sidebar-$index";
        } else {
-               $index = sanitize_title($index);
+               $index = sanitize_title( $index );
                foreach ( (array) $wp_registered_sidebars as $key => $value ) {
-                       if ( sanitize_title($value['name']) == $index ) {
+                       if ( sanitize_title( $value['name'] ) == $index ) {
                                $index = $key;
                                break;
                        }
@@ -854,12 +617,28 @@ function dynamic_sidebar($index = 1) {
        }
 
        $sidebars_widgets = wp_get_sidebars_widgets();
-       if ( empty( $sidebars_widgets ) )
-               return false;
-
-       if ( empty($wp_registered_sidebars[$index]) || !array_key_exists($index, $sidebars_widgets) || !is_array($sidebars_widgets[$index]) || empty($sidebars_widgets[$index]) )
-               return false;
+       if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) {
+               /** This action is documented in wp-includes/widget.php */
+               do_action( 'dynamic_sidebar_before', $index, false );
+               /** This action is documented in wp-includes/widget.php */
+               do_action( 'dynamic_sidebar_after',  $index, false );
+               /** This filter is documented in wp-includes/widget.php */
+               return apply_filters( 'dynamic_sidebar_has_widgets', false, $index );
+       }
 
+       /**
+        * 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;
@@ -883,11 +662,68 @@ 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'];
 
-               do_action( 'dynamic_sidebar', $wp_registered_widgets[$id] );
+               /**
+                * Fires before a widget's display callback is called.
+                *
+                * Note: The action fires on both the front-end and back-end, including
+                * for widgets in the Inactive Widgets sidebar on the Widgets screen.
+                *
+                * The action is not fired for empty sidebars.
+                *
+                * @since 3.0.0
+                *
+                * @param array $widget_id {
+                *     An associative array of widget arguments.
+                *
+                *     @type string $name                Name of the widget.
+                *     @type string $id                  Widget ID.
+                *     @type array|callable $callback    When the hook is fired on the front-end, $callback is an array
+                *                                       containing the widget object. Fired on the back-end, $callback
+                *                                       is 'wp_widget_control', see $_callback.
+                *     @type array          $params      An associative array of multi-widget arguments.
+                *     @type string         $classname   CSS class applied to the widget container.
+                *     @type string         $description The widget description.
+                *     @type array          $_callback   When the hook is fired on the back-end, $_callback is populated
+                *                                       with an array containing the widget object, see $callback.
+                * }
+                */
+               do_action( 'dynamic_sidebar', $wp_registered_widgets[ $id ] );
 
                if ( is_callable($callback) ) {
                        call_user_func_array($callback, $params);
@@ -895,7 +731,33 @@ function dynamic_sidebar($index = 1) {
                }
        }
 
-       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 );
 }
 
 /**
@@ -913,11 +775,13 @@ function dynamic_sidebar($index = 1) {
  *
  * @since 2.2.0
  *
- * @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 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 = false, $widget_id = false, $id_base = false, $skip_inactive = true) {
        global $wp_registered_widgets;
@@ -926,8 +790,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 ) {
@@ -947,6 +812,9 @@ function is_active_widget($callback = false, $widget_id = false, $id_base = fals
  *
  * @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() {
@@ -965,24 +833,34 @@ 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 ( !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 */
+//
+// 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.
@@ -990,14 +868,17 @@ function is_active_sidebar( $index ) {
  * @since 2.2.0
  * @access private
  *
- * @param bool $deprecated Not used (deprecated).
+ * @global array $_wp_sidebars_widgets
+ * @global array $sidebars_widgets
+ *
+ * @param bool $deprecated Not used (argument deprecated).
  * @return array Upgraded list of widgets to version 3 array format when called from the admin.
  */
-function wp_get_sidebars_widgets($deprecated = true) {
+function wp_get_sidebars_widgets( $deprecated = true ) {
        if ( $deprecated !== true )
                _deprecated_argument( __FUNCTION__, '2.8.1' );
 
-       global $wp_registered_widgets, $_wp_sidebars_widgets, $sidebars_widgets;
+       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.
@@ -1013,8 +894,14 @@ function wp_get_sidebars_widgets($deprecated = true) {
        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 );
 }
 
 /**
@@ -1037,6 +924,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() {
@@ -1055,6 +944,11 @@ function wp_get_widget_defaults() {
  *
  * @since 2.8.0
  *
+ * @global array $_wp_sidebars_widgets
+ *
+ * @param string $base_name
+ * @param string $option_name
+ * @param array  $settings
  * @return array
  */
 function wp_convert_widget_settings($base_name, $option_name, $settings) {
@@ -1109,28 +1003,55 @@ function wp_convert_widget_settings($base_name, $option_name, $settings) {
 }
 
 /**
- * Output an arbitrary widget as a template tag
+ * Output an arbitrary widget as a template tag.
  *
- * @since 2.8
+ * @since 2.8.0
  *
- * @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 $wp_widget_factory
+ *
+ * @param string $widget   The widget's PHP class name (see class-wp-widget.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 `<div class="widget %s">`, 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 `</div>`.
+ *     @type string $before_title  HTML content that will be prepended to the widget's title when displayed.
+ *                                 Default `<h2 class="widgettitle">`.
+ *     @type string $after_title   HTML content that will be appended to the widget's title when displayed.
+ *                                 Default `</h2>`.
+ * }
+ */
+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') )
+       if ( ! ( $widget_obj instanceof WP_Widget ) ) {
                return;
+       }
 
-       $before_widget = sprintf('<div class="widget %s">', $widget_obj->widget_options['classname'] );
-       $default_args = array( 'before_widget' => $before_widget, 'after_widget' => "</div>", 'before_title' => '<h2 class="widgettitle">', 'after_title' => '</h2>' );
+       $default_args = array(
+               'before_widget' => '<div class="widget %s">',
+               'after_widget'  => "</div>",
+               'before_title'  => '<h2 class="widgettitle">',
+               'after_title'   => '</h2>',
+       );
+       $args = wp_parse_args( $args, $default_args );
+       $args['before_widget'] = sprintf( $args['before_widget'], $widget_obj->widget_options['classname'] );
 
-       $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);
@@ -1139,6 +1060,8 @@ function the_widget($widget, $instance = array(), $args = array()) {
 
 /**
  * Private
+ *
+ * @return string
  */
 function _get_widget_id_base($id) {
        return preg_replace( '/-[0-9]+$/', '', $id );
@@ -1149,6 +1072,8 @@ function _get_widget_id_base($id) {
  *
  * @access private
  * @since 3.3.0
+ *
+ * @global array $sidebars_widgets
  */
 function _wp_sidebars_changed() {
        global $sidebars_widgets;
@@ -1159,9 +1084,21 @@ function _wp_sidebars_changed() {
        retrieve_widgets(true);
 }
 
-// look for "lost" widgets, this has to run at least on each theme change
-function retrieve_widgets($theme_changed = false) {
-       global $wp_registered_widget_updates, $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;
+/**
+ * Look for "lost" widgets, this has to run at least on each theme change.
+ *
+ * @since 2.8.0
+ *
+ * @global array $wp_registered_sidebars
+ * @global array $sidebars_widgets
+ * @global array $wp_registered_widgets
+ *
+ * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value
+ *                                   of 'customize' defers updates for the Customizer.
+ * @return array|void
+ */
+function retrieve_widgets( $theme_changed = false ) {
+       global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;
 
        $registered_sidebar_keys = array_keys( $wp_registered_sidebars );
        $orphaned = 0;
@@ -1170,11 +1107,15 @@ function retrieve_widgets($theme_changed = false) {
        if ( is_array( $old_sidebars_widgets ) ) {
                // time() that sidebars were stored is in $old_sidebars_widgets['time']
                $_sidebars_widgets = $old_sidebars_widgets['data'];
-               remove_theme_mod( 'sidebars_widgets' );
+
+               if ( 'customize' !== $theme_changed ) {
+                       remove_theme_mod( 'sidebars_widgets' );
+               }
 
                foreach ( $_sidebars_widgets as $sidebar => $widgets ) {
-                       if ( 'wp_inactive_widgets' == $sidebar || 'orphaned_widgets' == substr( $sidebar, 0, 16 ) )
+                       if ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
                                continue;
+                       }
 
                        if ( !in_array( $sidebar, $registered_sidebar_keys ) ) {
                                $_sidebars_widgets['orphaned_widgets_' . ++$orphaned] = $widgets;
@@ -1253,7 +1194,271 @@ function retrieve_widgets($theme_changed = false) {
        }
 
        $sidebars_widgets['wp_inactive_widgets'] = array_merge($lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets']);
-       wp_set_sidebars_widgets($sidebars_widgets);
+       if ( 'customize' !== $theme_changed ) {
+               wp_set_sidebars_widgets( $sidebars_widgets );
+       }
 
        return $sidebars_widgets;
 }
+
+/**
+ * Display the RSS entries in a list.
+ *
+ * @since 2.5.0
+ *
+ * @param string|array|object $rss RSS url.
+ * @param array $args Widget arguments.
+ */
+function wp_widget_rss_output( $rss, $args = array() ) {
+       if ( is_string( $rss ) ) {
+               $rss = fetch_feed($rss);
+       } elseif ( is_array($rss) && isset($rss['url']) ) {
+               $args = $rss;
+               $rss = fetch_feed($rss['url']);
+       } elseif ( !is_object($rss) ) {
+               return;
+       }
+
+       if ( is_wp_error($rss) ) {
+               if ( is_admin() || current_user_can('manage_options') )
+                       echo '<p>' . sprintf( __('<strong>RSS Error</strong>: %s'), $rss->get_error_message() ) . '</p>';
+               return;
+       }
+
+       $default_args = array( 'show_author' => 0, 'show_date' => 0, 'show_summary' => 0, 'items' => 0 );
+       $args = wp_parse_args( $args, $default_args );
+
+       $items = (int) $args['items'];
+       if ( $items < 1 || 20 < $items )
+               $items = 10;
+       $show_summary  = (int) $args['show_summary'];
+       $show_author   = (int) $args['show_author'];
+       $show_date     = (int) $args['show_date'];
+
+       if ( !$rss->get_item_quantity() ) {
+               echo '<ul><li>' . __( 'An error has occurred, which probably means the feed is down. Try again later.' ) . '</li></ul>';
+               $rss->__destruct();
+               unset($rss);
+               return;
+       }
+
+       echo '<ul>';
+       foreach ( $rss->get_items( 0, $items ) as $item ) {
+               $link = $item->get_link();
+               while ( stristr( $link, 'http' ) != $link ) {
+                       $link = substr( $link, 1 );
+               }
+               $link = esc_url( strip_tags( $link ) );
+
+               $title = esc_html( trim( strip_tags( $item->get_title() ) ) );
+               if ( empty( $title ) ) {
+                       $title = __( 'Untitled' );
+               }
+
+               $desc = @html_entity_decode( $item->get_description(), ENT_QUOTES, get_option( 'blog_charset' ) );
+               $desc = esc_attr( wp_trim_words( $desc, 55, ' [&hellip;]' ) );
+
+               $summary = '';
+               if ( $show_summary ) {
+                       $summary = $desc;
+
+                       // Change existing [...] to [&hellip;].
+                       if ( '[...]' == substr( $summary, -5 ) ) {
+                               $summary = substr( $summary, 0, -5 ) . '[&hellip;]';
+                       }
+
+                       $summary = '<div class="rssSummary">' . esc_html( $summary ) . '</div>';
+               }
+
+               $date = '';
+               if ( $show_date ) {
+                       $date = $item->get_date( 'U' );
+
+                       if ( $date ) {
+                               $date = ' <span class="rss-date">' . date_i18n( get_option( 'date_format' ), $date ) . '</span>';
+                       }
+               }
+
+               $author = '';
+               if ( $show_author ) {
+                       $author = $item->get_author();
+                       if ( is_object($author) ) {
+                               $author = $author->get_name();
+                               $author = ' <cite>' . esc_html( strip_tags( $author ) ) . '</cite>';
+                       }
+               }
+
+               if ( $link == '' ) {
+                       echo "<li>$title{$date}{$summary}{$author}</li>";
+               } elseif ( $show_summary ) {
+                       echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$summary}{$author}</li>";
+               } else {
+                       echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$author}</li>";
+               }
+       }
+       echo '</ul>';
+       $rss->__destruct();
+       unset($rss);
+}
+
+/**
+ * Display RSS widget options form.
+ *
+ * The options for what fields are displayed for the RSS form are all booleans
+ * and are as follows: 'url', 'title', 'items', 'show_summary', 'show_author',
+ * 'show_date'.
+ *
+ * @since 2.5.0
+ *
+ * @param array|string $args Values for input fields.
+ * @param array $inputs Override default display options.
+ */
+function wp_widget_rss_form( $args, $inputs = null ) {
+       $default_inputs = array( 'url' => true, 'title' => true, 'items' => true, 'show_summary' => true, 'show_author' => true, 'show_date' => true );
+       $inputs = wp_parse_args( $inputs, $default_inputs );
+
+       $args['title'] = isset( $args['title'] ) ? $args['title'] : '';
+       $args['url'] = isset( $args['url'] ) ? $args['url'] : '';
+       $args['items'] = isset( $args['items'] ) ? (int) $args['items'] : 0;
+
+       if ( $args['items'] < 1 || 20 < $args['items'] ) {
+               $args['items'] = 10;
+       }
+
+       $args['show_summary']   = isset( $args['show_summary'] ) ? (int) $args['show_summary'] : (int) $inputs['show_summary'];
+       $args['show_author']    = isset( $args['show_author'] ) ? (int) $args['show_author'] : (int) $inputs['show_author'];
+       $args['show_date']      = isset( $args['show_date'] ) ? (int) $args['show_date'] : (int) $inputs['show_date'];
+
+       if ( ! empty( $args['error'] ) ) {
+               echo '<p class="widget-error"><strong>' . sprintf( __( 'RSS Error: %s' ), $args['error'] ) . '</strong></p>';
+       }
+
+       $esc_number = esc_attr( $args['number'] );
+       if ( $inputs['url'] ) :
+?>
+       <p><label for="rss-url-<?php echo $esc_number; ?>"><?php _e( 'Enter the RSS feed URL here:' ); ?></label>
+       <input class="widefat" id="rss-url-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][url]" type="text" value="<?php echo esc_url( $args['url'] ); ?>" /></p>
+<?php endif; if ( $inputs['title'] ) : ?>
+       <p><label for="rss-title-<?php echo $esc_number; ?>"><?php _e( 'Give the feed a title (optional):' ); ?></label>
+       <input class="widefat" id="rss-title-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][title]" type="text" value="<?php echo esc_attr( $args['title'] ); ?>" /></p>
+<?php endif; if ( $inputs['items'] ) : ?>
+       <p><label for="rss-items-<?php echo $esc_number; ?>"><?php _e( 'How many items would you like to display?' ); ?></label>
+       <select id="rss-items-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][items]">
+       <?php
+       for ( $i = 1; $i <= 20; ++$i ) {
+               echo "<option value='$i' " . selected( $args['items'], $i, false ) . ">$i</option>";
+       }
+       ?>
+       </select></p>
+<?php endif; if ( $inputs['show_summary'] ) : ?>
+       <p><input id="rss-show-summary-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_summary]" type="checkbox" value="1" <?php checked( $args['show_summary'] ); ?> />
+       <label for="rss-show-summary-<?php echo $esc_number; ?>"><?php _e( 'Display item content?' ); ?></label></p>
+<?php endif; if ( $inputs['show_author'] ) : ?>
+       <p><input id="rss-show-author-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_author]" type="checkbox" value="1" <?php checked( $args['show_author'] ); ?> />
+       <label for="rss-show-author-<?php echo $esc_number; ?>"><?php _e( 'Display item author if available?' ); ?></label></p>
+<?php endif; if ( $inputs['show_date'] ) : ?>
+       <p><input id="rss-show-date-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_date]" type="checkbox" value="1" <?php checked( $args['show_date'] ); ?>/>
+       <label for="rss-show-date-<?php echo $esc_number; ?>"><?php _e( 'Display item date?' ); ?></label></p>
+<?php
+       endif;
+       foreach ( array_keys($default_inputs) as $input ) :
+               if ( 'hidden' === $inputs[$input] ) :
+                       $id = str_replace( '_', '-', $input );
+?>
+       <input type="hidden" id="rss-<?php echo esc_attr( $id ); ?>-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][<?php echo esc_attr( $input ); ?>]" value="<?php echo esc_attr( $args[ $input ] ); ?>" />
+<?php
+               endif;
+       endforeach;
+}
+
+/**
+ * Process RSS feed widget data and optionally retrieve feed items.
+ *
+ * The feed widget can not have more than 20 items or it will reset back to the
+ * default, which is 10.
+ *
+ * The resulting array has the feed title, feed url, feed link (from channel),
+ * feed items, error (if any), and whether to show summary, author, and date.
+ * All respectively in the order of the array elements.
+ *
+ * @since 2.5.0
+ *
+ * @param array $widget_rss RSS widget feed data. Expects unescaped data.
+ * @param bool $check_feed Optional, default is true. Whether to check feed for errors.
+ * @return array
+ */
+function wp_widget_rss_process( $widget_rss, $check_feed = true ) {
+       $items = (int) $widget_rss['items'];
+       if ( $items < 1 || 20 < $items )
+               $items = 10;
+       $url           = esc_url_raw( strip_tags( $widget_rss['url'] ) );
+       $title         = isset( $widget_rss['title'] ) ? trim( strip_tags( $widget_rss['title'] ) ) : '';
+       $show_summary  = isset( $widget_rss['show_summary'] ) ? (int) $widget_rss['show_summary'] : 0;
+       $show_author   = isset( $widget_rss['show_author'] ) ? (int) $widget_rss['show_author'] :0;
+       $show_date     = isset( $widget_rss['show_date'] ) ? (int) $widget_rss['show_date'] : 0;
+
+       if ( $check_feed ) {
+               $rss = fetch_feed($url);
+               $error = false;
+               $link = '';
+               if ( is_wp_error($rss) ) {
+                       $error = $rss->get_error_message();
+               } else {
+                       $link = esc_url(strip_tags($rss->get_permalink()));
+                       while ( stristr($link, 'http') != $link )
+                               $link = substr($link, 1);
+
+                       $rss->__destruct();
+                       unset($rss);
+               }
+       }
+
+       return compact( 'title', 'url', 'link', 'items', 'error', 'show_summary', 'show_author', 'show_date' );
+}
+
+/**
+ * Register all of the default WordPress widgets on startup.
+ *
+ * Calls 'widgets_init' action after all of the WordPress widgets have been
+ * registered.
+ *
+ * @since 2.2.0
+ */
+function wp_widgets_init() {
+       if ( !is_blog_installed() )
+               return;
+
+       register_widget('WP_Widget_Pages');
+
+       register_widget('WP_Widget_Calendar');
+
+       register_widget('WP_Widget_Archives');
+
+       if ( get_option( 'link_manager_enabled' ) )
+               register_widget('WP_Widget_Links');
+
+       register_widget('WP_Widget_Meta');
+
+       register_widget('WP_Widget_Search');
+
+       register_widget('WP_Widget_Text');
+
+       register_widget('WP_Widget_Categories');
+
+       register_widget('WP_Widget_Recent_Posts');
+
+       register_widget('WP_Widget_Recent_Comments');
+
+       register_widget('WP_Widget_RSS');
+
+       register_widget('WP_Widget_Tag_Cloud');
+
+       register_widget('WP_Nav_Menu_Widget');
+
+       /**
+        * Fires after all default WordPress widgets have been registered.
+        *
+        * @since 2.2.0
+        */
+       do_action( 'widgets_init' );
+}