X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/wordpress.git/blobdiff_plain/76aea3697c6043c1613370f172395b4f65ee71f0..c55863f11e8589bf8d4a5698bf15752406654f1c:/wp-includes/widgets.php
diff --git a/wp-includes/widgets.php b/wp-includes/widgets.php
index 73e1f6e8..6bd99473 100644
--- a/wp-includes/widgets.php
+++ b/wp-includes/widgets.php
@@ -1,15 +1,479 @@
' . __('There are no options for this widget.') . '
';
+ return 'noform';
+ }
+
+ // Functions you'll need to call.
+
+ /**
+ * PHP5 constructor
+ *
+ * @param string $id_base Optional Base ID for the widget, lower case,
+ * if left empty a portion of the widget's class name will be used. Has to be unique.
+ * @param string $name Name for the widget displayed on the configuration page.
+ * @param array $widget_options Optional Passed to wp_register_sidebar_widget()
+ * - description: shown on the configuration page
+ * - classname
+ * @param array $control_options Optional Passed to wp_register_widget_control()
+ * - width: required if more than 250px
+ * - height: currently not used but may be needed in the future
+ */
+ 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
+ */
+ 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
+ */
+ function get_field_name($field_name) {
+ return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']';
+ }
+
+ /**
+ * Constructs id attributes for use in form() fields
+ *
+ * This function should be used in form() methods to create id attributes for fields to be saved by update()
+ *
+ * @param string $field_name Field name
+ * @return string ID attribute for $field_name
+ */
+ function get_field_id($field_name) {
+ return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name;
+ }
+
+ // Private Functions. Don't worry about these.
+
+ 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();
+ }
+ }
+
+ function _set($number) {
+ $this->number = $number;
+ $this->id = $this->id_base . '-' . $number;
+ }
+
+ function _get_display_callback() {
+ return array($this, 'display_callback');
+ }
+
+ function _get_update_callback() {
+ return array($this, 'update_callback');
+ }
+
+ function _get_form_callback() {
+ return array($this, 'form_callback');
+ }
+
+ /** Generate the actual widget content.
+ * Just finds the instance and calls widget().
+ * Do NOT over-ride this function. */
+ function display_callback( $args, $widget_args = 1 ) {
+ 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];
+ // filters the widget's settings, return false to stop displaying the widget
+ $instance = apply_filters('widget_display_callback', $instance, $this, $args);
+ if ( false !== $instance )
+ $this->widget($args, $instance);
+ }
+ }
+
+ /** Deal with changed settings.
+ * Do NOT over-ride this function. */
+ function update_callback( $widget_args = 1 ) {
+ global $wp_registered_widgets;
+
+ if ( is_numeric($widget_args) )
+ $widget_args = array( 'number' => $widget_args );
+
+ $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
+ $all_instances = $this->get_settings();
+
+ // We need to update the data
+ if ( $this->updated )
+ return;
+
+ $sidebars_widgets = wp_get_sidebars_widgets();
+
+ if ( isset($_POST['delete_widget']) && $_POST['delete_widget'] ) {
+ // Delete the settings for this instance of the widget
+ if ( isset($_POST['the-widget-id']) )
+ $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();
+
+ $instance = $this->update($new_instance, $old_instance);
+
+ // filters the widget's settings before saving, return false to cancel saving (keep the old settings if updating)
+ $instance = apply_filters('widget_update_callback', $instance, $new_instance, $old_instance, $this);
+ if ( false !== $instance )
+ $all_instances[$number] = $instance;
+
+ break; // run only once
+ }
+ }
+
+ $this->save_settings($all_instances);
+ $this->updated = true;
+ }
+
+ /** Generate the control form.
+ * Do NOT over-ride this function. */
+ function form_callback( $widget_args = 1 ) {
+ if ( is_numeric($widget_args) )
+ $widget_args = array( 'number' => $widget_args );
+
+ $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'] ];
+ }
+
+ // filters the widget admin form before displaying, return false to stop displaying it
+ $instance = apply_filters('widget_form_callback', $instance, $this);
+
+ $return = null;
+ if ( false !== $instance ) {
+ $return = $this->form($instance);
+ // add extra fields in the widget form - be sure to set $return to null if you add any
+ // if the widget has no form the text echoed from the default form method can be hidden using css
+ do_action_ref_array( 'in_widget_form', array(&$this, &$return, $instance) );
+ }
+ return $return;
+ }
+
+ /** Helper function: Registers a single instance. */
+ function _register_one($number = -1) {
+ wp_register_sidebar_widget( $this->id, $this->name, $this->_get_display_callback(), $this->widget_options, array( 'number' => $number ) );
+ _register_widget_update_callback( $this->id_base, $this->_get_update_callback(), $this->control_options, array( 'number' => -1 ) );
+ _register_widget_form_callback( $this->id, $this->name, $this->_get_form_callback(), $this->control_options, array( 'number' => $number ) );
+ }
+
+ function save_settings($settings) {
+ $settings['_multiwidget'] = 1;
+ update_option( $this->option_name, $settings );
+ }
+
+ 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.
+ *
+ * @package WordPress
+ * @subpackage Widgets
+ * @since 2.8
+ */
+class WP_Widget_Factory {
+ var $widgets = array();
+
+ function WP_Widget_Factory() {
+ add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 );
+ }
+
+ function register($widget_class) {
+ $this->widgets[$widget_class] = new $widget_class();
+ }
+
+ function unregister($widget_class) {
+ if ( isset($this->widgets[$widget_class]) )
+ unset($this->widgets[$widget_class]);
+ }
+
+ 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 $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls;
+/** @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_updates = array();
+
+/**
+ * Private
+ */
+$_wp_sidebars_widgets = array();
+
+/**
+ * Private
+ */
+ $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
+ * @see WP_Widget_Factory
+ * @uses 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);
+}
+
+/**
+ * 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
+ * @see WP_Widget_Factory
+ * @uses 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);
+}
+
+/**
+ * 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.
+ *
+ * The default for the name is "Sidebar #", with '#' being replaced with the
+ * number the sidebar is currently when greater than one. If first sidebar, the
+ * name will be just "Sidebar". The default for id is "sidebar-" followed by the
+ * number the sidebar creation is currently at. If the id is provided, and multiple
+ * sidebars are being defined, the id will have "-2" appended, and so on.
+ *
+ * @since 2.2.0
+ *
+ * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here.
+ * @uses parse_str() Converts a string to an array to be used in the rest of the function.
+ * @uses register_sidebar() Sends single sidebar information [name, id] to this
+ * function to handle building the sidebar.
+ *
+ * @param int $number Number of sidebars to create.
+ * @param string|array $args Builds Sidebar based off of 'name' and 'id' values.
+ */
function register_sidebars($number = 1, $args = array()) {
global $wp_registered_sidebars;
$number = (int) $number;
@@ -17,53 +481,110 @@ function register_sidebars($number = 1, $args = array()) {
if ( is_string($args) )
parse_str($args, $args);
- for ( $i=1; $i <= $number; $i++ ) {
+ for ( $i = 1; $i <= $number; $i++ ) {
$_args = $args;
- if ( $number > 1 ) {
+ if ( $number > 1 )
$_args['name'] = isset($args['name']) ? sprintf($args['name'], $i) : sprintf(__('Sidebar %d'), $i);
- } else {
+ else
$_args['name'] = isset($args['name']) ? $args['name'] : __('Sidebar');
- }
- if (isset($args['id'])) {
+ // 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 ( isset($wp_registered_sidebars[$_args['id']]) )
+ $_args['id'] = $args['id'] . '-' . $n++;
} else {
$n = count($wp_registered_sidebars);
do {
- $n++;
- $_args['id'] = "sidebar-$n";
- } while (isset($wp_registered_sidebars[$_args['id']]));
+ $_args['id'] = 'sidebar-' . ++$n;
+ } while ( isset($wp_registered_sidebars[$_args['id']]) );
}
-
register_sidebar($_args);
}
}
+/**
+ * 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()
+ *
+ * Arguments passed as a string should be separated by '&':
+ *
+ * e.g. 'name=Sidebar&id=my_prefix_sidebar'
+ *
+ * The same arguments passed as an array:
+ *
+ * array(
+ * 'name' => 'Sidebar',
+ * 'id' => 'my_prefix_sidebar',
+ * )
+ *
+ * Arguments:
+ * name - The name or title of the sidebar displayed in the admin dashboard.
+ * id - The unique identifier by which the sidebar will be called.
+ * before_widget - HTML content that will be prepended to each widget's HTML output
+ * when assigned to this sidebar.
+ * after_widget - HTML content that will be appended to each widget's HTML output
+ * when assigned to this sidebar.
+ * before_title - HTML content that will be prepended to the sidebar title when displayed.
+ * after_title - HTML content that will be appended to the sidebar title when displayed.
+ *
+ * @since 2.2.0
+ * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
+ * @uses add_theme_support() to ensure widget support has been added.
+ *
+ * @param string|array $args Arguments for the sidebar being registered.
+ * @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;
$defaults = array(
'name' => sprintf(__('Sidebar %d'), $i ),
'id' => "sidebar-$i",
+ 'description' => '',
+ 'class' => '',
'before_widget' => '
',
'after_widget' => "
\n",
'before_title' => '
',
'after_title' => "
\n",
);
- $sidebar = array_merge($defaults, (array) $args);
+ $sidebar = wp_parse_args( $args, $defaults );
$wp_registered_sidebars[$sidebar['id']] = $sidebar;
+ add_theme_support('widgets');
+
+ do_action( 'register_sidebar', $sidebar );
+
return $sidebar['id'];
}
+/**
+ * Removes a sidebar from the list.
+ *
+ * @since 2.2.0
+ *
+ * @uses $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;
@@ -71,29 +592,28 @@ function unregister_sidebar( $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);
-
- call_user_func_array('wp_register_sidebar_widget', $args);
-}
-
+/**
+ * Register widget for use in sidebars.
+ *
+ * The default widget option is 'classname' that can be override.
+ *
+ * The function can also be used to unregister widgets when $output_callback
+ * parameter is an empty string.
+ *
+ * @since 2.2.0
+ *
+ * @uses $wp_registered_widgets Uses stored registered widgets.
+ * @uses $wp_register_widget_defaults Retrieves widget defaults.
+ *
+ * @param int|string $id Widget ID.
+ * @param string $name Widget display title.
+ * @param callback $output_callback Run when widget is called.
+ * @param array|string $options Optional. Widget Options.
+ * @param mixed $params,... Widget parameters to add to widget.
+ * @return null Will return if $output_callback is empty after removing widget.
+ */
function wp_register_sidebar_widget($id, $name, $output_callback, $options = array()) {
- global $wp_registered_widgets;
+ global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks;
$id = strtolower($id);
@@ -102,6 +622,17 @@ function wp_register_sidebar_widget($id, $name, $output_callback, $options = arr
return;
}
+ $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]);
+
+ return;
+ }
+
$defaults = array('classname' => $output_callback);
$options = wp_parse_args($options, $defaults);
$widget = array(
@@ -112,10 +643,24 @@ function wp_register_sidebar_widget($id, $name, $output_callback, $options = arr
);
$widget = array_merge($widget, $options);
- if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) )
+ if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) ) {
+ 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
+ *
+ * @param int|string $id Widget ID.
+ * @return string Widget description, if available. Null on failure to retrieve description.
+ */
function wp_widget_description( $id ) {
if ( !is_scalar($id) )
return;
@@ -123,54 +668,78 @@ function wp_widget_description( $id ) {
global $wp_registered_widgets;
if ( isset($wp_registered_widgets[$id]['description']) )
- return wp_specialchars( $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
+ *
+ * @param int|string $id sidebar ID.
+ * @return string Sidebar description, if available. Null on failure to retrieve description.
+ */
+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) {
+ 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];
- }
-
- $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);
-}
-
-/* $options: height, width, id_base
- * height: never used
- * width: width of fully expanded control form. Try hard to use the default width.
- * id_base: for multi-widgets (widgets which allow multiple instances such as the text widget), an id_base must be provided.
- * the widget id will ennd up looking like {$id_base}-{$unique_number}
+/**
+ * Registers widget control callback for customizing options.
+ *
+ * The options contains the 'height', 'width', and 'id_base' keys. The 'height'
+ * option is never used. The 'width' option is the width of the fully expanded
+ * control form, but try hard to use the default width. The 'id_base' is for
+ * multi-widgets (widgets which allow multiple instances such as the text
+ * widget), an id_base must be provided. The widget id will end up looking like
+ * {$id_base}-{$unique_number}.
+ *
+ * @since 2.2.0
+ *
+ * @param int|string $id Sidebar ID.
+ * @param string $name Sidebar display name.
+ * @param callback $control_callback Run when sidebar is displayed.
+ * @param array|string $options Optional. Widget options. See above long description.
+ * @param mixed $params,... Optional. Additional parameters to add to widget.
*/
function wp_register_widget_control($id, $name, $control_callback, $options = array()) {
- global $wp_registered_widget_controls;
-
+ 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;
+ }
+
+ 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]);
+
return;
}
@@ -191,16 +760,88 @@ function wp_register_widget_control($id, $name, $control_callback, $options = ar
$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 _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)
+ );
+
+ $widget = array_merge($widget, $options);
+ $wp_registered_widget_updates[$id_base] = $widget;
}
-function unregister_widget_control($id) {
- return wp_unregister_widget_control($id);
+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]) && !did_action( 'widgets_init' ) )
+ return;
+
+ $defaults = array('width' => 250, 'height' => 200 );
+ $options = wp_parse_args($options, $defaults);
+ $options['width'] = (int) $options['width'];
+ $options['height'] = (int) $options['height'];
+
+ $widget = array(
+ 'name' => $name,
+ 'id' => $id,
+ 'callback' => $form_callback,
+ 'params' => array_slice(func_get_args(), 4)
+ );
+ $widget = array_merge($widget, $options);
+
+ $wp_registered_widget_controls[$id] = $widget;
}
+/**
+ * Remove control callback for widget.
+ *
+ * @since 2.2.0
+ * @uses wp_register_widget_control() Unregisters by using empty callback.
+ *
+ * @param int|string $id Widget ID.
+ */
function wp_unregister_widget_control($id) {
return wp_register_widget_control($id, '', '');
}
+/**
+ * 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
+ *
+ * @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;
@@ -208,7 +849,7 @@ function dynamic_sidebar($index = 1) {
$index = "sidebar-$index";
} else {
$index = sanitize_title($index);
- foreach ( $wp_registered_sidebars as $key => $value ) {
+ foreach ( (array) $wp_registered_sidebars as $key => $value ) {
if ( sanitize_title($value['name']) == $index ) {
$index = $key;
break;
@@ -217,14 +858,17 @@ function dynamic_sidebar($index = 1) {
}
$sidebars_widgets = wp_get_sidebars_widgets();
-
- if ( empty($wp_registered_sidebars[$index]) || !array_key_exists($index, $sidebars_widgets) || !is_array($sidebars_widgets[$index]) || empty($sidebars_widgets[$index]) )
+ if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) {
return false;
+ }
$sidebar = $wp_registered_sidebars[$index];
$did_one = false;
- foreach ( $sidebars_widgets[$index] as $id ) {
+ foreach ( (array) $sidebars_widgets[$index] as $id ) {
+
+ if ( !isset($wp_registered_widgets[$id]) ) continue;
+
$params = array_merge(
array( array_merge( $sidebar, array('widget_id' => $id, 'widget_name' => $wp_registered_widgets[$id]['name']) ) ),
(array) $wp_registered_widgets[$id]['params']
@@ -245,6 +889,8 @@ function dynamic_sidebar($index = 1) {
$callback = $wp_registered_widgets[$id]['callback'];
+ do_action( 'dynamic_sidebar', $wp_registered_widgets[$id] );
+
if ( is_callable($callback) ) {
call_user_func_array($callback, $params);
$did_one = true;
@@ -254,29 +900,63 @@ function dynamic_sidebar($index = 1) {
return $did_one;
}
-/* @return mixed false if widget is not active or id of sidebar in which the widget is active
+/**
+ * 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
+ *
+ * @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.
*/
-function is_active_widget($callback, $widget_id = false) {
+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);
-
- if ( is_array($sidebars_widgets) ) foreach ( $sidebars_widgets as $sidebar => $widgets )
- if ( is_array($widgets) ) foreach ( $widgets as $widget )
- if ( isset($wp_registered_widgets[$widget]['callback']) && $wp_registered_widgets[$widget]['callback'] == $callback )
- if ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] )
- return $sidebar;
+ $sidebars_widgets = wp_get_sidebars_widgets();
+ if ( is_array($sidebars_widgets) ) {
+ foreach ( $sidebars_widgets as $sidebar => $widgets ) {
+ if ( $skip_inactive && 'wp_inactive_widgets' == $sidebar )
+ 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
+ *
+ * @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 ) {
+ foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
if ( count($sidebars_widgets[$index]) ) {
- foreach ( $sidebars_widgets[$index] as $widget )
+ foreach ( (array) $sidebars_widgets[$index] as $widget )
if ( array_key_exists($widget, $wp_registered_widgets) )
return true;
}
@@ -284,1286 +964,296 @@ function is_dynamic_sidebar() {
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;
- }
-
- $found = false;
-
- foreach ( $wp_registered_widgets as $widget_id => $widget ) {
- if ( strtolower($widget['name']) == strtolower($name) ) {
- $_sidebars_widgets[$index][$i] = $widget['id'];
- $found = true;
- break;
- } elseif ( sanitize_title($widget['name']) == sanitize_title($name) ) {
- $_sidebars_widgets[$index][$i] = $widget['id'];
- $found = true;
- break;
- }
- }
+/**
+ * Whether a sidebar is in use.
+ *
+ * @since 2.8
+ *
+ * @param mixed $index Sidebar name, id or number to check.
+ * @return bool true if the sidebar is in use, false otherwise.
+ */
+function is_active_sidebar( $index ) {
+ $index = ( is_int($index) ) ? "sidebar-$index" : sanitize_title($index);
+ $sidebars_widgets = wp_get_sidebars_widgets();
+ $is_active_sidebar = ! empty( $sidebars_widgets[$index] );
+ return $is_active_sidebar;
+}
- if ( $found )
- continue;
+/* Internal Functions */
- 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]);
- }
- }
+/**
+ * Retrieve full list of sidebars and their widgets.
+ *
+ * Will upgrade sidebar widget list, if needed. Will also save updated list, if
+ * needed.
+ *
+ * @since 2.2.0
+ * @access private
+ *
+ * @param bool $deprecated Not used (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' );
- // 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;
+ global $_wp_sidebars_widgets, $sidebars_widgets;
- $_sidebars_widgets['array_version'] = 3;
- $sidebars_widgets = $_sidebars_widgets;
- unset($_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());
- if ( $update )
- update_option('sidebars_widgets', $sidebars_widgets);
+ $sidebars_widgets = $_wp_sidebars_widgets;
+ } else {
+ $sidebars_widgets = get_option('sidebars_widgets', array());
}
- unset($sidebars_widgets['array_version']);
+ if ( is_array( $sidebars_widgets ) && isset($sidebars_widgets['array_version']) )
+ unset($sidebars_widgets['array_version']);
+ $sidebars_widgets = apply_filters('sidebars_widgets', $sidebars_widgets);
return $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
+ *
+ * @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' ) : apply_filters('widget_title', $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 ) ) {
-?>
-
-
-
-
-
-
- $settings );
- $sortby = stripslashes( $_POST['pages-sortby'] );
-
- 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'] );
-?>
-
-
-
- 'widget_pages', 'description' => __( "Your blog's WordPress Pages") );
- wp_register_sidebar_widget('pages', __('Pages'), 'wp_widget_pages', $widget_ops);
- wp_register_widget_control('pages', __('Pages'), 'wp_widget_pages_control' );
-
- $widget_ops = array('classname' => 'widget_calendar', 'description' => __( "A calendar of your blog's posts") );
- wp_register_sidebar_widget('calendar', __('Calendar'), 'wp_widget_calendar', $widget_ops);
- wp_register_widget_control('calendar', __('Calendar'), 'wp_widget_calendar_control' );
-
- $widget_ops = array('classname' => 'widget_archive', 'description' => __( "A monthly archive of your blog's posts") );
- wp_register_sidebar_widget('archives', __('Archives'), 'wp_widget_archives', $widget_ops);
- wp_register_widget_control('archives', __('Archives'), 'wp_widget_archives_control' );
-
- $widget_ops = array('classname' => 'widget_links', 'description' => __( "Your blogroll") );
- wp_register_sidebar_widget('links', __('Links'), 'wp_widget_links', $widget_ops);
-
- $widget_ops = array('classname' => 'widget_meta', 'description' => __( "Log in/out, admin, feed and WordPress links") );
- wp_register_sidebar_widget('meta', __('Meta'), 'wp_widget_meta', $widget_ops);
- wp_register_widget_control('meta', __('Meta'), 'wp_widget_meta_control' );
-
- $widget_ops = array('classname' => 'widget_search', 'description' => __( "A search form for your blog") );
- wp_register_sidebar_widget('search', __('Search'), 'wp_widget_search', $widget_ops);
-
- $widget_ops = array('classname' => 'widget_recent_entries', 'description' => __( "The most recent posts on your blog") );
- wp_register_sidebar_widget('recent-posts', __('Recent Posts'), 'wp_widget_recent_entries', $widget_ops);
- wp_register_widget_control('recent-posts', __('Recent Posts'), 'wp_widget_recent_entries_control' );
-
- $widget_ops = array('classname' => 'widget_tag_cloud', 'description' => __( "Your most used tags in cloud format") );
- wp_register_sidebar_widget('tag_cloud', __('Tag Cloud'), 'wp_widget_tag_cloud', $widget_ops);
- wp_register_widget_control('tag_cloud', __('Tag Cloud'), 'wp_widget_tag_cloud_control' );
-
- wp_widget_categories_register();
- wp_widget_text_register();
- wp_widget_rss_register();
- wp_widget_recent_comments_register();
-
- do_action('widgets_init');
-}
-
-add_action('init', 'wp_widgets_init', 1);
-
-/* Pattern for multi-widget (allows multiple instances such as the text widget).
-
-// Displays widget on blag
-// $widget_args: number
-// number: which of the several widgets of this type do we mean
-function widget_many( $args, $widget_args = 1 ) {
- extract( $args, EXTR_SKIP );
- if ( is_numeric($widget_args) )
- $widget_args = array( 'number' => $widget_args );
- $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
- extract( $widget_args, EXTR_SKIP );
- // Data should be stored as array: array( number => data for that instance of the widget, ... )
- $options = get_option('widget_many');
- if ( !isset($options[$number]) )
- return;
-
- echo $before_widget;
-
- // Do stuff for this widget, drawing data from $options[$number]
-
- echo $after_widget;
-}
-
-// Displays form for a particular instance of the widget. Also updates the data after a POST submit
-// $widget_args: number
-// number: which of the several widgets of this type do we mean
-function widget_many_control( $widget_args = 1 ) {
- global $wp_registered_widgets;
- static $updated = false; // Whether or not we have already updated the data after a POST submit
-
- if ( is_numeric($widget_args) )
- $widget_args = array( 'number' => $widget_args );
- $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
- extract( $widget_args, EXTR_SKIP );
-
- // Data should be stored as array: array( number => data for that instance of the widget, ... )
- $options = get_option('widget_many');
- if ( !is_array($options) )
- $options = array();
-
- // We need to update the data
- if ( !$updated && !empty($_POST['sidebar']) ) {
- // Tells us what sidebar to put the data in
- $sidebar = (string) $_POST['sidebar'];
-
- $sidebars_widgets = wp_get_sidebars_widgets();
- if ( isset($sidebars_widgets[$sidebar]) )
- $this_sidebar =& $sidebars_widgets[$sidebar];
- else
- $this_sidebar = array();
-
- foreach ( $this_sidebar as $_widget_id ) {
- // Remove all widgets of this type from the sidebar. We'll add the new data in a second. This makes sure we don't get any duplicate data
- // since widget ids aren't necessarily persistent across multiple updates
- if ( 'widget_many' == $wp_registered_widgets[$_widget_id]['callback'] && isset($wp_registered_widgets[$_widget_id]['params'][0]['number']) ) {
- $widget_number = $wp_registered_widgets[$_widget_id]['params'][0]['number'];
- if ( !in_array( "many-$widget_number", $_POST['widget-id'] ) ) // the widget has been removed. "many-$widget_number" is "{id_base}-{widget_number}
- unset($options[$widget_number]);
- }
+ $_widgets = array();
+ foreach ( $widgets as $widget ) {
+ if ( isset($wp_registered_widgets[$widget]) )
+ $_widgets[] = $widget;
}
- foreach ( (array) $_POST['widget-many'] as $widget_number => $widget_many_instance ) {
- // compile data from $widget_many_instance
- if ( !isset($widget_many_instance['something']) && isset($options[$widget_number]) ) // user clicked cancel
- continue;
- $something = wp_specialchars( $widget_many_instance['something'] );
- $options[$widget_number] = array( 'something' => $something ); // Even simple widgets should store stuff in array, rather than in scalar
- }
-
- update_option('widget_many', $options);
-
- $updated = true; // So that we don't go through this more than once
- }
-
-
- // Here we echo out the form
- if ( -1 == $number ) { // We echo out a template for a form which can be converted to a specific form later via JS
- $something = '';
- $number = '%i%';
- } else {
- $something = attribute_escape($options[$number]['something']);
+ $_sidebars_widgets[$sidebar] = $_widgets;
+ $shown_widgets = array_merge($shown_widgets, $_widgets);
}
- // The form has inputs with names like widget-many[$number][something] so that all data for that instance of
- // the widget are stored in one $_POST variable: $_POST['widget-many'][$number]
-?>
-
-
-
-
- $val ) {
+ if ( in_array($key, $shown_widgets, true) )
+ continue;
- $widget_ops = array('classname' => 'widget_many', 'description' => __('Widget which allows multiple instances'));
- $control_ops = array('width' => 400, 'height' => 350, 'id_base' => 'many');
- $name = __('Many');
+ $number = preg_replace('/.+?-([0-9]+)$/', '$1', $key);
- $registered = false;
- foreach ( array_keys($options) as $o ) {
- // Old widgets can have null values for some reason
- if ( !isset($options[$o]['something']) ) // we used 'something' above in our exampple. Replace with with whatever your real data are.
+ if ( 2 > (int) $number )
continue;
- // $id should look like {$id_base}-{$o}
- $id = "many-$o"; // Never never never translate an id
- $registered = true;
- wp_register_sidebar_widget( $id, $name, 'widget_many', $widget_ops, array( 'number' => $o ) );
- wp_register_widget_control( $id, $name, 'widget_many_control', $control_ops, array( 'number' => $o ) );
- }
-
- // If there are none, we register the widget's existance with a generic template
- if ( !$registered ) {
- wp_register_sidebar_widget( 'many-1', $name, 'widget_many', $widget_ops, array( 'number' => -1 ) );
- wp_register_widget_control( 'many-1', $name, 'widget_many_control', $control_ops, array( 'number' => -1 ) );
+ $lost_widgets[] = $key;
}
-}
-// This is important
-add_action( 'widgets_init', 'widget_many_register' )
+ $sidebars_widgets['wp_inactive_widgets'] = array_merge($lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets']);
+ wp_set_sidebars_widgets($sidebars_widgets);
-*/
-
-?>
+ return $sidebars_widgets;
+}