X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fef8173b8c3bad08f495551e43cfdeac1cae6021..refs/tags/wordpress-4.1.3-scripts:/wp-includes/widgets.php diff --git a/wp-includes/widgets.php b/wp-includes/widgets.php index 4c6d4f44..2e710ccb 100644 --- a/wp-includes/widgets.php +++ b/wp-includes/widgets.php @@ -19,51 +19,123 @@ * * @package WordPress * @subpackage Widgets - * @since 2.8 + * @since 2.8.0 */ class WP_Widget { - var $id_base; // Root id for all widgets of this type. - var $name; // Name for this widget type. - var $widget_options; // Option array passed to wp_register_sidebar_widget() - var $control_options; // Option array passed to wp_register_widget_control() + /** + * Root ID for all widgets of this type. + * + * @since 2.8.0 + * @access public + * @var mixed|string + */ + public $id_base; - 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. + /** + * Name for this widget type. + * + * @since 2.8.0 + * @access public + * @var string + */ + public $name; + + /** + * Option array passed to {@see wp_register_sidebar_widget()}. + * + * @since 2.8.0 + * @access public + * @var array + */ + public $widget_options; + + /** + * Option array passed to {@see wp_register_widget_control()}. + * + * @since 2.8.0 + * @access public + * @var array + */ + public $control_options; + + /** + * Unique ID number of the current instance. + * + * @since 2.8.0 + * @access public + * @var bool|int + */ + public $number = false; + + /** + * Unique ID string of the current instance (id_base-number). + * + * @since 2.8.0 + * @access public + * @var bool|string + */ + public $id = false; + + /** + * Whether the widget data has been updated. + * + * Set to true when the data is updated after a POST submit - ensures it does + * not happen twice. + * + * @since 2.8.0 + * @access public + * @var bool + */ + public $updated = false; // Member functions that you must over-ride. - /** Echo the widget content. + /** + * 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 '
'; return 'noform'; } @@ -71,26 +143,20 @@ class WP_Widget { // Functions you'll need to call. /** - * PHP4 constructor - */ - function WP_Widget( $id_base = false, $name, $widget_options = array(), $control_options = array() ) { - $this->__construct( $id_base, $name, $widget_options, $control_options ); - } - - /** - * PHP5 constructor - * - * @param string $id_base Optional Base ID for the widget, lower case, - * if left empty a portion of the widget's class name will be used. Has to be unique. - * @param string $name Name for the widget displayed on the configuration page. - * @param array $widget_options Optional Passed to wp_register_sidebar_widget() - * - description: shown on the configuration page - * - classname - * @param array $control_options Optional Passed to wp_register_widget_control() - * - width: required if more than 250px - * - height: currently not used but may be needed in the future + * PHP5 constructor. + * + * @since 2.8.0 + * @access public + * + * @param string $id_base Optional Base ID for the widget, lowercase and unique. If left empty, + * a portion of the widget's class name will be used Has to be unique. + * @param string $name Name for the widget displayed on the configuration page. + * @param array $widget_options Optional. Widget options. See {@see wp_register_sidebar_widget()} for + * information on accepted arguments. Default empty array. + * @param array $control_options Optional. Widget control options. See {@see wp_register_widget_control()} + * for information on accepted arguments. Default empty array. */ - function __construct( $id_base = false, $name, $widget_options = array(), $control_options = array() ) { + public function __construct( $id_base, $name, $widget_options = array(), $control_options = array() ) { $this->id_base = empty($id_base) ? preg_replace( '/(wp_)?widget_/', '', strtolower(get_class($this)) ) : strtolower($id_base); $this->name = $name; $this->option_name = 'widget_' . $this->id_base; @@ -98,6 +164,18 @@ class WP_Widget { $this->control_options = wp_parse_args( $control_options, array('id_base' => $this->id_base) ); } + /** + * PHP4 constructor + * + * @param string $id_base + * @param string $name + * @param array $widget_options + * @param array $control_options + */ + public function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) { + WP_Widget::__construct( $id_base, $name, $widget_options, $control_options ); + } + /** * Constructs name attributes for use in form() fields * @@ -106,25 +184,33 @@ class WP_Widget { * @param string $field_name Field name * @return string Name attribute for $field_name */ - function get_field_name($field_name) { + public function get_field_name($field_name) { return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']'; } /** - * Constructs id attributes for use in form() fields + * Constructs id attributes for use in {@see WP_Widget::form()} fields. * - * This function should be used in form() methods to create id attributes for fields to be saved by update() + * This function should be used in form() methods to create id attributes + * for fields to be saved by {@see WP_Widget::update()}. * - * @param string $field_name Field name - * @return string ID attribute for $field_name + * @since 2.8.0 + * @access public + * + * @param string $field_name Field name. + * @return string ID attribute for `$field_name`. */ - function get_field_id($field_name) { + public function get_field_id( $field_name ) { return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name; } - // Private Functions. Don't worry about these. - - function _register() { + /** + * Register all widget instances of this widget class. + * + * @since 2.8.0 + * @access private + */ + public function _register() { $settings = $this->get_settings(); $empty = true; @@ -139,34 +225,75 @@ class WP_Widget { } if ( $empty ) { - // If there are none, we register the widget's existance with a + // If there are none, we register the widget's existence with a // generic template $this->_set(1); $this->_register_one(); } } - function _set($number) { + /** + * Set the internal order number for the widget instance. + * + * @since 2.8.0 + * @access private + * + * @param int $number The unique order number of this widget instance compared to other + * instances of the same class. + */ + public function _set($number) { $this->number = $number; $this->id = $this->id_base . '-' . $number; } - function _get_display_callback() { - return array(&$this, 'display_callback'); + public function _get_display_callback() { + return array($this, 'display_callback'); + } + + public function _get_update_callback() { + return array($this, 'update_callback'); } - function _get_update_callback() { - return array(&$this, 'update_callback'); + public function _get_form_callback() { + return array($this, 'form_callback'); } - function _get_form_callback() { - return array(&$this, 'form_callback'); + /** + * Determine whether the current request is inside the Customizer preview. + * + * If true -- the current request is inside the Customizer preview, then + * the object cache gets suspended and widgets should check this to decide + * whether they should store anything persistently to the object cache, + * to transients, or anywhere else. + * + * @since 3.9.0 + * @access public + * + * @return bool True if within the Customizer preview, false if not. + */ + public function is_preview() { + global $wp_customize; + return ( isset( $wp_customize ) && $wp_customize->is_preview() ) ; } - /** Generate the actual widget content. - * Just finds the instance and calls widget(). - * Do NOT over-ride this function. */ - function display_callback( $args, $widget_args = 1 ) { + /** + * Generate the actual widget content (Do NOT override). + * + * Finds the instance and calls {@see WP_Widget::widget()}. + * + * @since 2.8.0 + * @access public + * + * @param array $args Display arguments. See {@see WP_Widget::widget()} for information + * on accepted arguments. + * @param int|array $widget_args { + * Optional. Internal order number of the widget instance, or array of multi-widget arguments. + * Default 1. + * + * @type int $number Number increment used for multiples of the same widget. + * } + */ + public function display_callback( $args, $widget_args = 1 ) { if ( is_numeric($widget_args) ) $widget_args = array( 'number' => $widget_args ); @@ -176,30 +303,54 @@ class WP_Widget { if ( array_key_exists( $this->number, $instance ) ) { $instance = $instance[$this->number]; - // filters the widget's settings, return false to stop displaying the widget - $instance = apply_filters('widget_display_callback', $instance, $this, $args); - if ( false !== $instance ) - $this->widget($args, $instance); + + /** + * Filter the settings for a particular widget instance. + * + * Returning false will effectively short-circuit display of the widget. + * + * @since 2.8.0 + * + * @param array $instance The current widget instance's settings. + * @param WP_Widget $this The current widget instance. + * @param array $args An array of default widget arguments. + */ + $instance = apply_filters( 'widget_display_callback', $instance, $this, $args ); + + if ( false === $instance ) { + return; + } + + $was_cache_addition_suspended = wp_suspend_cache_addition(); + if ( $this->is_preview() && ! $was_cache_addition_suspended ) { + wp_suspend_cache_addition( true ); + } + + $this->widget( $args, $instance ); + + if ( $this->is_preview() ) { + wp_suspend_cache_addition( $was_cache_addition_suspended ); + } } } - /** Deal with changed settings. - * Do NOT over-ride this function. */ - function update_callback( $widget_args = 1 ) { + /** + * Deal with changed settings (Do NOT override). + * + * @since 2.8.0 + * @access public + * + * @param int $deprecated Not used. + */ + public function update_callback( $deprecated = 1 ) { global $wp_registered_widgets; - if ( is_numeric($widget_args) ) - $widget_args = array( 'number' => $widget_args ); - - $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); $all_instances = $this->get_settings(); // We need to update the data if ( $this->updated ) return; - $sidebars_widgets = wp_get_sidebars_widgets(); - if ( isset($_POST['delete_widget']) && $_POST['delete_widget'] ) { // Delete the settings for this instance of the widget if ( isset($_POST['the-widget-id']) ) @@ -229,12 +380,34 @@ class WP_Widget { $old_instance = isset($all_instances[$number]) ? $all_instances[$number] : array(); - $instance = $this->update($new_instance, $old_instance); + $was_cache_addition_suspended = wp_suspend_cache_addition(); + if ( $this->is_preview() && ! $was_cache_addition_suspended ) { + wp_suspend_cache_addition( true ); + } + + $instance = $this->update( $new_instance, $old_instance ); + + 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 @@ class WP_Widget { $this->updated = true; } - /** Generate the control form. - * Do NOT over-ride this function. */ - function form_callback( $widget_args = 1 ) { + /** + * Generate the widget control form (Do NOT override). + * + * @since 2.8.0 + * @access public + * + * @param int|array $widget_args Widget instance number or array of widget arguments. + */ + public function form_callback( $widget_args = 1 ) { if ( is_numeric($widget_args) ) $widget_args = array( 'number' => $widget_args ); @@ -262,32 +441,81 @@ class WP_Widget { $instance = $all_instances[ $widget_args['number'] ]; } - // filters the widget admin form before displaying, return false to stop displaying it - $instance = apply_filters('widget_form_callback', $instance, $this); + /** + * Filter the widget instance's settings before displaying the control form. + * + * Returning false effectively short-circuits display of the control form. + * + * @since 2.8.0 + * + * @param array $instance The current widget instance's settings. + * @param WP_Widget $this The current widget instance. + */ + $instance = apply_filters( 'widget_form_callback', $instance, $this ); $return = null; if ( false !== $instance ) { $return = $this->form($instance); - // add extra fields in the widget form - be sure to set $return to null if you add any - // if the widget has no form the text echoed from the default form method can be hidden using css - do_action_ref_array( 'in_widget_form', array(&$this, &$return, $instance) ); + + /** + * Fires at the end of the widget control form. + * + * Use this hook to add extra fields to the widget form. The hook + * is only fired if the value passed to the 'widget_form_callback' + * hook is not false. + * + * Note: If the widget has no form, the text echoed from the default + * form method can be hidden using CSS. + * + * @since 2.8.0 + * + * @param WP_Widget $this The widget instance, passed by reference. + * @param null $return Return null if new fields are added. + * @param array $instance An array of the widget's settings. + */ + do_action_ref_array( 'in_widget_form', array( &$this, &$return, $instance ) ); } return $return; } - /** Helper function: Registers a single instance. */ - function _register_one($number = -1) { + /** + * Register an instance of the widget class. + * + * @since 2.8.0 + * @access private + * + * @param integer $number Optional. The unique order number of this widget instance + * compared to other instances of the same class. Default -1. + */ + public function _register_one( $number = -1 ) { wp_register_sidebar_widget( $this->id, $this->name, $this->_get_display_callback(), $this->widget_options, array( 'number' => $number ) ); _register_widget_update_callback( $this->id_base, $this->_get_update_callback(), $this->control_options, array( 'number' => -1 ) ); _register_widget_form_callback( $this->id, $this->name, $this->_get_form_callback(), $this->control_options, array( 'number' => $number ) ); } - function save_settings($settings) { + /** + * Save the settings for all instances of the widget class. + * + * @since 2.8.0 + * @access public + * + * @param array $settings Multi-dimensional array of widget instance settings. + */ + public function save_settings( $settings ) { $settings['_multiwidget'] = 1; update_option( $this->option_name, $settings ); } - function get_settings() { + /** + * Get the settings for all instances of the widget class. + * + * @since 2.8.0 + * @access public + * + * @return array Multi-dimensional array of widget instance settings. + */ + public function get_settings() { + $settings = get_option($this->option_name); if ( false === $settings && isset($this->alt_option_name) ) @@ -296,8 +524,8 @@ class WP_Widget { if ( !is_array($settings) ) $settings = array(); - if ( !array_key_exists('_multiwidget', $settings) ) { - // old format, conver if single widget + if ( !empty($settings) && !array_key_exists('_multiwidget', $settings) ) { + // old format, convert if single widget $settings = wp_convert_widget_settings($this->id_base, $this->option_name, $settings); } @@ -311,25 +539,47 @@ class WP_Widget { * * @package WordPress * @subpackage Widgets - * @since 2.8 + * @since 2.8.0 */ class WP_Widget_Factory { - var $widgets = array(); + public $widgets = array(); - function WP_Widget_Factory() { - add_action( 'widgets_init', array( &$this, '_register_widgets' ), 100 ); + public function WP_Widget_Factory() { + add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 ); } - function register($widget_class) { - $this->widgets[$widget_class] = & new $widget_class(); + /** + * Register a widget subclass. + * + * @since 2.8.0 + * @access public + * + * @param string $widget_class The name of a {@see WP_Widget} subclass. + */ + public function register( $widget_class ) { + $this->widgets[$widget_class] = new $widget_class(); } - function unregister($widget_class) { + /** + * Un-register a widget subclass. + * + * @since 2.8.0 + * @access public + * + * @param string $widget_class The name of a {@see WP_Widget} subclass. + */ + public function unregister( $widget_class ) { if ( isset($this->widgets[$widget_class]) ) unset($this->widgets[$widget_class]); } - function _register_widgets() { + /** + * Utility method for adding widgets to the registered widgets global. + * + * @since 2.8.0 + * @access public + */ + public function _register_widgets() { global $wp_registered_widgets; $keys = array_keys($this->widgets); $registered = array_keys($wp_registered_widgets); @@ -385,8 +635,8 @@ $_wp_sidebars_widgets = array(); /** * Private */ - $_wp_deprecated_widgets_callbacks = array( - 'wp_widget_pages', +$GLOBALS['_wp_deprecated_widgets_callbacks'] = array( + 'wp_widget_pages', 'wp_widget_pages_control', 'wp_widget_calendar', 'wp_widget_calendar_control', @@ -408,7 +658,7 @@ $_wp_sidebars_widgets = array(); 'wp_widget_rss_control', 'wp_widget_recent_comments', 'wp_widget_recent_comments_control' - ); +); /* Template tags & API functions */ @@ -456,25 +706,26 @@ 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 mutliple - * 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. + * @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; @@ -509,34 +760,43 @@ function register_sidebars($number = 1, $args = array()) { /** * Builds the definition for a single sidebar and returns the ID. * - * The $args parameter takes either a string or an array with 'name' and 'id' - * contained in either usage. It will be noted that the values will be applied - * to all sidebars, so if creating more than one, it will be advised to allow - * for WordPress to create the defaults for you. - * - * Example for string would be'name=whatever;id=whatever1'
and for
- * the array it would be array(
- * 'name' => 'whatever',
- * 'id' => 'whatever1')
.
- *
- * name - The name of the sidebar, which presumably the title which will be
- * displayed.
- * id - The unique identifier by which the sidebar will be called by.
- * before_widget - The content that will prepended to the widgets when they are
- * displayed.
- * after_widget - The content that will be appended to the widgets when they are
- * displayed.
- * before_title - The content that will be prepended to the title when displayed.
- * after_title - the content that will be appended to the title when displayed.
- *
- * Content is assumed to be HTML and should be formatted as such, but
- * doesn't have to be.
+ * Accepts either a string or an array and then parses that against a set
+ * of default arguments for the new sidebar. WordPress will automatically
+ * generate a sidebar ID and name based on the current number of registered
+ * sidebars if those arguments are not included.
+ *
+ * When allowing for automatic generation of the name and ID parameters, keep
+ * in mind that the incrementor for your sidebar can change over time depending
+ * on what other plugins and themes are installed.
+ *
+ * If theme support for 'widgets' has not yet been added when this function is
+ * called, it will be automatically enabled through the use of add_theme_support()
*
* @since 2.2.0
- * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
*
- * @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;
@@ -547,6 +807,7 @@ function register_sidebar($args = array()) {
'name' => sprintf(__('Sidebar %d'), $i ),
'id' => "sidebar-$i",
'description' => '',
+ 'class' => '',
'before_widget' => '