X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/af50974463450c98503e763a7836a50e260461a9..refs/tags/wordpress-4.4.1:/wp-includes/widgets.php diff --git a/wp-includes/widgets.php b/wp-includes/widgets.php index 2e710ccb..cfc5b93c 100644 --- a/wp-includes/widgets.php +++ b/wp-includes/widgets.php @@ -1,603 +1,26 @@ ' . __('There are no options for this widget.') . '

'; - return 'noform'; - } - - // Functions you'll need to call. - - /** - * 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. - */ - 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; - $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) ); - } - - /** - * 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 - * - * 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 - */ - public function get_field_name($field_name) { - return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']'; - } - - /** - * 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 {@see WP_Widget::update()}. - * - * @since 2.8.0 - * @access public - * - * @param string $field_name Field name. - * @return string ID attribute for `$field_name`. - */ - public function get_field_id( $field_name ) { - return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name; - } - - /** - * Register all widget instances of this widget class. - * - * @since 2.8.0 - * @access private - */ - public 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(); - } - } - - /** - * 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; - } - - public function _get_display_callback() { - return array($this, 'display_callback'); - } - - public function _get_update_callback() { - return array($this, 'update_callback'); - } - - public 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 (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 ); - - $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]; - - /** - * 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 override). - * - * @since 2.8.0 - * @access public - * - * @param int $deprecated Not used. - */ - public function update_callback( $deprecated = 1 ) { - global $wp_registered_widgets; - - $all_instances = $this->get_settings(); - - // We need to update the data - if ( $this->updated ) - return; - - 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(); - - $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 ); - } - - /** - * 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 - } - } - - $this->save_settings($all_instances); - $this->updated = true; - } - - /** - * 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 ); - - $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'] ]; - } - - /** - * 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); - - /** - * 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; - } - - /** - * 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 ) ); - } - - /** - * 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 ); - } - - /** - * 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) ) - $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.0 + * @since 2.2.0 */ -class WP_Widget_Factory { - public $widgets = array(); - public function WP_Widget_Factory() { - add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 ); - } - - /** - * 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(); - } - - /** - * 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]); - } - - /** - * 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); - $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; @@ -625,15 +48,22 @@ $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', @@ -660,7 +90,9 @@ $GLOBALS['_wp_deprecated_widgets_callbacks'] = array( 'wp_widget_recent_comments_control' ); -/* Template tags & API functions */ +// +// Template tags & API functions +// /** * Register a widget @@ -670,8 +102,8 @@ $GLOBALS['_wp_deprecated_widgets_callbacks'] = 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 */ @@ -690,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 */ @@ -712,6 +144,8 @@ function unregister_widget($widget_class) { * * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here. * + * @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. @@ -745,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); } @@ -803,6 +238,8 @@ function register_sidebar($args = array()) { $i = count($wp_registered_sidebars) + 1; + $id_is_empty = empty( $args['id'] ); + $defaults = array( 'name' => sprintf(__('Sidebar %d'), $i ), 'id' => "sidebar-$i", @@ -816,6 +253,11 @@ 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.' ), 'id', $sidebar['name'], $sidebar['id'] ), '4.2.0' ); + } + $wp_registered_sidebars[$sidebar['id']] = $sidebar; add_theme_support('widgets'); @@ -837,15 +279,30 @@ 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 ] ); +} + +/** + * Checks if a sidebar is registered. + * + * @since 4.4.0 + * + * @global array $wp_registered_sidebars Registered sidebars. + * + * @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 ] ); } /** @@ -860,10 +317,12 @@ function unregister_sidebar( $name ) { * * @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 callback $output_callback Run when widget is called. + * @param callable $output_callback Run when widget is called. * @param array $options { * Optional. An array of supplementary widget options for the instance. * @@ -872,7 +331,6 @@ function unregister_sidebar( $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() ) { global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks; @@ -886,12 +344,8 @@ function wp_register_sidebar_widget( $id, $name, $output_callback, $options = ar $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; } @@ -928,8 +382,10 @@ function wp_register_sidebar_widget( $id, $name, $output_callback, $options = ar * * @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) ) @@ -949,8 +405,10 @@ function wp_widget_description( $id ) { * * @since 2.9.0 * + * @global array $wp_registered_sidebars + * * @param string $id sidebar ID. - * @return string Sidebar description, if available. Null on failure to retrieve description. + * @return string|void Sidebar description, if available. */ function wp_sidebar_description( $id ) { if ( !is_scalar($id) ) @@ -999,9 +457,14 @@ function wp_unregister_sidebar_widget($id) { * @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 callback $control_callback Run when sidebar is displayed. + * @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() ) { @@ -1017,9 +480,7 @@ function wp_register_widget_control( $id, $name, $control_callback, $options = a } 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; } @@ -1052,8 +513,8 @@ function wp_register_widget_control( $id, $name, $control_callback, $options = a } /** - * * @global array $wp_registered_widget_updates + * * @param string $id_base * @param callable $update_callback * @param array $options @@ -1079,11 +540,11 @@ function _register_widget_update_callback($id_base, $update_callback, $options = /** * * @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; @@ -1122,7 +583,7 @@ function _register_widget_form_callback($id, $name, $form_callback, $options = a * @param int|string $id Widget ID. */ function wp_unregister_widget_control($id) { - return wp_register_widget_control($id, '', ''); + wp_register_widget_control( $id, '', '' ); } /** @@ -1134,18 +595,21 @@ function wp_unregister_widget_control($id) { * * @since 2.2.0 * + * @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; } @@ -1154,11 +618,11 @@ function dynamic_sidebar($index = 1) { $sidebars_widgets = wp_get_sidebars_widgets(); if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) { - /** This action is documented in wp-includes/widgets.php */ + /** This action is documented in wp-includes/widget.php */ do_action( 'dynamic_sidebar_before', $index, false ); - /** This action is documented in wp-includes/widgets.php */ + /** This action is documented in wp-includes/widget.php */ do_action( 'dynamic_sidebar_after', $index, false ); - /** This filter is documented in wp-includes/widgets.php */ + /** This filter is documented in wp-includes/widget.php */ return apply_filters( 'dynamic_sidebar_has_widgets', false, $index ); } @@ -1249,7 +713,7 @@ function dynamic_sidebar($index = 1) { * * @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 + * @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. @@ -1293,10 +757,7 @@ function dynamic_sidebar($index = 1) { * 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; + return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index ); } /** @@ -1314,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; @@ -1349,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() { @@ -1389,7 +855,9 @@ function is_active_sidebar( $index ) { return apply_filters( 'is_active_sidebar', $is_active_sidebar, $index ); } -/* Internal Functions */ +// +// Internal Functions +// /** * Retrieve full list of sidebars and their widget instance IDs. @@ -1400,6 +868,9 @@ function is_active_sidebar( $index ) { * @since 2.2.0 * @access private * + * @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. */ @@ -1430,8 +901,7 @@ function wp_get_sidebars_widgets( $deprecated = true ) { * * @param array $sidebars_widgets An associative array of sidebars and their widgets. */ - $sidebars_widgets = apply_filters( 'sidebars_widgets', $sidebars_widgets ); - return $sidebars_widgets; + return apply_filters( 'sidebars_widgets', $sidebars_widgets ); } /** @@ -1454,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() { @@ -1472,6 +944,8 @@ 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 @@ -1533,7 +1007,9 @@ function wp_convert_widget_settings($base_name, $option_name, $settings) { * * @since 2.8.0 * - * @param string $widget The widget's PHP class name (see default-widgets.php). + * @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. @@ -1552,13 +1028,19 @@ 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('
', $widget_obj->widget_options['classname'] ); - $default_args = array( 'before_widget' => $before_widget, 'after_widget' => "
", 'before_title' => '

', 'after_title' => '

' ); + $default_args = array( + 'before_widget' => '
', + 'after_widget' => "
", + 'before_title' => '

', + 'after_title' => '

', + ); + $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); /** @@ -1578,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 ); @@ -1588,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; @@ -1603,9 +1089,13 @@ function _wp_sidebars_changed() { * * @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 + * @return array|void */ function retrieve_widgets( $theme_changed = false ) { global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets; @@ -1710,3 +1200,265 @@ function retrieve_widgets( $theme_changed = false ) { 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 '

' . sprintf( __('RSS Error: %s'), $rss->get_error_message() ) . '

'; + 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 ''; + $rss->__destruct(); + unset($rss); + return; + } + + echo ''; + $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 '

' . sprintf( __( 'RSS Error: %s' ), $args['error'] ) . '

'; + } + + $esc_number = esc_attr( $args['number'] ); + if ( $inputs['url'] ) : +?> +

+

+ +

+

+ +

+

+ +

/> +

+ +

/> +

+ +

/> +

+ + +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' ); +}