X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..0f684a09c03e547d3132bddc970cbeafcd1102f4:/wp-includes/widgets.php diff --git a/wp-includes/widgets.php b/wp-includes/widgets.php index 6bd99473..97c875e7 100644 --- a/wp-includes/widgets.php +++ b/wp-includes/widgets.php @@ -19,7 +19,7 @@ * * @package WordPress * @subpackage Widgets - * @since 2.8 + * @since 2.8.0 */ class WP_Widget { @@ -163,6 +163,21 @@ class WP_Widget { return array($this, 'form_callback'); } + /** + * Determine if we're in the Customizer; if true, 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 + * + * @return bool True if Customizer is on, false if not. + */ + function is_preview() { + global $wp_customize; + return ( isset( $wp_customize ) && $wp_customize->is_preview() ) ; + } + /** Generate the actual widget content. * Just finds the instance and calls widget(). * Do NOT over-ride this function. */ @@ -176,22 +191,47 @@ class WP_Widget { if ( array_key_exists( $this->number, $instance ) ) { $instance = $instance[$this->number]; - // filters the widget's settings, return false to stop displaying the widget - $instance = apply_filters('widget_display_callback', $instance, $this, $args); - if ( false !== $instance ) - $this->widget($args, $instance); + + /** + * Filter the settings for a particular widget instance. + * + * Returning false will effectively short-circuit display of the widget. + * + * @since 2.8.0 + * + * @param array $instance The current widget instance's settings. + * @param WP_Widget $this The current widget instance. + * @param array $args An array of default widget arguments. + */ + $instance = apply_filters( 'widget_display_callback', $instance, $this, $args ); + + if ( false === $instance ) { + return; + } + + $was_cache_addition_suspended = wp_suspend_cache_addition(); + if ( $this->is_preview() && ! $was_cache_addition_suspended ) { + wp_suspend_cache_addition( true ); + } + + $this->widget( $args, $instance ); + + if ( $this->is_preview() ) { + wp_suspend_cache_addition( $was_cache_addition_suspended ); + } } } - /** Deal with changed settings. - * Do NOT over-ride this function. */ - function update_callback( $widget_args = 1 ) { + /** + * Deal with changed settings. + * + * Do NOT over-ride this function. + * + * @param mixed $deprecated Not used. + */ + 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 @@ -229,12 +269,34 @@ class WP_Widget { $old_instance = isset($all_instances[$number]) ? $all_instances[$number] : array(); - $instance = $this->update($new_instance, $old_instance); + $was_cache_addition_suspended = wp_suspend_cache_addition(); + if ( $this->is_preview() && ! $was_cache_addition_suspended ) { + wp_suspend_cache_addition( true ); + } + + $instance = $this->update( $new_instance, $old_instance ); + + 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,8 +306,11 @@ class WP_Widget { $this->updated = true; } - /** Generate the control form. - * Do NOT over-ride this function. */ + /** + * 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 ); @@ -262,15 +327,39 @@ class WP_Widget { $instance = $all_instances[ $widget_args['number'] ]; } - // filters the widget admin form before displaying, return false to stop displaying it - $instance = apply_filters('widget_form_callback', $instance, $this); + /** + * Filter the widget instance's settings before displaying the control form. + * + * Returning false effectively short-circuits display of the control form. + * + * @since 2.8.0 + * + * @param array $instance The current widget instance's settings. + * @param WP_Widget $this The current widget instance. + */ + $instance = apply_filters( 'widget_form_callback', $instance, $this ); $return = null; if ( false !== $instance ) { $return = $this->form($instance); - // add extra fields in the widget form - be sure to set $return to null if you add any - // if the widget has no form the text echoed from the default form method can be hidden using css - do_action_ref_array( 'in_widget_form', array(&$this, &$return, $instance) ); + + /** + * Fires at the end of the widget control form. + * + * Use this hook to add extra fields to the widget form. The hook + * is only fired if the value passed to the 'widget_form_callback' + * hook is not false. + * + * Note: If the widget has no form, the text echoed from the default + * form method can be hidden using CSS. + * + * @since 2.8.0 + * + * @param WP_Widget $this The widget instance, passed by reference. + * @param null $return Return null if new fields are added. + * @param array $instance An array of the widget's settings. + */ + do_action_ref_array( 'in_widget_form', array( &$this, &$return, $instance ) ); } return $return; } @@ -311,7 +400,7 @@ class WP_Widget { * * @package WordPress * @subpackage Widgets - * @since 2.8 + * @since 2.8.0 */ class WP_Widget_Factory { var $widgets = array(); @@ -385,8 +474,8 @@ $_wp_sidebars_widgets = array(); /** * 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 +497,7 @@ $_wp_sidebars_widgets = array(); 'wp_widget_rss_control', 'wp_widget_recent_comments', 'wp_widget_recent_comments_control' - ); +); /* Template tags & API functions */ @@ -571,6 +660,13 @@ function register_sidebar($args = array()) { 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']; @@ -644,6 +740,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; } @@ -700,6 +804,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, '', ''); @@ -859,9 +971,27 @@ function dynamic_sidebar($index = 1) { $sidebars_widgets = wp_get_sidebars_widgets(); if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) { - 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 +1015,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|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 +1084,35 @@ function dynamic_sidebar($index = 1) { } } + /** + * 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; } @@ -967,7 +1183,7 @@ 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. * @return bool true if the sidebar is in use, false otherwise. @@ -976,7 +1192,17 @@ 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 */ @@ -1013,7 +1239,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); + /** + * 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; } @@ -1109,9 +1342,9 @@ 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 @@ -1131,6 +1364,15 @@ function the_widget($widget, $instance = array(), $args = array()) { $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 +1401,16 @@ 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) { +/** + * Look for "lost" widgets, this has to run at least on each theme change. + * + * @since 2.8.0 + * + * @param mixed $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,7 +1420,10 @@ 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 ) ) @@ -1253,7 +1506,9 @@ 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; }