--- a/wp/wp-includes/widgets.php Mon Jun 08 16:11:51 2015 +0000
+++ b/wp/wp-includes/widgets.php Tue Jun 09 03:35:32 2015 +0200
@@ -6,8 +6,8 @@
* This functionality was found in a plugin before WordPress 2.2 release which
* included it in the core from that point on.
*
- * @link http://codex.wordpress.org/Plugins/WordPress_Widgets WordPress Widgets
- * @link http://codex.wordpress.org/Plugins/WordPress_Widgets_Api Widgets API
+ * @link https://codex.wordpress.org/Plugins/WordPress_Widgets WordPress Widgets
+ * @link https://codex.wordpress.org/Plugins/WordPress_Widgets_Api Widgets API
*
* @package WordPress
* @subpackage Widgets
@@ -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;
- 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.
+ /**
+ * Option array passed to {@see wp_register_widget_control()}.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var array
+ */
+ public $control_options;
+
+ /**
+ * Unique ID number of the current instance.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var bool|int
+ */
+ public $number = false;
+
+ /**
+ * Unique ID string of the current instance (id_base-number).
+ *
+ * @since 2.8.0
+ * @access public
+ * @var bool|string
+ */
+ public $id = false;
+
+ /**
+ * Whether the widget data has been updated.
+ *
+ * Set to true when the data is updated after a POST submit - ensures it does
+ * not happen twice.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var bool
+ */
+ public $updated = false;
// Member functions that you must over-ride.
- /** Echo the widget content.
+ /**
+ * 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.
*
- * @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
+ * @since 2.8.0
+ * @access public
+ *
+ * @param array $new_instance New settings for this instance as input by the user via
+ * {@see WP_Widget::form()}.
+ * @param array $old_instance Old settings for this instance.
+ * @return array Settings to save or bool false to cancel saving.
*/
- 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 '<p class="no-options-widget">' . __('There are no options for this widget.') . '</p>';
return 'noform';
}
@@ -71,19 +143,20 @@
// Functions you'll need to call.
/**
- * PHP5 constructor
+ * PHP5 constructor.
+ *
+ * @since 2.8.0
+ * @access public
*
- * @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
+ * @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, $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;
@@ -93,8 +166,13 @@
/**
* PHP4 constructor
+ *
+ * @param string $id_base
+ * @param string $name
+ * @param array $widget_options
+ * @param array $control_options
*/
- function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) {
+ public function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) {
WP_Widget::__construct( $id_base, $name, $widget_options, $control_options );
}
@@ -106,25 +184,33 @@
* @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;
@@ -146,27 +232,68 @@
}
}
- 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() {
+ public function _get_display_callback() {
return array($this, 'display_callback');
}
- function _get_update_callback() {
+ public function _get_update_callback() {
return array($this, 'update_callback');
}
- function _get_form_callback() {
+ public 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 ) {
+ /**
+ * 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 (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 @@
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 @@
$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 );
+
+ if ( $this->is_preview() ) {
+ wp_suspend_cache_addition( $was_cache_addition_suspended );
+ }
- // 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 )
+ /**
+ * 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 @@
$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 @@
$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) )
@@ -311,25 +539,47 @@
*
* @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() {
+ public function WP_Widget_Factory() {
add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 );
}
- function register($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 @@
/**
* Private
*/
- $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,7 +658,7 @@
'wp_widget_rss_control',
'wp_widget_recent_comments',
'wp_widget_recent_comments_control'
- );
+);
/* Template tags & API functions */
@@ -456,25 +706,26 @@
*
* 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 Optional. Number of sidebars to create. Default 1.
+ * @param array|string $args {
+ * Optional. Array or string of arguments for building a sidebar.
*
- * @param int $number Number of sidebars to create.
- * @param string|array $args Builds Sidebar based off of 'name' and 'id' values.
+ * @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;
@@ -521,32 +772,30 @@
* If theme support for 'widgets' has not yet been added when this function is
* called, it will be automatically enabled through the use of add_theme_support()
*
- * Arguments passed as a string should be separated by '&':
- *
- * e.g. 'name=Sidebar&id=my_prefix_sidebar'
+ * @since 2.2.0
*
- * The same arguments passed as an array:
+ * @global array $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
*
- * array(
- * 'name' => 'Sidebar',
- * 'id' => 'my_prefix_sidebar',
- * )
+ * @param array|string $args {
+ * Optional. Array or string of arguments for the sidebar being registered.
*
- * Arguments:
- * name - The name or title of the sidebar displayed in the admin dashboard.
- * id - The unique identifier by which the sidebar will be called.
- * before_widget - HTML content that will be prepended to each widget's HTML output
- * when assigned to this sidebar.
- * after_widget - HTML content that will be appended to each widget's HTML output
- * when assigned to this sidebar.
- * before_title - HTML content that will be prepended to the sidebar title when displayed.
- * after_title - HTML content that will be appended to the sidebar title when displayed.
- *
- * @since 2.2.0
- * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
- * @uses add_theme_support() to ensure widget support has been added.
- *
- * @param string|array $args 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()) {
@@ -554,6 +803,8 @@
$i = count($wp_registered_sidebars) + 1;
+ $id_is_empty = empty( $args['id'] );
+
$defaults = array(
'name' => sprintf(__('Sidebar %d'), $i ),
'id' => "sidebar-$i",
@@ -567,10 +818,22 @@
$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'];
@@ -593,26 +856,32 @@
}
/**
- * 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.
+ * @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.
*
- * @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.
+ * @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);
@@ -644,6 +913,14 @@
$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;
}
@@ -679,7 +956,7 @@
*
* @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 ) {
@@ -700,6 +977,14 @@
* @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, '', '');
@@ -714,17 +999,19 @@
* 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);
@@ -771,6 +1058,13 @@
$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;
@@ -789,6 +1083,15 @@
$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;
@@ -822,7 +1125,6 @@
* 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.
*/
@@ -859,9 +1161,27 @@
$sidebars_widgets = wp_get_sidebars_widgets();
if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) {
- return false;
+ /** This action is documented in wp-includes/widgets.php */
+ do_action( 'dynamic_sidebar_before', $index, false );
+ /** This action is documented in wp-includes/widgets.php */
+ do_action( 'dynamic_sidebar_after', $index, false );
+ /** This filter is documented in wp-includes/widgets.php */
+ return apply_filters( 'dynamic_sidebar_has_widgets', false, $index );
}
+ /**
+ * Fires before widgets are rendered in a dynamic sidebar.
+ *
+ * Note: The action also fires for empty sidebars, and on both the front-end
+ * and back-end, including the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * @since 3.9.0
+ *
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ * @param bool $has_widgets Whether the sidebar is populated with widgets.
+ * Default true.
+ */
+ do_action( 'dynamic_sidebar_before', $index, true );
$sidebar = $wp_registered_sidebars[$index];
$did_one = false;
@@ -885,11 +1205,68 @@
$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|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);
@@ -897,6 +1274,35 @@
}
}
+ /**
+ * 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;
}
@@ -928,8 +1334,9 @@
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 ) {
@@ -967,22 +1374,32 @@
/**
* 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();
$is_active_sidebar = ! empty( $sidebars_widgets[$index] );
- return $is_active_sidebar;
+
+ /**
+ * 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.
@@ -990,10 +1407,10 @@
* @since 2.2.0
* @access private
*
- * @param bool $deprecated Not used (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) {
+function wp_get_sidebars_widgets( $deprecated = true ) {
if ( $deprecated !== true )
_deprecated_argument( __FUNCTION__, '2.8.1' );
@@ -1013,7 +1430,14 @@
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;
}
@@ -1055,6 +1479,9 @@
*
* @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) {
@@ -1109,21 +1536,32 @@
}
/**
- * Output an arbitrary widget as a template tag
+ * Output an arbitrary widget as a template tag.
+ *
+ * @since 2.8.0
*
- * @since 2.8
+ * @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.
*
- * @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()) {
+ * @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>' );
@@ -1131,6 +1569,15 @@
$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);
@@ -1159,8 +1606,16 @@
retrieve_widgets(true);
}
-// look for "lost" widgets, this has to run at least on each theme change
-function retrieve_widgets($theme_changed = false) {
+/**
+ * Look for "lost" widgets, this has to run at least on each theme change.
+ *
+ * @since 2.8.0
+ *
+ * @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 retrieve_widgets( $theme_changed = false ) {
global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;
$registered_sidebar_keys = array_keys( $wp_registered_sidebars );
@@ -1170,11 +1625,15 @@
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 +1712,9 @@
}
$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;
}