<?php
-
-/* Global Variables */
-
-global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_styles, $wp_registered_widget_defaults;
-
+/**
+ * Core Widgets API
+ *
+ * This API is used for creating dynamic sidebar without hardcoding functionality into
+ * themes
+ *
+ * Includes both internal WordPress routines and theme-use routines.
+ *
+ * This functionality was found in a plugin before the WordPress 2.2 release, which
+ * included it in the core from that point on.
+ *
+ * @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.2.0
+ */
+
+//
+// Global Variables
+//
+
+/** @ignore */
+global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
+
+/**
+ * Stores the sidebars, since many themes can have more than one.
+ *
+ * @global array $wp_registered_sidebars
+ * @since 2.2.0
+ */
$wp_registered_sidebars = array();
+
+/**
+ * Stores the registered widgets.
+ *
+ * @global array $wp_registered_widgets
+ * @since 2.2.0
+ */
$wp_registered_widgets = array();
+
+/**
+ * Stores the registered widget control (options).
+ *
+ * @global array $wp_registered_widget_controls
+ * @since 2.2.0
+ */
$wp_registered_widget_controls = array();
-$wp_registered_widget_styles = array();
-$wp_register_widget_defaults = false;
+/**
+ * @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',
+ 'wp_widget_pages_control',
+ 'wp_widget_calendar',
+ 'wp_widget_calendar_control',
+ 'wp_widget_archives',
+ 'wp_widget_archives_control',
+ 'wp_widget_links',
+ 'wp_widget_meta',
+ 'wp_widget_meta_control',
+ 'wp_widget_search',
+ 'wp_widget_recent_entries',
+ 'wp_widget_recent_entries_control',
+ 'wp_widget_tag_cloud',
+ 'wp_widget_tag_cloud_control',
+ 'wp_widget_categories',
+ 'wp_widget_categories_control',
+ 'wp_widget_text',
+ 'wp_widget_text_control',
+ 'wp_widget_rss',
+ 'wp_widget_rss_control',
+ 'wp_widget_recent_comments',
+ 'wp_widget_recent_comments_control'
+);
+
+//
+// Template tags & API functions
+//
+
+/**
+ * Register a widget
+ *
+ * Registers a WP_Widget widget
+ *
+ * @since 2.8.0
+ *
+ * @see WP_Widget
+ *
+ * @global WP_Widget_Factory $wp_widget_factory
+ *
+ * @param string $widget_class The name of a class that extends WP_Widget
+ */
+function register_widget($widget_class) {
+ global $wp_widget_factory;
+
+ $wp_widget_factory->register($widget_class);
+}
-/* Template tags & API functions */
+/**
+ * Unregister a widget
+ *
+ * Unregisters a WP_Widget widget. Useful for unregistering default widgets.
+ * Run within a function hooked to the widgets_init action.
+ *
+ * @since 2.8.0
+ *
+ * @see WP_Widget
+ *
+ * @global WP_Widget_Factory $wp_widget_factory
+ *
+ * @param string $widget_class The name of a class that extends WP_Widget
+ */
+function unregister_widget($widget_class) {
+ global $wp_widget_factory;
+
+ $wp_widget_factory->unregister($widget_class);
+}
-function register_sidebars($number = 1, $args = array()) {
+/**
+ * Creates multiple sidebars.
+ *
+ * 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.
+ *
+ * @since 2.2.0
+ *
+ * @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.
+ *
+ * @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() ) {
+ global $wp_registered_sidebars;
$number = (int) $number;
if ( is_string($args) )
parse_str($args, $args);
- $i = 1;
-
- while ( $i <= $number ) {
+ for ( $i = 1; $i <= $number; $i++ ) {
$_args = $args;
- if ( $number > 1 ) {
- $_args['name'] = isset($args['name']) ? $args['name'] : sprintf(__('Sidebar %d'), $i);
- } else {
+
+ if ( $number > 1 )
+ $_args['name'] = isset($args['name']) ? sprintf($args['name'], $i) : sprintf(__('Sidebar %d'), $i);
+ else
$_args['name'] = isset($args['name']) ? $args['name'] : __('Sidebar');
+
+ // Custom specified ID's are suffixed if they exist already.
+ // Automatically generated sidebar names need to be suffixed regardless starting at -0
+ if ( isset($args['id']) ) {
+ $_args['id'] = $args['id'];
+ $n = 2; // Start at -2 for conflicting custom ID's
+ while ( is_registered_sidebar( $_args['id'] ) ) {
+ $_args['id'] = $args['id'] . '-' . $n++;
+ }
+ } else {
+ $n = count( $wp_registered_sidebars );
+ do {
+ $_args['id'] = 'sidebar-' . ++$n;
+ } while ( is_registered_sidebar( $_args['id'] ) );
}
- $_args['id'] = isset($args['id']) ? $args['id'] : "sidebar-$i";
register_sidebar($_args);
- ++$i;
}
}
+/**
+ * Builds the definition for a single sidebar and returns the ID.
+ *
+ * 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
+ *
+ * @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;
- if ( is_string($args) )
- parse_str($args, $args);
-
$i = count($wp_registered_sidebars) + 1;
+ $id_is_empty = empty( $args['id'] );
+
$defaults = array(
'name' => sprintf(__('Sidebar %d'), $i ),
'id' => "sidebar-$i",
+ 'description' => '',
+ 'class' => '',
'before_widget' => '<li id="%1$s" class="widget %2$s">',
'after_widget' => "</li>\n",
'before_title' => '<h2 class="widgettitle">',
'after_title' => "</h2>\n",
);
- $sidebar = array_merge($defaults, $args);
+ $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'];
}
+/**
+ * Removes a sidebar from the list.
+ *
+ * @since 2.2.0
+ *
+ * @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 ] );
}
-function register_sidebar_widget($name, $output_callback, $classname = '') {
- // Compat
- if ( is_array($name) ) {
- if ( count($name) == 3 )
- $name = sprintf($name[0], $name[2]);
- else
- $name = $name[0];
- }
-
- $id = sanitize_title($name);
- $options = array();
- if ( !empty($classname) && is_string($classname) )
- $options['classname'] = $classname;
- $params = array_slice(func_get_args(), 2);
- $args = array($id, $name, $output_callback, $options);
- if ( !empty($params) )
- $args = array_merge($args, $params);
+/**
+ * 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;
- call_user_func_array('wp_register_sidebar_widget', $args);
+ return isset( $wp_registered_sidebars[ $sidebar_id ] );
}
-function wp_register_sidebar_widget($id, $name, $output_callback, $options = array()) {
-
- global $wp_registered_widgets, $wp_register_widget_defaults;
-
- $id = sanitize_title($id);
+/**
+ * Register an instance of a widget.
+ *
+ * The default widget option is 'classname' that can be overridden.
+ *
+ * The function can also be used to un-register widgets when `$output_callback`
+ * parameter is an empty string.
+ *
+ * @since 2.2.0
+ *
+ * @global array $wp_registered_widgets Uses stored registered widgets.
+ * @global array $wp_register_widget_defaults Retrieves widget defaults.
+ * @global array $wp_registered_widget_updates
+ * @global array $_wp_deprecated_widgets_callbacks
+ *
+ * @param int|string $id Widget ID.
+ * @param string $name Widget display title.
+ * @param callable $output_callback Run when widget is called.
+ * @param array $options {
+ * Optional. An array of supplementary widget options for the instance.
+ *
+ * @type string $classname Class name for the widget's HTML container. Default is a shortened
+ * version of the output callback name.
+ * @type string $description Widget description for display in the widget administration
+ * panel and/or theme.
+ * }
+ */
+function wp_register_sidebar_widget( $id, $name, $output_callback, $options = array() ) {
+ global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks;
+
+ $id = strtolower($id);
if ( empty($output_callback) ) {
unset($wp_registered_widgets[$id]);
return;
}
+ $id_base = _get_widget_id_base($id);
+ if ( in_array($output_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($output_callback) ) {
+ unset( $wp_registered_widget_controls[ $id ] );
+ unset( $wp_registered_widget_updates[ $id_base ] );
+ return;
+ }
+
$defaults = array('classname' => $output_callback);
$options = wp_parse_args($options, $defaults);
$widget = array(
);
$widget = array_merge($widget, $options);
- if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || !$wp_register_widget_defaults) )
+ 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;
+ }
+}
+
+/**
+ * Retrieve description for widget.
+ *
+ * When registering widgets, the options can also include 'description' that
+ * describes the widget for display on the widget administration panel or
+ * in the theme.
+ *
+ * @since 2.5.0
+ *
+ * @global array $wp_registered_widgets
+ *
+ * @param int|string $id Widget ID.
+ * @return string|void Widget description, if available.
+ */
+function wp_widget_description( $id ) {
+ if ( !is_scalar($id) )
+ return;
+
+ global $wp_registered_widgets;
+
+ if ( isset($wp_registered_widgets[$id]['description']) )
+ return esc_html( $wp_registered_widgets[$id]['description'] );
}
-function unregister_sidebar_widget($id) {
- return wp_unregister_sidebar_widget($id);
+/**
+ * Retrieve description for a sidebar.
+ *
+ * When registering sidebars a 'description' parameter can be included that
+ * describes the sidebar for display on the widget administration panel.
+ *
+ * @since 2.9.0
+ *
+ * @global array $wp_registered_sidebars
+ *
+ * @param string $id sidebar ID.
+ * @return string|void Sidebar description, if available.
+ */
+function wp_sidebar_description( $id ) {
+ if ( !is_scalar($id) )
+ return;
+
+ global $wp_registered_sidebars;
+
+ if ( isset($wp_registered_sidebars[$id]['description']) )
+ return esc_html( $wp_registered_sidebars[$id]['description'] );
}
+/**
+ * Remove widget from sidebar.
+ *
+ * @since 2.2.0
+ *
+ * @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, '', '');
wp_unregister_widget_control($id);
}
-function register_widget_control($name, $control_callback, $width = '', $height = '') {
- // Compat
- if ( is_array($name) ) {
- if ( count($name) == 3 )
- $name = sprintf($name[0], $name[2]);
- else
- $name = $name[0];
+/**
+ * Registers widget control callback for customizing options.
+ *
+ * @since 2.2.0
+ *
+ * @todo `$params` parameter?
+ *
+ * @global array $wp_registered_widget_controls
+ * @global array $wp_registered_widget_updates
+ * @global array $wp_registered_widgets
+ * @global array $_wp_deprecated_widgets_callbacks
+ *
+ * @param int|string $id Sidebar ID.
+ * @param string $name Sidebar display name.
+ * @param callable $control_callback Run when sidebar is displayed.
+ * @param array $options {
+ * Optional. Array or string of control options. Default empty array.
+ *
+ * @type int $height Never used. Default 200.
+ * @type int $width Width of the fully expanded control form (but try hard to use the default width).
+ * Default 250.
+ * @type int|string $id_base Required for multi-widgets, i.e widgets that allow multiple instances such as the
+ * text widget. The widget id will end up looking like `{$id_base}-{$unique_number}`.
+ * }
+ */
+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);
+ $id_base = _get_widget_id_base($id);
+
+ if ( empty($control_callback) ) {
+ unset($wp_registered_widget_controls[$id]);
+ unset($wp_registered_widget_updates[$id_base]);
+ return;
}
- $id = sanitize_title($name);
- $options = array();
- if ( !empty($width) )
- $options['width'] = $width;
- if ( !empty($height) )
- $options['height'] = $height;
- $params = array_slice(func_get_args(), 4);
- $args = array($id, $name, $control_callback, $options);
- if ( !empty($params) )
- $args = array_merge($args, $params);
-
- call_user_func_array('wp_register_widget_control', $args);
+ if ( in_array($control_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($control_callback) ) {
+ unset( $wp_registered_widgets[ $id ] );
+ return;
+ }
+
+ if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) )
+ return;
+
+ $defaults = array('width' => 250, 'height' => 200 ); // height is never used
+ $options = wp_parse_args($options, $defaults);
+ $options['width'] = (int) $options['width'];
+ $options['height'] = (int) $options['height'];
+
+ $widget = array(
+ 'name' => $name,
+ 'id' => $id,
+ 'callback' => $control_callback,
+ 'params' => array_slice(func_get_args(), 4)
+ );
+ $widget = array_merge($widget, $options);
+
+ $wp_registered_widget_controls[$id] = $widget;
+
+ if ( isset($wp_registered_widget_updates[$id_base]) )
+ return;
+
+ if ( isset($widget['params'][0]['number']) )
+ $widget['params'][0]['number'] = -1;
+
+ unset($widget['width'], $widget['height'], $widget['name'], $widget['id']);
+ $wp_registered_widget_updates[$id_base] = $widget;
}
-function wp_register_widget_control($id, $name, $control_callback, $options = array()) {
- global $wp_registered_widget_controls, $wp_register_widget_defaults;
+/**
+ * Registers the update callback for a widget.
+ *
+ * @since 2.8.0
+ *
+ * @global array $wp_registered_widget_updates
+ *
+ * @param string $id_base The base ID of a widget created by extending WP_Widget.
+ * @param callable $update_callback Update callback method for the widget.
+ * @param array $options Optional. Widget control options. See {@see wp_register_widget_control()}.
+ * Default empty array.
+ */
+function _register_widget_update_callback( $id_base, $update_callback, $options = array() ) {
+ global $wp_registered_widget_updates;
+
+ if ( isset($wp_registered_widget_updates[$id_base]) ) {
+ if ( empty($update_callback) )
+ unset($wp_registered_widget_updates[$id_base]);
+ return;
+ }
+
+ $widget = array(
+ 'callback' => $update_callback,
+ 'params' => array_slice(func_get_args(), 3)
+ );
- $id = sanitize_title($id);
+ $widget = array_merge($widget, $options);
+ $wp_registered_widget_updates[$id_base] = $widget;
+}
- if ( empty($control_callback) ) {
+/**
+ * Registers the form callback for a widget.
+ *
+ * @since 2.8.0
+ *
+ * @global array $wp_registered_widget_controls
+ *
+ * @param int|string $id Widget ID.
+ * @param string $name Name attribute for the widget.
+ * @param callable $form_callback Form callback.
+ * @param array $options Optional. Widget control options. See {@see wp_register_widget_control()}.
+ * Default empty array.
+ */
+function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {
+ global $wp_registered_widget_controls;
+
+ $id = strtolower($id);
+
+ if ( empty($form_callback) ) {
unset($wp_registered_widget_controls[$id]);
return;
}
- if ( isset($wp_registered_widget_controls[$id]) && $wp_register_widget_defaults )
+ if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) )
return;
- $defaults = array('width' => 300, 'height' => 200);
+ $defaults = array('width' => 250, 'height' => 200 );
$options = wp_parse_args($options, $defaults);
$options['width'] = (int) $options['width'];
$options['height'] = (int) $options['height'];
- $options['width'] = $options['width'] > 90 ? $options['width'] + 60 : 360;
- $options['height'] = $options['height'] > 60 ? $options['height'] + 40 : 240;
$widget = array(
'name' => $name,
'id' => $id,
- 'callback' => $control_callback,
+ 'callback' => $form_callback,
'params' => array_slice(func_get_args(), 4)
);
$widget = array_merge($widget, $options);
$wp_registered_widget_controls[$id] = $widget;
}
-function unregister_widget_control($id) {
- return wp_unregister_widget_control($id);
-}
-
+/**
+ * Remove control callback for widget.
+ *
+ * @since 2.2.0
+ *
+ * @param int|string $id Widget ID.
+ */
function wp_unregister_widget_control($id) {
- return wp_register_widget_control($id, '', '');
+ wp_register_widget_control( $id, '', '' );
}
-function dynamic_sidebar($index = 1) {
+/**
+ * Display dynamic sidebar.
+ *
+ * By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or
+ * 'name' parameter for its registered sidebars you can pass an id or name as the $index parameter.
+ * Otherwise, you can pass in a numerical index to display the sidebar at that index.
+ *
+ * @since 2.2.0
+ *
+ * @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 ) {
global $wp_registered_sidebars, $wp_registered_widgets;
- if ( is_int($index) ) {
+ if ( is_int( $index ) ) {
$index = "sidebar-$index";
} else {
- $index = sanitize_title($index);
- foreach ( $wp_registered_sidebars as $key => $value ) {
- if ( sanitize_title($value['name']) == $index ) {
+ $index = sanitize_title( $index );
+ foreach ( (array) $wp_registered_sidebars as $key => $value ) {
+ if ( sanitize_title( $value['name'] ) == $index ) {
$index = $key;
break;
}
}
$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/widget.php */
+ do_action( 'dynamic_sidebar_before', $index, false );
+ /** This action is documented in wp-includes/widget.php */
+ do_action( 'dynamic_sidebar_after', $index, false );
+ /** This filter is documented in wp-includes/widget.php */
+ return apply_filters( 'dynamic_sidebar_has_widgets', false, $index );
+ }
- if ( empty($wp_registered_sidebars[$index]) || !is_array($sidebars_widgets[$index]) || empty($sidebars_widgets[$index]) )
- return false;
-
+ /**
+ * 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;
- foreach ( $sidebars_widgets[$index] as $id ) {
- $callback = $wp_registered_widgets[$id]['callback'];
+ foreach ( (array) $sidebars_widgets[$index] as $id ) {
+
+ if ( !isset($wp_registered_widgets[$id]) ) continue;
- $params = array_merge(array($sidebar), (array) $wp_registered_widgets[$id]['params']);
+ $params = array_merge(
+ array( array_merge( $sidebar, array('widget_id' => $id, 'widget_name' => $wp_registered_widgets[$id]['name']) ) ),
+ (array) $wp_registered_widgets[$id]['params']
+ );
// Substitute HTML id and class attributes into before_widget
$classname_ = '';
$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'];
+
+ /**
+ * Fires before a widget's display callback is called.
+ *
+ * Note: The action fires on both the front end and back end, including
+ * for widgets in the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * The action is not fired for empty sidebars.
+ *
+ * @since 3.0.0
+ *
+ * @param array $widget_id {
+ * An associative array of widget arguments.
+ *
+ * @type string $name Name of the widget.
+ * @type string $id Widget ID.
+ * @type array|callable $callback When the hook is fired on the front end, $callback is an array
+ * containing the widget object. Fired on the back end, $callback
+ * is 'wp_widget_control', see $_callback.
+ * @type array $params An associative array of multi-widget arguments.
+ * @type string $classname CSS class applied to the widget container.
+ * @type string $description The widget description.
+ * @type array $_callback When the hook is fired on the back end, $_callback is populated
+ * with an array containing the widget object, see $callback.
+ * }
+ */
+ do_action( 'dynamic_sidebar', $wp_registered_widgets[ $id ] );
+
if ( is_callable($callback) ) {
call_user_func_array($callback, $params);
$did_one = true;
}
}
- return $did_one;
+ /**
+ * Fires after widgets are rendered in a dynamic sidebar.
+ *
+ * Note: The action also fires for empty sidebars, and on both the front end
+ * and back end, including the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * @since 3.9.0
+ *
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ * @param bool $has_widgets Whether the sidebar is populated with widgets.
+ * Default true.
+ */
+ do_action( 'dynamic_sidebar_after', $index, true );
+
+ /**
+ * Filter whether a sidebar has widgets.
+ *
+ * Note: The filter is also evaluated for empty sidebars, and on both the front end
+ * and back end, including the Inactive Widgets sidebar on the Widgets screen.
+ *
+ * @since 3.9.0
+ *
+ * @param bool $did_one Whether at least one widget was rendered in the sidebar.
+ * Default false.
+ * @param int|string $index Index, name, or ID of the dynamic sidebar.
+ */
+ return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index );
}
-function is_active_widget($callback) {
+/**
+ * Whether widget is displayed on the front end.
+ *
+ * Either $callback or $id_base can be used
+ * $id_base is the first argument when extending WP_Widget class
+ * Without the optional $widget_id parameter, returns the ID of the first sidebar
+ * in which the first instance of the widget with the given callback or $id_base is found.
+ * With the $widget_id parameter, returns the ID of the sidebar where
+ * the widget with that callback/$id_base AND that ID is found.
+ *
+ * NOTE: $widget_id and $id_base are the same for single widgets. To be effective
+ * this function has to run after widgets have initialized, at action 'init' or later.
+ *
+ * @since 2.2.0
+ *
+ * @global array $wp_registered_widgets
+ *
+ * @param string|false $callback Optional, Widget callback to check. Default false.
+ * @param int|false $widget_id Optional. Widget ID. Optional, but needed for checking. Default false.
+ * @param string|false $id_base Optional. The base ID of a widget created by extending WP_Widget. Default false.
+ * @param bool $skip_inactive Optional. Whether to check in 'wp_inactive_widgets'. Default true.
+ * @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;
- $sidebars_widgets = wp_get_sidebars_widgets(false);
+ $sidebars_widgets = wp_get_sidebars_widgets();
- if ( is_array($sidebars_widgets) ) foreach ( $sidebars_widgets as $sidebar => $widgets )
- if ( is_array($widgets) ) foreach ( $widgets as $widget )
- if ( $wp_registered_widgets[$widget]['callback'] == $callback )
- return true;
+ if ( is_array($sidebars_widgets) ) {
+ foreach ( $sidebars_widgets as $sidebar => $widgets ) {
+ if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) ) {
+ continue;
+ }
+ if ( is_array($widgets) ) {
+ foreach ( $widgets as $widget ) {
+ if ( ( $callback && isset($wp_registered_widgets[$widget]['callback']) && $wp_registered_widgets[$widget]['callback'] == $callback ) || ( $id_base && _get_widget_id_base($widget) == $id_base ) ) {
+ if ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] )
+ return $sidebar;
+ }
+ }
+ }
+ }
+ }
return false;
}
+/**
+ * Whether the dynamic sidebar is enabled and used by theme.
+ *
+ * @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() {
global $wp_registered_widgets, $wp_registered_sidebars;
$sidebars_widgets = get_option('sidebars_widgets');
- foreach ( $wp_registered_sidebars as $index => $sidebar ) {
- if ( count($sidebars_widgets[$index]) ) {
- foreach ( $sidebars_widgets[$index] as $widget )
+ foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
+ if ( ! empty( $sidebars_widgets[ $index ] ) ) {
+ foreach ( (array) $sidebars_widgets[$index] as $widget )
if ( array_key_exists($widget, $wp_registered_widgets) )
return true;
}
return false;
}
-/* Internal Functions */
-
-function wp_get_sidebars_widgets($update = true) {
- global $wp_registered_widgets, $wp_registered_sidebars;
-
- $sidebars_widgets = get_option('sidebars_widgets');
- $_sidebars_widgets = array();
-
- if ( !isset($sidebars_widgets['array_version']) )
- $sidebars_widgets['array_version'] = 1;
-
- switch ( $sidebars_widgets['array_version'] ) {
- case 1 :
- foreach ( $sidebars_widgets as $index => $sidebar )
- if ( is_array($sidebar) )
- foreach ( $sidebar as $i => $name ) {
- $id = strtolower($name);
- if ( isset($wp_registered_widgets[$id]) ) {
- $_sidebars_widgets[$index][$i] = $id;
- continue;
- }
- $id = sanitize_title($name);
- if ( isset($wp_registered_widgets[$id]) ) {
- $_sidebars_widgets[$index][$i] = $id;
- continue;
- }
- unset($_sidebars_widgets[$index][$i]);
- }
- $_sidebars_widgets['array_version'] = 2;
- $sidebars_widgets = $_sidebars_widgets;
- unset($_sidebars_widgets);
-
- case 2 :
- $sidebars = array_keys( $wp_registered_sidebars );
- if ( !empty( $sidebars ) ) {
- // Move the known-good ones first
- foreach ( $sidebars as $id ) {
- if ( array_key_exists( $id, $sidebars_widgets ) ) {
- $_sidebars_widgets[$id] = $sidebars_widgets[$id];
- unset($sidebars_widgets[$id], $sidebars[$id]);
- }
- }
-
- // Assign to each unmatched registered sidebar the first available orphan
- unset( $sidebars_widgets[ 'array_version' ] );
- while ( ( $sidebar = array_shift( $sidebars ) ) && $widgets = array_shift( $sidebars_widgets ) )
- $_sidebars_widgets[ $sidebar ] = $widgets;
-
- $_sidebars_widgets['array_version'] = 3;
- $sidebars_widgets = $_sidebars_widgets;
- unset($_sidebars_widgets);
- }
+/**
+ * Whether a sidebar is in use.
+ *
+ * @since 2.8.0
+ *
+ * @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] );
+
+ /**
+ * 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 );
+}
- if ( $update )
- update_option('sidebars_widgets', $sidebars_widgets);
+//
+// Internal Functions
+//
+
+/**
+ * Retrieve full list of sidebars and their widget instance IDs.
+ *
+ * Will upgrade sidebar widget list, if needed. Will also save updated list, if
+ * needed.
+ *
+ * @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.
+ */
+function wp_get_sidebars_widgets( $deprecated = true ) {
+ if ( $deprecated !== true )
+ _deprecated_argument( __FUNCTION__, '2.8.1' );
+
+ global $_wp_sidebars_widgets, $sidebars_widgets;
+
+ // If loading from front page, consult $_wp_sidebars_widgets rather than options
+ // to see if wp_convert_widget_settings() has made manipulations in memory.
+ if ( !is_admin() ) {
+ if ( empty($_wp_sidebars_widgets) )
+ $_wp_sidebars_widgets = get_option('sidebars_widgets', array());
+
+ $sidebars_widgets = $_wp_sidebars_widgets;
+ } else {
+ $sidebars_widgets = get_option('sidebars_widgets', array());
}
- unset($sidebars_widgets['array_version']);
-
- return $sidebars_widgets;
+ if ( is_array( $sidebars_widgets ) && isset($sidebars_widgets['array_version']) )
+ unset($sidebars_widgets['array_version']);
+
+ /**
+ * Filter the list of sidebars and their widgets.
+ *
+ * @since 2.7.0
+ *
+ * @param array $sidebars_widgets An associative array of sidebars and their widgets.
+ */
+ return apply_filters( 'sidebars_widgets', $sidebars_widgets );
}
+/**
+ * Set the sidebar widget option to update sidebars.
+ *
+ * @since 2.2.0
+ * @access private
+ *
+ * @param array $sidebars_widgets Sidebar widgets and their settings.
+ */
function wp_set_sidebars_widgets( $sidebars_widgets ) {
+ if ( !isset( $sidebars_widgets['array_version'] ) )
+ $sidebars_widgets['array_version'] = 3;
update_option( 'sidebars_widgets', $sidebars_widgets );
}
+/**
+ * Retrieve default registered sidebars list.
+ *
+ * @since 2.2.0
+ * @access private
+ *
+ * @global array $wp_registered_sidebars
+ *
+ * @return array
+ */
function wp_get_widget_defaults() {
global $wp_registered_sidebars;
$defaults = array();
- foreach ( $wp_registered_sidebars as $index => $sidebar )
+ foreach ( (array) $wp_registered_sidebars as $index => $sidebar )
$defaults[$index] = array();
return $defaults;
}
-/* Default Widgets */
-
-function wp_widget_pages( $args ) {
- extract( $args );
- $options = get_option( 'widget_pages' );
-
- $title = empty( $options['title'] ) ? __( 'Pages' ) : $options['title'];
- $sortby = empty( $options['sortby'] ) ? 'menu_order' : $options['sortby'];
- $exclude = empty( $options['exclude'] ) ? '' : $options['exclude'];
-
- if ( $sortby == 'menu_order' ) {
- $sortby = 'menu_order, post_title';
- }
-
- $out = wp_list_pages( array('title_li' => '', 'echo' => 0, 'sort_column' => $sortby, 'exclude' => $exclude) );
-
- if ( !empty( $out ) ) {
-?>
- <?php echo $before_widget; ?>
- <?php echo $before_title . $title . $after_title; ?>
- <ul>
- <?php echo $out; ?>
- </ul>
- <?php echo $after_widget; ?>
-<?php
+/**
+ * Convert the widget settings from single to multi-widget format.
+ *
+ * @since 2.8.0
+ *
+ * @global array $_wp_sidebars_widgets
+ *
+ * @param string $base_name
+ * @param string $option_name
+ * @param array $settings
+ * @return array
+ */
+function wp_convert_widget_settings($base_name, $option_name, $settings) {
+ // This test may need expanding.
+ $single = $changed = false;
+ if ( empty($settings) ) {
+ $single = true;
+ } else {
+ foreach ( array_keys($settings) as $number ) {
+ if ( 'number' == $number )
+ continue;
+ if ( !is_numeric($number) ) {
+ $single = true;
+ break;
+ }
+ }
}
-}
-
-function wp_widget_pages_control() {
- $options = $newoptions = get_option('widget_pages');
- if ( $_POST['pages-submit'] ) {
- $newoptions['title'] = strip_tags(stripslashes($_POST['pages-title']));
- $sortby = stripslashes( $_POST['pages-sortby'] );
+ if ( $single ) {
+ $settings = array( 2 => $settings );
- if ( in_array( $sortby, array( 'post_title', 'menu_order', 'ID' ) ) ) {
- $newoptions['sortby'] = $sortby;
+ // If loading from the front page, update sidebar in memory but don't save to options
+ if ( is_admin() ) {
+ $sidebars_widgets = get_option('sidebars_widgets');
} else {
- $newoptions['sortby'] = 'menu_order';
+ if ( empty($GLOBALS['_wp_sidebars_widgets']) )
+ $GLOBALS['_wp_sidebars_widgets'] = get_option('sidebars_widgets', array());
+ $sidebars_widgets = &$GLOBALS['_wp_sidebars_widgets'];
}
- $newoptions['exclude'] = strip_tags( stripslashes( $_POST['pages-exclude'] ) );
- }
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_pages', $options);
- }
- $title = attribute_escape($options['title']);
- $exclude = attribute_escape( $options['exclude'] );
-?>
- <p><label for="pages-title"><?php _e('Title:'); ?> <input style="width: 250px;" id="pages-title" name="pages-title" type="text" value="<?php echo $title; ?>" /></label></p>
- <p><label for="pages-sortby"><?php _e( 'Sort by:' ); ?>
- <select name="pages-sortby" id="pages-sortby">
- <option value="post_title"<?php selected( $options['sortby'], 'post_title' ); ?>><?php _e('Page title'); ?></option>
- <option value="menu_order"<?php selected( $options['sortby'], 'menu_order' ); ?>><?php _e('Page order'); ?></option>
- <option value="ID"<?php selected( $options['sortby'], 'ID' ); ?>><?php _e( 'Page ID' ); ?></option>
- </select></label></p>
- <p><label for="pages-exclude"><?php _e( 'Exclude:' ); ?> <input type="text" value="<?php echo $exclude; ?>" name="pages-exclude" id="pages-exclude" style="width: 180px;" /></label><br />
- <small><?php _e( 'Page IDs, separated by commas.' ); ?></small></p>
- <input type="hidden" id="pages-submit" name="pages-submit" value="1" />
-<?php
-}
-
-function wp_widget_links($args) {
- extract($args, EXTR_SKIP);
- wp_list_bookmarks(array(
- 'title_before' => $before_title, 'title_after' => $after_title,
- 'category_before' => $before_widget, 'category_after' => $after_widget,
- 'show_images' => true, 'class' => 'linkcat widget'
- ));
-}
-
-function wp_widget_search($args) {
- extract($args);
-?>
- <?php echo $before_widget; ?>
- <form id="searchform" method="get" action="<?php bloginfo('home'); ?>">
- <div>
- <input type="text" name="s" id="s" size="15" /><br />
- <input type="submit" value="<?php echo attribute_escape(__('Search')); ?>" />
- </div>
- </form>
- <?php echo $after_widget; ?>
-<?php
-}
-
-function wp_widget_archives($args) {
- extract($args);
- $options = get_option('widget_archives');
- $c = $options['count'] ? '1' : '0';
- $d = $options['dropdown'] ? '1' : '0';
- $title = empty($options['title']) ? __('Archives') : $options['title'];
-
- echo $before_widget;
- echo $before_title . $title . $after_title;
+ foreach ( (array) $sidebars_widgets as $index => $sidebar ) {
+ if ( is_array($sidebar) ) {
+ foreach ( $sidebar as $i => $name ) {
+ if ( $base_name == $name ) {
+ $sidebars_widgets[$index][$i] = "$name-2";
+ $changed = true;
+ break 2;
+ }
+ }
+ }
+ }
- if($d) {
-?>
- <select name="archive-dropdown" onchange='document.location.href=this.options[this.selectedIndex].value;'> <option value=""><?php echo attribute_escape(__('Select Month')); ?></option> <?php wp_get_archives("type=monthly&format=option&show_post_count=$c"); ?> </select>
-<?php
- } else {
-?>
- <ul>
- <?php wp_get_archives("type=monthly&show_post_count=$c"); ?>
- </ul>
-<?php
+ if ( is_admin() && $changed )
+ update_option('sidebars_widgets', $sidebars_widgets);
}
- echo $after_widget;
-}
+ $settings['_multiwidget'] = 1;
+ if ( is_admin() )
+ update_option( $option_name, $settings );
-function wp_widget_archives_control() {
- $options = $newoptions = get_option('widget_archives');
- if ( $_POST["archives-submit"] ) {
- $newoptions['count'] = isset($_POST['archives-count']);
- $newoptions['dropdown'] = isset($_POST['archives-dropdown']);
- $newoptions['title'] = strip_tags(stripslashes($_POST["archives-title"]));
- }
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_archives', $options);
- }
- $count = $options['count'] ? 'checked="checked"' : '';
- $dropdown = $options['dropdown'] ? 'checked="checked"' : '';
- $title = attribute_escape($options['title']);
-?>
- <p><label for="archives-title"><?php _e('Title:'); ?> <input style="width: 250px;" id="archives-title" name="archives-title" type="text" value="<?php echo $title; ?>" /></label></p>
- <p style="text-align:right;margin-right:40px;"><label for="archives-count"><?php _e('Show post counts'); ?> <input class="checkbox" type="checkbox" <?php echo $count; ?> id="archives-count" name="archives-count" /></label></p>
- <p style="text-align:right;margin-right:40px;"><label for="archives-dropdown"><?php _e('Display as a drop down'); ?> <input class="checkbox" type="checkbox" <?php echo $dropdown; ?> id="archives-dropdown" name="archives-dropdown" /></label></p>
- <input type="hidden" id="archives-submit" name="archives-submit" value="1" />
-<?php
+ return $settings;
}
-function wp_widget_meta($args) {
- extract($args);
- $options = get_option('widget_meta');
- $title = empty($options['title']) ? __('Meta') : $options['title'];
-?>
- <?php echo $before_widget; ?>
- <?php echo $before_title . $title . $after_title; ?>
- <ul>
- <?php wp_register(); ?>
- <li><?php wp_loginout(); ?></li>
- <li><a href="<?php bloginfo('rss2_url'); ?>" title="<?php echo attribute_escape(__('Syndicate this site using RSS 2.0')); ?>"><?php _e('Entries <abbr title="Really Simple Syndication">RSS</abbr>'); ?></a></li>
- <li><a href="<?php bloginfo('comments_rss2_url'); ?>" title="<?php echo attribute_escape(__('The latest comments to all posts in RSS')); ?>"><?php _e('Comments <abbr title="Really Simple Syndication">RSS</abbr>'); ?></a></li>
- <li><a href="http://wordpress.org/" title="<?php echo attribute_escape(__('Powered by WordPress, state-of-the-art semantic personal publishing platform.')); ?>">WordPress.org</a></li>
- <?php wp_meta(); ?>
- </ul>
- <?php echo $after_widget; ?>
-<?php
-}
-function wp_widget_meta_control() {
- $options = $newoptions = get_option('widget_meta');
- if ( $_POST["meta-submit"] ) {
- $newoptions['title'] = strip_tags(stripslashes($_POST["meta-title"]));
- }
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_meta', $options);
- }
- $title = attribute_escape($options['title']);
-?>
- <p><label for="meta-title"><?php _e('Title:'); ?> <input style="width: 250px;" id="meta-title" name="meta-title" type="text" value="<?php echo $title; ?>" /></label></p>
- <input type="hidden" id="meta-submit" name="meta-submit" value="1" />
-<?php
-}
-
-function wp_widget_calendar($args) {
- extract($args);
- $options = get_option('widget_calendar');
- $title = $options['title'];
- if ( empty($title) )
- $title = ' ';
- echo $before_widget . $before_title . $title . $after_title;
- echo '<div id="calendar_wrap">';
- get_calendar();
- echo '</div>';
- echo $after_widget;
-}
-function wp_widget_calendar_control() {
- $options = $newoptions = get_option('widget_calendar');
- if ( $_POST["calendar-submit"] ) {
- $newoptions['title'] = strip_tags(stripslashes($_POST["calendar-title"]));
- }
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_calendar', $options);
+/**
+ * Output an arbitrary widget as a template tag.
+ *
+ * @since 2.8.0
+ *
+ * @global WP_Widget_Factory $wp_widget_factory
+ *
+ * @param string $widget The widget's PHP class name (see class-wp-widget.php).
+ * @param array $instance Optional. The widget's instance settings. Default empty array.
+ * @param array $args {
+ * Optional. Array of arguments to configure the display of the widget.
+ *
+ * @type string $before_widget HTML content that will be prepended to the widget's HTML output.
+ * Default `<div class="widget %s">`, where `%s` is the widget's class name.
+ * @type string $after_widget HTML content that will be appended to the widget's HTML output.
+ * Default `</div>`.
+ * @type string $before_title HTML content that will be prepended to the widget's title when displayed.
+ * Default `<h2 class="widgettitle">`.
+ * @type string $after_title HTML content that will be appended to the widget's title when displayed.
+ * Default `</h2>`.
+ * }
+ */
+function the_widget( $widget, $instance = array(), $args = array() ) {
+ global $wp_widget_factory;
+
+ $widget_obj = $wp_widget_factory->widgets[$widget];
+ if ( ! ( $widget_obj instanceof WP_Widget ) ) {
+ return;
}
- $title = attribute_escape($options['title']);
-?>
- <p><label for="calendar-title"><?php _e('Title:'); ?> <input style="width: 250px;" id="calendar-title" name="calendar-title" type="text" value="<?php echo $title; ?>" /></label></p>
- <input type="hidden" id="calendar-submit" name="calendar-submit" value="1" />
-<?php
-}
-function wp_widget_text($args, $number = 1) {
- extract($args);
- $options = get_option('widget_text');
- $title = $options[$number]['title'];
- $text = apply_filters( 'widget_text', $options[$number]['text'] );
-?>
- <?php echo $before_widget; ?>
- <?php if ( !empty( $title ) ) { echo $before_title . $title . $after_title; } ?>
- <div class="textwidget"><?php echo $text; ?></div>
- <?php echo $after_widget; ?>
-<?php
+ $default_args = array(
+ 'before_widget' => '<div class="widget %s">',
+ 'after_widget' => "</div>",
+ 'before_title' => '<h2 class="widgettitle">',
+ 'after_title' => '</h2>',
+ );
+ $args = wp_parse_args( $args, $default_args );
+ $args['before_widget'] = sprintf( $args['before_widget'], $widget_obj->widget_options['classname'] );
+
+ $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);
+ $widget_obj->widget($args, $instance);
}
-function wp_widget_text_control($number) {
- $options = $newoptions = get_option('widget_text');
- if ( !is_array($options) )
- $options = $newoptions = array();
- if ( $_POST["text-submit-$number"] ) {
- $newoptions[$number]['title'] = strip_tags(stripslashes($_POST["text-title-$number"]));
- $newoptions[$number]['text'] = stripslashes($_POST["text-text-$number"]);
- if ( !current_user_can('unfiltered_html') )
- $newoptions[$number]['text'] = stripslashes(wp_filter_post_kses($newoptions[$number]['text']));
- }
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_text', $options);
- }
- $title = attribute_escape($options[$number]['title']);
- $text = format_to_edit($options[$number]['text']);
-?>
- <input style="width: 450px;" id="text-title-<?php echo $number; ?>" name="text-title-<?php echo $number; ?>" type="text" value="<?php echo $title; ?>" />
- <textarea style="width: 450px; height: 280px;" id="text-text-<?php echo $number; ?>" name="text-text-<?php echo $number; ?>"><?php echo $text; ?></textarea>
- <input type="hidden" id="text-submit-<?php echo "$number"; ?>" name="text-submit-<?php echo "$number"; ?>" value="1" />
-<?php
+/**
+ * Retrieves the widget ID base value.
+ *
+ * @since 2.8.0
+ *
+ * @param string $id Widget ID.
+ * @return string Widget ID base.
+ */
+function _get_widget_id_base( $id ) {
+ return preg_replace( '/-[0-9]+$/', '', $id );
}
-function wp_widget_text_setup() {
- $options = $newoptions = get_option('widget_text');
- if ( isset($_POST['text-number-submit']) ) {
- $number = (int) $_POST['text-number'];
- if ( $number > 9 ) $number = 9;
- if ( $number < 1 ) $number = 1;
- $newoptions['number'] = $number;
- }
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_text', $options);
- wp_widget_text_register($options['number']);
- }
+/**
+ * Handle sidebars config after theme change
+ *
+ * @access private
+ * @since 3.3.0
+ *
+ * @global array $sidebars_widgets
+ */
+function _wp_sidebars_changed() {
+ global $sidebars_widgets;
+
+ if ( ! is_array( $sidebars_widgets ) )
+ $sidebars_widgets = wp_get_sidebars_widgets();
+
+ retrieve_widgets(true);
}
-function wp_widget_text_page() {
- $options = $newoptions = get_option('widget_text');
-?>
- <div class="wrap">
- <form method="POST">
- <h2><?php _e('Text Widgets'); ?></h2>
- <p style="line-height: 30px;"><?php _e('How many text widgets would you like?'); ?>
- <select id="text-number" name="text-number" value="<?php echo $options['number']; ?>">
-<?php for ( $i = 1; $i < 10; ++$i ) echo "<option value='$i' ".($options['number']==$i ? "selected='selected'" : '').">$i</option>"; ?>
- </select>
- <span class="submit"><input type="submit" name="text-number-submit" id="text-number-submit" value="<?php echo attribute_escape(__('Save')); ?>" /></span></p>
- </form>
- </div>
-<?php
-}
+/**
+ * Look for "lost" widgets, this has to run at least on each theme change.
+ *
+ * @since 2.8.0
+ *
+ * @global array $wp_registered_sidebars
+ * @global array $sidebars_widgets
+ * @global array $wp_registered_widgets
+ *
+ * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value
+ * of 'customize' defers updates for the Customizer.
+ * @return array|void
+ */
+function retrieve_widgets( $theme_changed = false ) {
+ global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;
+
+ $registered_sidebar_keys = array_keys( $wp_registered_sidebars );
+ $orphaned = 0;
+
+ $old_sidebars_widgets = get_theme_mod( 'sidebars_widgets' );
+ if ( is_array( $old_sidebars_widgets ) ) {
+ // time() that sidebars were stored is in $old_sidebars_widgets['time']
+ $_sidebars_widgets = $old_sidebars_widgets['data'];
+
+ if ( 'customize' !== $theme_changed ) {
+ remove_theme_mod( 'sidebars_widgets' );
+ }
-function wp_widget_text_register() {
- $options = get_option('widget_text');
- $number = $options['number'];
- if ( $number < 1 ) $number = 1;
- if ( $number > 9 ) $number = 9;
- $dims = array('width' => 460, 'height' => 350);
- $class = array('classname' => 'widget_text');
- for ($i = 1; $i <= 9; $i++) {
- $name = sprintf(__('Text %d'), $i);
- $id = "text-$i"; // Never never never translate an id
- wp_register_sidebar_widget($id, $name, $i <= $number ? 'wp_widget_text' : /* unregister */ '', $class, $i);
- wp_register_widget_control($id, $name, $i <= $number ? 'wp_widget_text_control' : /* unregister */ '', $dims, $i);
- }
- add_action('sidebar_admin_setup', 'wp_widget_text_setup');
- add_action('sidebar_admin_page', 'wp_widget_text_page');
-}
+ foreach ( $_sidebars_widgets as $sidebar => $widgets ) {
+ if ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
+ continue;
+ }
-function wp_widget_categories($args, $number = 1) {
- extract($args);
- $options = get_option('widget_categories');
+ if ( !in_array( $sidebar, $registered_sidebar_keys ) ) {
+ $_sidebars_widgets['orphaned_widgets_' . ++$orphaned] = $widgets;
+ unset( $_sidebars_widgets[$sidebar] );
+ }
+ }
+ } else {
+ if ( empty( $sidebars_widgets ) )
+ return;
- $c = $options[$number]['count'] ? '1' : '0';
- $h = $options[$number]['hierarchical'] ? '1' : '0';
- $d = $options[$number]['dropdown'] ? '1' : '0';
+ unset( $sidebars_widgets['array_version'] );
- $title = empty($options[$number]['title']) ? __('Categories') : $options[$number]['title'];
+ $old = array_keys($sidebars_widgets);
+ sort($old);
+ sort($registered_sidebar_keys);
- echo $before_widget;
- echo $before_title . $title . $after_title;
+ if ( $old == $registered_sidebar_keys )
+ return;
- $cat_args = "orderby=name&show_count={$c}&hierarchical={$h}";
+ $_sidebars_widgets = array(
+ 'wp_inactive_widgets' => !empty( $sidebars_widgets['wp_inactive_widgets'] ) ? $sidebars_widgets['wp_inactive_widgets'] : array()
+ );
- if ( $d ) {
- wp_dropdown_categories($cat_args . '&show_option_none= ' . __('Select Category'));
-?>
+ unset( $sidebars_widgets['wp_inactive_widgets'] );
-<script lang='javascript'><!--
- var dropdown = document.getElementById("cat");
- function onCatChange() {
- if ( dropdown.options[dropdown.selectedIndex].value > 0 ) {
- location.href = "<?php echo get_option('home'); ?>/?cat="+dropdown.options[dropdown.selectedIndex].value;
+ foreach ( $wp_registered_sidebars as $id => $settings ) {
+ if ( $theme_changed ) {
+ $_sidebars_widgets[$id] = array_shift( $sidebars_widgets );
+ } else {
+ // no theme change, grab only sidebars that are currently registered
+ if ( isset( $sidebars_widgets[$id] ) ) {
+ $_sidebars_widgets[$id] = $sidebars_widgets[$id];
+ unset( $sidebars_widgets[$id] );
+ }
+ }
}
- }
- dropdown.onchange = onCatChange;
---></script>
-<?php
- } else {
-?>
- <ul>
- <?php wp_list_categories($cat_args . '&title_li='); ?>
- </ul>
-<?php
+ foreach ( $sidebars_widgets as $val ) {
+ if ( is_array($val) && ! empty( $val ) )
+ $_sidebars_widgets['orphaned_widgets_' . ++$orphaned] = $val;
+ }
}
- echo $after_widget;
-}
+ // discard invalid, theme-specific widgets from sidebars
+ $shown_widgets = array();
-function wp_widget_categories_control( $number ) {
- $options = $newoptions = get_option('widget_categories');
+ foreach ( $_sidebars_widgets as $sidebar => $widgets ) {
+ if ( !is_array($widgets) )
+ continue;
- if ( !is_array( $options ) ) {
- $options = $newoptions = get_option( 'widget_categories' );
- }
-
- if ( $_POST['categories-submit-' . $number] ) {
- $newoptions[$number]['count'] = isset($_POST['categories-count-' . $number]);
- $newoptions[$number]['hierarchical'] = isset($_POST['categories-hierarchical-' . $number]);
- $newoptions[$number]['dropdown'] = isset($_POST['categories-dropdown-' . $number]);
- $newoptions[$number]['title'] = strip_tags(stripslashes($_POST['categories-title-' . $number]));
- }
+ $_widgets = array();
+ foreach ( $widgets as $widget ) {
+ if ( isset($wp_registered_widgets[$widget]) )
+ $_widgets[] = $widget;
+ }
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_categories', $options);
+ $_sidebars_widgets[$sidebar] = $_widgets;
+ $shown_widgets = array_merge($shown_widgets, $_widgets);
}
- $title = attribute_escape( $options[$number]['title'] );
-?>
- <p><label for="categories-title-<?php echo $number; ?>">
- <?php _e( 'Title:' ); ?> <input style="width:300px" id="categories-title-<?php echo $number; ?>" name="categories-title-<?php echo $number; ?>" type="text" value="<?php echo $title; ?>" />
- </label></p>
-
- <p><label for="categories-dropdown-<?php echo $number; ?>">
- <input type="checkbox" class="checkbox" id="categories-dropdown-<?php echo $number; ?>" name="categories-dropdown-<?php echo $number; ?>"<?php echo $options[$number]['dropdown'] ? ' checked="checked"' : ''; ?> /> <?php _e( 'Show as dropdown' ); ?>
- </label></p>
-
- <p><label for="categories-count-<?php echo $number; ?>">
- <input type="checkbox" class="checkbox" id="categories-count-<?php echo $number; ?>" name="categories-count-<?php echo $number; ?>"<?php echo $options[$number]['count'] ? ' checked="checked"' : ''; ?> /> <?php _e( 'Show post counts' ); ?>
- </label></p>
+ $sidebars_widgets = $_sidebars_widgets;
+ unset($_sidebars_widgets, $_widgets);
- <p><label for="categories-hierarchical-<?php echo $number; ?>">
- <input type="checkbox" class="checkbox" id="categories-hierarchical-<?php echo $number; ?>" name="categories-hierarchical-<?php echo $number; ?>"<?php echo $options[$number]['hierarchical'] ? ' checked="checked"' : ''; ?> /> <?php _e( 'Show hierarchy' ); ?>
- </label></p>
+ // find hidden/lost multi-widget instances
+ $lost_widgets = array();
+ foreach ( $wp_registered_widgets as $key => $val ) {
+ if ( in_array($key, $shown_widgets, true) )
+ continue;
- <input type="hidden" id="categories-submit-<?php echo $number; ?>" name="categories-submit-<?php echo $number; ?>" value="1" />
-<?php
-}
-
-function wp_widget_categories_setup() {
- $options = $newoptions = get_option( 'widget_categories' );
+ $number = preg_replace('/.+?-([0-9]+)$/', '$1', $key);
- if ( isset( $_POST['categories-number-submit'] ) ) {
- $number = (int) $_POST['categories-number'];
-
- if ( $number > 9 ) {
- $number = 9;
- } elseif ( $number < 1 ) {
- $number = 1;
- }
+ if ( 2 > (int) $number )
+ continue;
- $newoptions['number'] = $number;
+ $lost_widgets[] = $key;
}
- if ( $newoptions != $options ) {
- $options = $newoptions;
- update_option( 'widget_categories', $options );
- wp_widget_categories_register( $options['number'] );
+ $sidebars_widgets['wp_inactive_widgets'] = array_merge($lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets']);
+ if ( 'customize' !== $theme_changed ) {
+ wp_set_sidebars_widgets( $sidebars_widgets );
}
-}
-function wp_widget_categories_page() {
- $options = get_option( 'widget_categories' );
-?>
- <div class="wrap">
- <form method="post">
- <h2><?php _e( 'Categories Widgets' ); ?></h2>
- <p style="line-height: 30px;"><?php _e( 'How many categories widgets would you like?' ); ?>
- <select id="categories-number" name="categories-number" value="<?php echo attribute_escape( $options['number'] ); ?>">
- <?php
- for ( $i = 1; $i < 10; $i++ ) {
- echo '<option value="' . $i . '"' . ( $i == $options['number'] ? ' selected="selected"' : '' ) . '>' . $i . "</option>\n";
- }
- ?>
- </select>
- <span class="submit">
- <input type="submit" value="<?php echo attribute_escape( __( 'Save' ) ); ?>" id="categories-number-submit" name="categories-number-submit" />
- </span>
- </p>
- </form>
- </div>
-<?php
+ return $sidebars_widgets;
}
-function wp_widget_categories_upgrade() {
- $options = get_option( 'widget_categories' );
-
- $newoptions = array( 'number' => 1, 1 => $options );
-
- update_option( 'widget_categories', $newoptions );
-
- $sidebars_widgets = get_option( 'sidebars_widgets' );
- if ( is_array( $sidebars_widgets ) ) {
- foreach ( $sidebars_widgets as $sidebar => $widgets ) {
- if ( is_array( $widgets ) ) {
- foreach ( $widgets as $widget )
- $new_widgets[$sidebar][] = ( $widget == 'categories' ) ? 'categories-1' : $widget;
- } else {
- $new_widgets[$sidebar] = $widgets;
- }
- }
- if ( $new_widgets != $sidebars_widgets )
- update_option( 'sidebars_widgets', $new_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 ( isset( $_POST['categories-submit'] ) ) {
- $_POST['categories-submit-1'] = $_POST['categories-submit'];
- $_POST['categories-count-1'] = $_POST['categories-count'];
- $_POST['categories-hierarchical-1'] = $_POST['categories-hierarchical'];
- $_POST['categories-dropdown-1'] = $_POST['categories-dropdown'];
- $_POST['categories-title-1'] = $_POST['categories-title'];
- foreach ( $_POST as $k => $v )
- if ( substr($k, -5) == 'order' )
- $_POST[$k] = str_replace('categories', 'categories-1', $v);
+ if ( is_wp_error($rss) ) {
+ if ( is_admin() || current_user_can('manage_options') )
+ echo '<p>' . sprintf( __('<strong>RSS Error</strong>: %s'), $rss->get_error_message() ) . '</p>';
+ return;
}
- return $newoptions;
-}
+ $default_args = array( 'show_author' => 0, 'show_date' => 0, 'show_summary' => 0, 'items' => 0 );
+ $args = wp_parse_args( $args, $default_args );
-function wp_widget_categories_register() {
- $options = get_option( 'widget_categories' );
- if ( !isset($options['number']) )
- $options = wp_widget_categories_upgrade();
- $number = (int) $options['number'];
+ $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 ( $number > 9 ) {
- $number = 9;
- } elseif ( $number < 1 ) {
- $number = 1;
+ if ( !$rss->get_item_quantity() ) {
+ echo '<ul><li>' . __( 'An error has occurred, which probably means the feed is down. Try again later.' ) . '</li></ul>';
+ $rss->__destruct();
+ unset($rss);
+ return;
}
- $dims = array( 'width' => 350, 'height' => 170 );
- $class = array( 'classname' => 'widget_categories' );
+ echo '<ul>';
+ foreach ( $rss->get_items( 0, $items ) as $item ) {
+ $link = $item->get_link();
+ while ( stristr( $link, 'http' ) != $link ) {
+ $link = substr( $link, 1 );
+ }
+ $link = esc_url( strip_tags( $link ) );
- for ( $i = 1; $i <= 9; $i++ ) {
- $name = sprintf( __( 'Categories %d' ), $i );
- $id = 'categories-' . $i;
+ $title = esc_html( trim( strip_tags( $item->get_title() ) ) );
+ if ( empty( $title ) ) {
+ $title = __( 'Untitled' );
+ }
- $widget_callback = ( $i <= $number ) ? 'wp_widget_categories' : '';
- $control_callback = ( $i <= $number ) ? 'wp_widget_categories_control' : '';
+ $desc = @html_entity_decode( $item->get_description(), ENT_QUOTES, get_option( 'blog_charset' ) );
+ $desc = esc_attr( wp_trim_words( $desc, 55, ' […]' ) );
- wp_register_sidebar_widget( $id, $name, $widget_callback, $class, $i );
- wp_register_widget_control( $id, $name, $control_callback, $dims, $i );
- }
+ $summary = '';
+ if ( $show_summary ) {
+ $summary = $desc;
- add_action( 'sidebar_admin_setup', 'wp_widget_categories_setup' );
- add_action( 'sidebar_admin_page', 'wp_widget_categories_page' );
-}
+ // Change existing [...] to […].
+ if ( '[...]' == substr( $summary, -5 ) ) {
+ $summary = substr( $summary, 0, -5 ) . '[…]';
+ }
-function wp_widget_recent_entries($args) {
- if ( $output = wp_cache_get('widget_recent_entries') )
- return print($output);
-
- ob_start();
- extract($args);
- $options = get_option('widget_recent_entries');
- $title = empty($options['title']) ? __('Recent Posts') : $options['title'];
- if ( !$number = (int) $options['number'] )
- $number = 10;
- else if ( $number < 1 )
- $number = 1;
- else if ( $number > 15 )
- $number = 15;
-
- $r = new WP_Query("showposts=$number&what_to_show=posts&nopaging=0&post_status=publish");
- if ($r->have_posts()) :
-?>
- <?php echo $before_widget; ?>
- <?php echo $before_title . $title . $after_title; ?>
- <ul>
- <?php while ($r->have_posts()) : $r->the_post(); ?>
- <li><a href="<?php the_permalink() ?>"><?php if ( get_the_title() ) the_title(); else the_ID(); ?> </a></li>
- <?php endwhile; ?>
- </ul>
- <?php echo $after_widget; ?>
-<?php
- endif;
- wp_cache_add('widget_recent_entries', ob_get_flush());
-}
+ $summary = '<div class="rssSummary">' . esc_html( $summary ) . '</div>';
+ }
-function wp_flush_widget_recent_entries() {
- wp_cache_delete('widget_recent_entries');
-}
+ $date = '';
+ if ( $show_date ) {
+ $date = $item->get_date( 'U' );
-add_action('save_post', 'wp_flush_widget_recent_entries');
-add_action('deleted_post', 'wp_flush_widget_recent_entries');
+ if ( $date ) {
+ $date = ' <span class="rss-date">' . date_i18n( get_option( 'date_format' ), $date ) . '</span>';
+ }
+ }
-function wp_widget_recent_entries_control() {
- $options = $newoptions = get_option('widget_recent_entries');
- if ( $_POST["recent-entries-submit"] ) {
- $newoptions['title'] = strip_tags(stripslashes($_POST["recent-entries-title"]));
- $newoptions['number'] = (int) $_POST["recent-entries-number"];
- }
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_recent_entries', $options);
- wp_flush_widget_recent_entries();
- }
- $title = attribute_escape($options['title']);
- if ( !$number = (int) $options['number'] )
- $number = 5;
-?>
- <p><label for="recent-entries-title"><?php _e('Title:'); ?> <input style="width: 250px;" id="recent-entries-title" name="recent-entries-title" type="text" value="<?php echo $title; ?>" /></label></p>
- <p><label for="recent-entries-number"><?php _e('Number of posts to show:'); ?> <input style="width: 25px; text-align: center;" id="recent-entries-number" name="recent-entries-number" type="text" value="<?php echo $number; ?>" /></label> <?php _e('(at most 15)'); ?></p>
- <input type="hidden" id="recent-entries-submit" name="recent-entries-submit" value="1" />
-<?php
-}
+ $author = '';
+ if ( $show_author ) {
+ $author = $item->get_author();
+ if ( is_object($author) ) {
+ $author = $author->get_name();
+ $author = ' <cite>' . esc_html( strip_tags( $author ) ) . '</cite>';
+ }
+ }
-function wp_widget_recent_comments($args) {
- global $wpdb, $comments, $comment;
- extract($args, EXTR_SKIP);
- $options = get_option('widget_recent_comments');
- $title = empty($options['title']) ? __('Recent Comments') : $options['title'];
- if ( !$number = (int) $options['number'] )
- $number = 5;
- else if ( $number < 1 )
- $number = 1;
- else if ( $number > 15 )
- $number = 15;
-
- if ( !$comments = wp_cache_get( 'recent_comments', 'widget' ) ) {
- $comments = $wpdb->get_results("SELECT comment_author, comment_author_url, comment_ID, comment_post_ID FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT $number");
- wp_cache_add( 'recent_comments', $comments, 'widget' );
+ if ( $link == '' ) {
+ echo "<li>$title{$date}{$summary}{$author}</li>";
+ } elseif ( $show_summary ) {
+ echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$summary}{$author}</li>";
+ } else {
+ echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$author}</li>";
+ }
}
-?>
-
- <?php echo $before_widget; ?>
- <?php echo $before_title . $title . $after_title; ?>
- <ul id="recentcomments"><?php
- if ( $comments ) : foreach ($comments as $comment) :
- echo '<li class="recentcomments">' . sprintf(__('%1$s on %2$s'), get_comment_author_link(), '<a href="'. get_permalink($comment->comment_post_ID) . '#comment-' . $comment->comment_ID . '">' . get_the_title($comment->comment_post_ID) . '</a>') . '</li>';
- endforeach; endif;?></ul>
- <?php echo $after_widget; ?>
-<?php
+ echo '</ul>';
+ $rss->__destruct();
+ unset($rss);
}
-function wp_delete_recent_comments_cache() {
- wp_cache_delete( 'recent_comments', 'widget' );
-}
-add_action( 'comment_post', 'wp_delete_recent_comments_cache' );
-add_action( 'wp_set_comment_status', 'wp_delete_recent_comments_cache' );
-
-function wp_widget_recent_comments_control() {
- $options = $newoptions = get_option('widget_recent_comments');
- if ( $_POST["recent-comments-submit"] ) {
- $newoptions['title'] = strip_tags(stripslashes($_POST["recent-comments-title"]));
- $newoptions['number'] = (int) $_POST["recent-comments-number"];
+/**
+ * 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;
}
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_recent_comments', $options);
- wp_delete_recent_comments_cache();
- }
- $title = attribute_escape($options['title']);
- if ( !$number = (int) $options['number'] )
- $number = 5;
-?>
- <p><label for="recent-comments-title"><?php _e('Title:'); ?> <input style="width: 250px;" id="recent-comments-title" name="recent-comments-title" type="text" value="<?php echo $title; ?>" /></label></p>
- <p><label for="recent-comments-number"><?php _e('Number of comments to show:'); ?> <input style="width: 25px; text-align: center;" id="recent-comments-number" name="recent-comments-number" type="text" value="<?php echo $number; ?>" /></label> <?php _e('(at most 15)'); ?></p>
- <input type="hidden" id="recent-comments-submit" name="recent-comments-submit" value="1" />
-<?php
-}
-function wp_widget_recent_comments_style() {
-?>
-<style type="text/css">.recentcomments a{display:inline !important;padding: 0 !important;margin: 0 !important;}</style>
-<?php
-}
+ $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'];
-function wp_widget_recent_comments_register() {
- $dims = array('width' => 320, 'height' => 90);
- $class = array('classname' => 'widget_recent_comments');
- wp_register_sidebar_widget('recent-comments', __('Recent Comments'), 'wp_widget_recent_comments', $class);
- wp_register_widget_control('recent-comments', __('Recent Comments'), 'wp_widget_recent_comments_control', $dims);
-
- if ( is_active_widget('wp_widget_recent_comments') )
- add_action('wp_head', 'wp_widget_recent_comments_style');
-}
-
-function wp_widget_rss($args, $number = 1) {
- require_once(ABSPATH . WPINC . '/rss.php');
- extract($args);
- $options = get_option('widget_rss');
- if ( isset($options['error']) && $options['error'] )
- return;
- $num_items = (int) $options[$number]['items'];
- $show_summary = $options[$number]['show_summary'];
- if ( empty($num_items) || $num_items < 1 || $num_items > 10 ) $num_items = 10;
- $url = $options[$number]['url'];
- while ( strstr($url, 'http') != $url )
- $url = substr($url, 1);
- if ( empty($url) )
- return;
- $rss = fetch_rss($url);
- $link = clean_url(strip_tags($rss->channel['link']));
- while ( strstr($link, 'http') != $link )
- $link = substr($link, 1);
- $desc = attribute_escape(strip_tags(html_entity_decode($rss->channel['description'], ENT_QUOTES)));
- $title = $options[$number]['title'];
- if ( empty($title) )
- $title = htmlentities(strip_tags($rss->channel['title']));
- if ( empty($title) )
- $title = $desc;
- if ( empty($title) )
- $title = __('Unknown Feed');
- $url = clean_url(strip_tags($url));
- if ( file_exists(dirname(__FILE__) . '/rss.png') )
- $icon = str_replace(ABSPATH, get_option('siteurl').'/', dirname(__FILE__)) . '/rss.png';
- else
- $icon = get_option('siteurl').'/wp-includes/images/rss.png';
- $title = "<a class='rsswidget' href='$url' title='" . attribute_escape(__('Syndicate this content')) ."'><img style='background:orange;color:white;border:none;' width='14' height='14' src='$icon' alt='RSS' /></a> <a class='rsswidget' href='$link' title='$desc'>$title</a>";
-?>
- <?php echo $before_widget; ?>
- <?php $title ? print($before_title . $title . $after_title) : null; ?>
-<?php
- if ( is_array( $rss->items ) && !empty( $rss->items ) ) {
- $rss->items = array_slice($rss->items, 0, $num_items);
- echo '<ul>';
- foreach ($rss->items as $item ) {
- while ( strstr($item['link'], 'http') != $item['link'] )
- $item['link'] = substr($item['link'], 1);
- $link = clean_url(strip_tags($item['link']));
- $title = attribute_escape(strip_tags($item['title']));
- if ( empty($title) )
- $title = __('Untitled');
- $desc = '';
- if ( $show_summary ) {
- $summary = '<div class="rssSummary">' . $item['description'] . '</div>';
- } else {
- if ( isset( $item['description'] ) && is_string( $item['description'] ) )
- $desc = str_replace(array("\n", "\r"), ' ', attribute_escape(strip_tags(html_entity_decode($item['description'], ENT_QUOTES))));
- $summary = '';
- }
- echo "<li><a class='rsswidget' href='$link' title='$desc'>$title</a>$summary</li>";
- }
- echo '</ul>';
- } else {
- echo '<ul><li>' . __( 'An error has occurred; the feed is probably down. Try again later.' ) . '</li></ul>';
+ if ( ! empty( $args['error'] ) ) {
+ echo '<p class="widget-error"><strong>' . sprintf( __( 'RSS Error: %s' ), $args['error'] ) . '</strong></p>';
}
- echo $after_widget;
-}
-
-function wp_widget_rss_control($number) {
- $options = $newoptions = get_option('widget_rss');
- if ( $_POST["rss-submit-$number"] ) {
- $newoptions[$number]['items'] = (int) $_POST["rss-items-$number"];
- $url = sanitize_url(strip_tags(stripslashes($_POST["rss-url-$number"])));
- $newoptions[$number]['title'] = trim(strip_tags(stripslashes($_POST["rss-title-$number"])));
- if ( $url !== $options[$number]['url'] ) {
- require_once(ABSPATH . WPINC . '/rss.php');
- $rss = fetch_rss($url);
- if ( is_object($rss) ) {
- $newoptions[$number]['url'] = $url;
- $newoptions[$number]['error'] = false;
- } else {
- $newoptions[$number]['error'] = true;
- $newoptions[$number]['url'] = wp_specialchars(__('Error: could not find an RSS or ATOM feed at that URL.'), 1);
- $error = sprintf(__('Error in RSS %1$d: %2$s'), $number, $newoptions[$number]['error']);
- }
- }
- }
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_rss', $options);
- }
- $url = attribute_escape($options[$number]['url']);
- $items = (int) $options[$number]['items'];
- $title = attribute_escape($options[$number]['title']);
- if ( empty($items) || $items < 1 ) $items = 10;
+ $esc_number = esc_attr( $args['number'] );
+ if ( $inputs['url'] ) :
?>
- <p style="text-align:center;"><?php _e('Enter the RSS feed URL here:'); ?></p>
- <input style="width: 400px;" id="rss-url-<?php echo "$number"; ?>" name="rss-url-<?php echo "$number"; ?>" type="text" value="<?php echo $url; ?>" />
- <p style="text-align:center;"><?php _e('Give the feed a title (optional):'); ?></p>
- <input style="width: 400px;" id="rss-title-<?php echo "$number"; ?>" name="rss-title-<?php echo "$number"; ?>" type="text" value="<?php echo $title; ?>" />
- <p style="text-align:center; line-height: 30px;"><?php _e('How many items would you like to display?'); ?> <select id="rss-items-<?php echo $number; ?>" name="rss-items-<?php echo $number; ?>"><?php for ( $i = 1; $i <= 10; ++$i ) echo "<option value='$i' ".($items==$i ? "selected='selected'" : '').">$i</option>"; ?></select></p>
- <input type="hidden" id="rss-submit-<?php echo "$number"; ?>" name="rss-submit-<?php echo "$number"; ?>" value="1" />
-<?php
-}
-
-function wp_widget_rss_setup() {
- $options = $newoptions = get_option('widget_rss');
- if ( isset($_POST['rss-number-submit']) ) {
- $number = (int) $_POST['rss-number'];
- if ( $number > 9 ) $number = 9;
- if ( $number < 1 ) $number = 1;
- $newoptions['number'] = $number;
+ <p><label for="rss-url-<?php echo $esc_number; ?>"><?php _e( 'Enter the RSS feed URL here:' ); ?></label>
+ <input class="widefat" id="rss-url-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][url]" type="text" value="<?php echo esc_url( $args['url'] ); ?>" /></p>
+<?php endif; if ( $inputs['title'] ) : ?>
+ <p><label for="rss-title-<?php echo $esc_number; ?>"><?php _e( 'Give the feed a title (optional):' ); ?></label>
+ <input class="widefat" id="rss-title-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][title]" type="text" value="<?php echo esc_attr( $args['title'] ); ?>" /></p>
+<?php endif; if ( $inputs['items'] ) : ?>
+ <p><label for="rss-items-<?php echo $esc_number; ?>"><?php _e( 'How many items would you like to display?' ); ?></label>
+ <select id="rss-items-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][items]">
+ <?php
+ for ( $i = 1; $i <= 20; ++$i ) {
+ echo "<option value='$i' " . selected( $args['items'], $i, false ) . ">$i</option>";
}
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_rss', $options);
- wp_widget_rss_register($options['number']);
- }
-}
-
-function wp_widget_rss_page() {
- $options = $newoptions = get_option('widget_rss');
+ ?>
+ </select></p>
+<?php endif; if ( $inputs['show_summary'] ) : ?>
+ <p><input id="rss-show-summary-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_summary]" type="checkbox" value="1" <?php checked( $args['show_summary'] ); ?> />
+ <label for="rss-show-summary-<?php echo $esc_number; ?>"><?php _e( 'Display item content?' ); ?></label></p>
+<?php endif; if ( $inputs['show_author'] ) : ?>
+ <p><input id="rss-show-author-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_author]" type="checkbox" value="1" <?php checked( $args['show_author'] ); ?> />
+ <label for="rss-show-author-<?php echo $esc_number; ?>"><?php _e( 'Display item author if available?' ); ?></label></p>
+<?php endif; if ( $inputs['show_date'] ) : ?>
+ <p><input id="rss-show-date-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_date]" type="checkbox" value="1" <?php checked( $args['show_date'] ); ?>/>
+ <label for="rss-show-date-<?php echo $esc_number; ?>"><?php _e( 'Display item date?' ); ?></label></p>
+<?php
+ endif;
+ foreach ( array_keys($default_inputs) as $input ) :
+ if ( 'hidden' === $inputs[$input] ) :
+ $id = str_replace( '_', '-', $input );
?>
- <div class="wrap">
- <form method="POST">
- <h2><?php _e('RSS Feed Widgets'); ?></h2>
- <p style="line-height: 30px;"><?php _e('How many RSS widgets would you like?'); ?>
- <select id="rss-number" name="rss-number" value="<?php echo $options['number']; ?>">
-<?php for ( $i = 1; $i < 10; ++$i ) echo "<option value='$i' ".($options['number']==$i ? "selected='selected'" : '').">$i</option>"; ?>
- </select>
- <span class="submit"><input type="submit" name="rss-number-submit" id="rss-number-submit" value="<?php echo attribute_escape(__('Save')); ?>" /></span></p>
- </form>
- </div>
+ <input type="hidden" id="rss-<?php echo esc_attr( $id ); ?>-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][<?php echo esc_attr( $input ); ?>]" value="<?php echo esc_attr( $args[ $input ] ); ?>" />
<?php
+ endif;
+ endforeach;
}
-function wp_widget_rss_register() {
- $options = get_option('widget_rss');
- $number = $options['number'];
- if ( $number < 1 ) $number = 1;
- if ( $number > 9 ) $number = 9;
- $dims = array('width' => 410, 'height' => 200);
- $class = array('classname' => 'widget_rss');
- for ($i = 1; $i <= 9; $i++) {
- $name = sprintf(__('RSS %d'), $i);
- $id = "rss-$i"; // Never never never translate an id
- wp_register_sidebar_widget($id, $name, $i <= $number ? 'wp_widget_rss' : /* unregister */ '', $class, $i);
- wp_register_widget_control($id, $name, $i <= $number ? 'wp_widget_rss_control' : /* unregister */ '', $dims, $i);
- }
- add_action('sidebar_admin_setup', 'wp_widget_rss_setup');
- add_action('sidebar_admin_page', 'wp_widget_rss_page');
-}
-
-function wp_widget_tag_cloud($args) {
- extract($args);
- $options = get_option('widget_tag_cloud');
- $title = empty($options['title']) ? __('Tags') : $options['title'];
-
- echo $before_widget;
- echo $before_title . $title . $after_title;
- wp_tag_cloud();
- echo $after_widget;
-}
-
-function wp_widget_tag_cloud_control() {
- $options = $newoptions = get_option('widget_tag_cloud');
-
- if ( $_POST['tag-cloud-submit'] ) {
- $newoptions['title'] = strip_tags(stripslashes($_POST['tag-cloud-title']));
- }
+/**
+ * Process RSS feed widget data and optionally retrieve feed items.
+ *
+ * The feed widget can not have more than 20 items or it will reset back to the
+ * default, which is 10.
+ *
+ * The resulting array has the feed title, feed url, feed link (from channel),
+ * feed items, error (if any), and whether to show summary, author, and date.
+ * All respectively in the order of the array elements.
+ *
+ * @since 2.5.0
+ *
+ * @param array $widget_rss RSS widget feed data. Expects unescaped data.
+ * @param bool $check_feed Optional, default is true. Whether to check feed for errors.
+ * @return array
+ */
+function wp_widget_rss_process( $widget_rss, $check_feed = true ) {
+ $items = (int) $widget_rss['items'];
+ if ( $items < 1 || 20 < $items )
+ $items = 10;
+ $url = esc_url_raw( strip_tags( $widget_rss['url'] ) );
+ $title = isset( $widget_rss['title'] ) ? trim( strip_tags( $widget_rss['title'] ) ) : '';
+ $show_summary = isset( $widget_rss['show_summary'] ) ? (int) $widget_rss['show_summary'] : 0;
+ $show_author = isset( $widget_rss['show_author'] ) ? (int) $widget_rss['show_author'] :0;
+ $show_date = isset( $widget_rss['show_date'] ) ? (int) $widget_rss['show_date'] : 0;
+
+ if ( $check_feed ) {
+ $rss = fetch_feed($url);
+ $error = false;
+ $link = '';
+ if ( is_wp_error($rss) ) {
+ $error = $rss->get_error_message();
+ } else {
+ $link = esc_url(strip_tags($rss->get_permalink()));
+ while ( stristr($link, 'http') != $link )
+ $link = substr($link, 1);
- if ( $options != $newoptions ) {
- $options = $newoptions;
- update_option('widget_tag_cloud', $options);
+ $rss->__destruct();
+ unset($rss);
+ }
}
- $title = attribute_escape( $options['title'] );
-?>
- <p><label for="tag-cloud-title">
- <?php _e('Title:') ?> <input type="text" style="width:300px" id="tag-cloud-title" name="tag-cloud-title" value="<?php echo $title ?>" /></label>
- </p>
- <input type="hidden" name="tag-cloud-submit" id="tag-cloud-submit" value="1" />
-<?php
+ 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;
- $GLOBALS['wp_register_widget_defaults'] = true;
+ register_widget('WP_Widget_Pages');
- $dims90 = array( 'height' => 90, 'width' => 300 );
- $dims100 = array( 'height' => 100, 'width' => 300 );
- $dims150 = array( 'height' => 150, 'width' => 300 );
+ register_widget('WP_Widget_Calendar');
- $class = array('classname' => 'widget_pages');
- wp_register_sidebar_widget('pages', __('Pages'), 'wp_widget_pages', $class);
- wp_register_widget_control('pages', __('Pages'), 'wp_widget_pages_control', $dims150);
+ register_widget('WP_Widget_Archives');
- $class['classname'] = 'widget_calendar';
- wp_register_sidebar_widget('calendar', __('Calendar'), 'wp_widget_calendar', $class);
- wp_register_widget_control('calendar', __('Calendar'), 'wp_widget_calendar_control', $dims90);
+ if ( get_option( 'link_manager_enabled' ) )
+ register_widget('WP_Widget_Links');
- $class['classname'] = 'widget_archives';
- wp_register_sidebar_widget('archives', __('Archives'), 'wp_widget_archives', $class);
- wp_register_widget_control('archives', __('Archives'), 'wp_widget_archives_control', $dims100);
+ register_widget('WP_Widget_Meta');
- $class['classname'] = 'widget_links';
- wp_register_sidebar_widget('links', __('Links'), 'wp_widget_links', $class);
+ register_widget('WP_Widget_Search');
- $class['classname'] = 'widget_meta';
- wp_register_sidebar_widget('meta', __('Meta'), 'wp_widget_meta', $class);
- wp_register_widget_control('meta', __('Meta'), 'wp_widget_meta_control', $dims90);
+ register_widget('WP_Widget_Text');
- $class['classname'] = 'widget_search';
- wp_register_sidebar_widget('search', __('Search'), 'wp_widget_search', $class);
+ register_widget('WP_Widget_Categories');
- $class['classname'] = 'widget_recent_entries';
- wp_register_sidebar_widget('recent-posts', __('Recent Posts'), 'wp_widget_recent_entries', $class);
- wp_register_widget_control('recent-posts', __('Recent Posts'), 'wp_widget_recent_entries_control', $dims90);
+ register_widget('WP_Widget_Recent_Posts');
- $class['classname'] = 'widget_tag_cloud';
- wp_register_sidebar_widget('tag_cloud', __('Tag Cloud'), 'wp_widget_tag_cloud', $class);
- wp_register_widget_control('tag_cloud', __('Tag Cloud'), 'wp_widget_tag_cloud_control', 'width=300&height=160');
+ register_widget('WP_Widget_Recent_Comments');
- wp_widget_categories_register();
- wp_widget_text_register();
- wp_widget_rss_register();
- wp_widget_recent_comments_register();
+ register_widget('WP_Widget_RSS');
- $GLOBALS['wp_register_widget_defaults'] = false;
+ register_widget('WP_Widget_Tag_Cloud');
- do_action('widgets_init');
-}
-
-add_action('init', 'wp_widgets_init', 1);
+ register_widget('WP_Nav_Menu_Widget');
-?>
+ /**
+ * Fires after all default WordPress widgets have been registered.
+ *
+ * @since 2.2.0
+ */
+ do_action( 'widgets_init' );
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff