WordPress 3.0 beta 1 documentation kindly provided to you by Hay Kranen
WordPress 3.0 beta 1 documentation kindly provided to you by Hay Kranen
| [ Index ] |
PHP Cross Reference of WordPress 3.0 beta 1 |
|
| [ Index ] [ Variables ] [ Functions ] [ Classes ] [ Constants ] [ Statistics ] | ||
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * API for creating dynamic sidebar without hardcoding functionality into 4 * themes. Includes both internal WordPress routines and theme use routines. 5 * 6 * This functionality was found in a plugin before WordPress 2.2 release which 7 * included it in the core from that point on. 8 * 9 * @link http://codex.wordpress.org/Plugins/WordPress_Widgets WordPress Widgets 10 * @link http://codex.wordpress.org/Plugins/WordPress_Widgets_Api Widgets API 11 * 12 * @package WordPress 13 * @subpackage Widgets 14 */ 15 16 /** 17 * This class must be extended for each widget and WP_Widget::widget(), WP_Widget::update() 18 * and WP_Widget::form() need to be over-ridden. 19 * 20 * @package WordPress 21 * @subpackage Widgets 22 * @since 2.8 23 */ 24 class WP_Widget { 25 26 var $id_base; // Root id for all widgets of this type. 27 var $name; // Name for this widget type. 28 var $widget_options; // Option array passed to wp_register_sidebar_widget() 29 var $control_options; // Option array passed to wp_register_widget_control() 30 31 var $number = false; // Unique ID number of the current instance. 32 var $id = false; // Unique ID string of the current instance (id_base-number) 33 var $updated = false; // Set true when we update the data after a POST submit - makes sure we don't do it twice. 34 35 // Member functions that you must over-ride. 36 37 /** Echo the widget content. 38 * 39 * Subclasses should over-ride this function to generate their widget code. 40 * 41 * @param array $args Display arguments including before_title, after_title, before_widget, and after_widget. 42 * @param array $instance The settings for the particular instance of the widget 43 */ 44 function widget($args, $instance) { 45 die('function WP_Widget::widget() must be over-ridden in a sub-class.'); 46 } 47 48 /** Update a particular instance. 49 * 50 * This function should check that $new_instance is set correctly. 51 * The newly calculated value of $instance should be returned. 52 * If "false" is returned, the instance won't be saved/updated. 53 * 54 * @param array $new_instance New settings for this instance as input by the user via form() 55 * @param array $old_instance Old settings for this instance 56 * @return array Settings to save or bool false to cancel saving 57 */ 58 function update($new_instance, $old_instance) { 59 return $new_instance; 60 } 61 62 /** Echo the settings update form 63 * 64 * @param array $instance Current settings 65 */ 66 function form($instance) { 67 echo '<p class="no-options-widget">' . __('There are no options for this widget.') . '</p>'; 68 return 'noform'; 69 } 70 71 // Functions you'll need to call. 72 73 /** 74 * PHP4 constructor 75 */ 76 function WP_Widget( $id_base = false, $name, $widget_options = array(), $control_options = array() ) { 77 $this->__construct( $id_base, $name, $widget_options, $control_options ); 78 } 79 80 /** 81 * PHP5 constructor 82 * 83 * @param string $id_base Optional Base ID for the widget, lower case, 84 * if left empty a portion of the widget's class name will be used. Has to be unique. 85 * @param string $name Name for the widget displayed on the configuration page. 86 * @param array $widget_options Optional Passed to wp_register_sidebar_widget() 87 * - description: shown on the configuration page 88 * - classname 89 * @param array $control_options Optional Passed to wp_register_widget_control() 90 * - width: required if more than 250px 91 * - height: currently not used but may be needed in the future 92 */ 93 function __construct( $id_base = false, $name, $widget_options = array(), $control_options = array() ) { 94 $this->id_base = empty($id_base) ? preg_replace( '/(wp_)?widget_/', '', strtolower(get_class($this)) ) : strtolower($id_base); 95 $this->name = $name; 96 $this->option_name = 'widget_' . $this->id_base; 97 $this->widget_options = wp_parse_args( $widget_options, array('classname' => $this->option_name) ); 98 $this->control_options = wp_parse_args( $control_options, array('id_base' => $this->id_base) ); 99 } 100 101 /** 102 * Constructs name attributes for use in form() fields 103 * 104 * This function should be used in form() methods to create name attributes for fields to be saved by update() 105 * 106 * @param string $field_name Field name 107 * @return string Name attribute for $field_name 108 */ 109 function get_field_name($field_name) { 110 return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']'; 111 } 112 113 /** 114 * Constructs id attributes for use in form() fields 115 * 116 * This function should be used in form() methods to create id attributes for fields to be saved by update() 117 * 118 * @param string $field_name Field name 119 * @return string ID attribute for $field_name 120 */ 121 function get_field_id($field_name) { 122 return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name; 123 } 124 125 // Private Functions. Don't worry about these. 126 127 function _register() { 128 $settings = $this->get_settings(); 129 $empty = true; 130 131 if ( is_array($settings) ) { 132 foreach ( array_keys($settings) as $number ) { 133 if ( is_numeric($number) ) { 134 $this->_set($number); 135 $this->_register_one($number); 136 $empty = false; 137 } 138 } 139 } 140 141 if ( $empty ) { 142 // If there are none, we register the widget's existance with a 143 // generic template 144 $this->_set(1); 145 $this->_register_one(); 146 } 147 } 148 149 function _set($number) { 150 $this->number = $number; 151 $this->id = $this->id_base . '-' . $number; 152 } 153 154 function _get_display_callback() { 155 return array(&$this, 'display_callback'); 156 } 157 158 function _get_update_callback() { 159 return array(&$this, 'update_callback'); 160 } 161 162 function _get_form_callback() { 163 return array(&$this, 'form_callback'); 164 } 165 166 /** Generate the actual widget content. 167 * Just finds the instance and calls widget(). 168 * Do NOT over-ride this function. */ 169 function display_callback( $args, $widget_args = 1 ) { 170 if ( is_numeric($widget_args) ) 171 $widget_args = array( 'number' => $widget_args ); 172 173 $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); 174 $this->_set( $widget_args['number'] ); 175 $instance = $this->get_settings(); 176 177 if ( array_key_exists( $this->number, $instance ) ) { 178 $instance = $instance[$this->number]; 179 // filters the widget's settings, return false to stop displaying the widget 180 $instance = apply_filters('widget_display_callback', $instance, $this, $args); 181 if ( false !== $instance ) 182 $this->widget($args, $instance); 183 } 184 } 185 186 /** Deal with changed settings. 187 * Do NOT over-ride this function. */ 188 function update_callback( $widget_args = 1 ) { 189 global $wp_registered_widgets; 190 191 if ( is_numeric($widget_args) ) 192 $widget_args = array( 'number' => $widget_args ); 193 194 $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); 195 $all_instances = $this->get_settings(); 196 197 // We need to update the data 198 if ( $this->updated ) 199 return; 200 201 $sidebars_widgets = wp_get_sidebars_widgets(); 202 203 if ( isset($_POST['delete_widget']) && $_POST['delete_widget'] ) { 204 // Delete the settings for this instance of the widget 205 if ( isset($_POST['the-widget-id']) ) 206 $del_id = $_POST['the-widget-id']; 207 else 208 return; 209 210 if ( isset($wp_registered_widgets[$del_id]['params'][0]['number']) ) { 211 $number = $wp_registered_widgets[$del_id]['params'][0]['number']; 212 213 if ( $this->id_base . '-' . $number == $del_id ) 214 unset($all_instances[$number]); 215 } 216 } else { 217 if ( isset($_POST['widget-' . $this->id_base]) && is_array($_POST['widget-' . $this->id_base]) ) { 218 $settings = $_POST['widget-' . $this->id_base]; 219 } elseif ( isset($_POST['id_base']) && $_POST['id_base'] == $this->id_base ) { 220 $num = $_POST['multi_number'] ? (int) $_POST['multi_number'] : (int) $_POST['widget_number']; 221 $settings = array( $num => array() ); 222 } else { 223 return; 224 } 225 226 foreach ( $settings as $number => $new_instance ) { 227 $new_instance = stripslashes_deep($new_instance); 228 $this->_set($number); 229 230 $old_instance = isset($all_instances[$number]) ? $all_instances[$number] : array(); 231 232 $instance = $this->update($new_instance, $old_instance); 233 234 // filters the widget's settings before saving, return false to cancel saving (keep the old settings if updating) 235 $instance = apply_filters('widget_update_callback', $instance, $new_instance, $old_instance, $this); 236 if ( false !== $instance ) 237 $all_instances[$number] = $instance; 238 239 break; // run only once 240 } 241 } 242 243 $this->save_settings($all_instances); 244 $this->updated = true; 245 } 246 247 /** Generate the control form. 248 * Do NOT over-ride this function. */ 249 function form_callback( $widget_args = 1 ) { 250 if ( is_numeric($widget_args) ) 251 $widget_args = array( 'number' => $widget_args ); 252 253 $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); 254 $all_instances = $this->get_settings(); 255 256 if ( -1 == $widget_args['number'] ) { 257 // We echo out a form where 'number' can be set later 258 $this->_set('__i__'); 259 $instance = array(); 260 } else { 261 $this->_set($widget_args['number']); 262 $instance = $all_instances[ $widget_args['number'] ]; 263 } 264 265 // filters the widget admin form before displaying, return false to stop displaying it 266 $instance = apply_filters('widget_form_callback', $instance, $this); 267 268 $return = null; 269 if ( false !== $instance ) { 270 $return = $this->form($instance); 271 // add extra fields in the widget form - be sure to set $return to null if you add any 272 // if the widget has no form the text echoed from the default form method can be hidden using css 273 do_action_ref_array( 'in_widget_form', array(&$this, &$return, $instance) ); 274 } 275 return $return; 276 } 277 278 /** Helper function: Registers a single instance. */ 279 function _register_one($number = -1) { 280 wp_register_sidebar_widget( $this->id, $this->name, $this->_get_display_callback(), $this->widget_options, array( 'number' => $number ) ); 281 _register_widget_update_callback( $this->id_base, $this->_get_update_callback(), $this->control_options, array( 'number' => -1 ) ); 282 _register_widget_form_callback( $this->id, $this->name, $this->_get_form_callback(), $this->control_options, array( 'number' => $number ) ); 283 } 284 285 function save_settings($settings) { 286 $settings['_multiwidget'] = 1; 287 update_option( $this->option_name, $settings ); 288 } 289 290 function get_settings() { 291 $settings = get_option($this->option_name); 292 293 if ( false === $settings && isset($this->alt_option_name) ) 294 $settings = get_option($this->alt_option_name); 295 296 if ( !is_array($settings) ) 297 $settings = array(); 298 299 if ( !array_key_exists('_multiwidget', $settings) ) { 300 // old format, conver if single widget 301 $settings = wp_convert_widget_settings($this->id_base, $this->option_name, $settings); 302 } 303 304 unset($settings['_multiwidget'], $settings['__i__']); 305 return $settings; 306 } 307 } 308 309 /** 310 * Singleton that registers and instantiates WP_Widget classes. 311 * 312 * @package WordPress 313 * @subpackage Widgets 314 * @since 2.8 315 */ 316 class WP_Widget_Factory { 317 var $widgets = array(); 318 319 function WP_Widget_Factory() { 320 add_action( 'widgets_init', array( &$this, '_register_widgets' ), 100 ); 321 } 322 323 function register($widget_class) { 324 $this->widgets[$widget_class] = & new $widget_class(); 325 } 326 327 function unregister($widget_class) { 328 if ( isset($this->widgets[$widget_class]) ) 329 unset($this->widgets[$widget_class]); 330 } 331 332 function _register_widgets() { 333 global $wp_registered_widgets; 334 $keys = array_keys($this->widgets); 335 $registered = array_keys($wp_registered_widgets); 336 $registered = array_map('_get_widget_id_base', $registered); 337 338 foreach ( $keys as $key ) { 339 // don't register new widget if old widget with the same id is already registered 340 if ( in_array($this->widgets[$key]->id_base, $registered, true) ) { 341 unset($this->widgets[$key]); 342 continue; 343 } 344 345 $this->widgets[$key]->_register(); 346 } 347 } 348 } 349 350 /* Global Variables */ 351 352 /** @ignore */ 353 global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates; 354 355 /** 356 * Stores the sidebars, since many themes can have more than one. 357 * 358 * @global array $wp_registered_sidebars 359 * @since 2.2.0 360 */ 361 $wp_registered_sidebars = array(); 362 363 /** 364 * Stores the registered widgets. 365 * 366 * @global array $wp_registered_widgets 367 * @since 2.2.0 368 */ 369 $wp_registered_widgets = array(); 370 371 /** 372 * Stores the registered widget control (options). 373 * 374 * @global array $wp_registered_widget_controls 375 * @since 2.2.0 376 */ 377 $wp_registered_widget_controls = array(); 378 $wp_registered_widget_updates = array(); 379 380 /** 381 * Private 382 */ 383 $_wp_sidebars_widgets = array(); 384 385 /** 386 * Private 387 */ 388 $_wp_deprecated_widgets_callbacks = array( 389 'wp_widget_pages', 390 'wp_widget_pages_control', 391 'wp_widget_calendar', 392 'wp_widget_calendar_control', 393 'wp_widget_archives', 394 'wp_widget_archives_control', 395 'wp_widget_links', 396 'wp_widget_meta', 397 'wp_widget_meta_control', 398 'wp_widget_search', 399 'wp_widget_recent_entries', 400 'wp_widget_recent_entries_control', 401 'wp_widget_tag_cloud', 402 'wp_widget_tag_cloud_control', 403 'wp_widget_categories', 404 'wp_widget_categories_control', 405 'wp_widget_text', 406 'wp_widget_text_control', 407 'wp_widget_rss', 408 'wp_widget_rss_control', 409 'wp_widget_recent_comments', 410 'wp_widget_recent_comments_control' 411 ); 412 413 /* Template tags & API functions */ 414 415 /** 416 * Register a widget 417 * 418 * Registers a WP_Widget widget 419 * 420 * @since 2.8.0 421 * 422 * @see WP_Widget 423 * @see WP_Widget_Factory 424 * @uses WP_Widget_Factory 425 * 426 * @param string $widget_class The name of a class that extends WP_Widget 427 */ 428 function register_widget($widget_class) { 429 global $wp_widget_factory; 430 431 $wp_widget_factory->register($widget_class); 432 } 433 434 /** 435 * Unregister a widget 436 * 437 * Unregisters a WP_Widget widget. Useful for unregistering default widgets. 438 * Run within a function hooked to the widgets_init action. 439 * 440 * @since 2.8.0 441 * 442 * @see WP_Widget 443 * @see WP_Widget_Factory 444 * @uses WP_Widget_Factory 445 * 446 * @param string $widget_class The name of a class that extends WP_Widget 447 */ 448 function unregister_widget($widget_class) { 449 global $wp_widget_factory; 450 451 $wp_widget_factory->unregister($widget_class); 452 } 453 454 /** 455 * Creates multiple sidebars. 456 * 457 * If you wanted to quickly create multiple sidebars for a theme or internally. 458 * This function will allow you to do so. If you don't pass the 'name' and/or 459 * 'id' in $args, then they will be built for you. 460 * 461 * The default for the name is "Sidebar #", with '#' being replaced with the 462 * number the sidebar is currently when greater than one. If first sidebar, the 463 * name will be just "Sidebar". The default for id is "sidebar-" followed by the 464 * number the sidebar creation is currently at. If the id is provided, and mutliple 465 * sidebars are being defined, the id will have "-2" appended, and so on. 466 * 467 * @since 2.2.0 468 * 469 * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here. 470 * @uses parse_str() Converts a string to an array to be used in the rest of the function. 471 * @uses register_sidebar() Sends single sidebar information [name, id] to this 472 * function to handle building the sidebar. 473 * 474 * @param int $number Number of sidebars to create. 475 * @param string|array $args Builds Sidebar based off of 'name' and 'id' values. 476 */ 477 function register_sidebars($number = 1, $args = array()) { 478 global $wp_registered_sidebars; 479 $number = (int) $number; 480 481 if ( is_string($args) ) 482 parse_str($args, $args); 483 484 for ( $i = 1; $i <= $number; $i++ ) { 485 $_args = $args; 486 487 if ( $number > 1 ) 488 $_args['name'] = isset($args['name']) ? sprintf($args['name'], $i) : sprintf(__('Sidebar %d'), $i); 489 else 490 $_args['name'] = isset($args['name']) ? $args['name'] : __('Sidebar'); 491 492 // Custom specified ID's are suffixed if they exist already. 493 // Automatically generated sidebar names need to be suffixed regardless starting at -0 494 if ( isset($args['id']) ) { 495 $_args['id'] = $args['id']; 496 $n = 2; // Start at -2 for conflicting custom ID's 497 while ( isset($wp_registered_sidebars[$_args['id']]) ) 498 $_args['id'] = $args['id'] . '-' . $n++; 499 } else { 500 $n = count($wp_registered_sidebars); 501 do { 502 $_args['id'] = 'sidebar-' . ++$n; 503 } while ( isset($wp_registered_sidebars[$_args['id']]) ); 504 } 505 register_sidebar($_args); 506 } 507 } 508 509 /** 510 * Builds the definition for a single sidebar and returns the ID. 511 * 512 * The $args parameter takes either a string or an array with 'name' and 'id' 513 * contained in either usage. It will be noted that the values will be applied 514 * to all sidebars, so if creating more than one, it will be advised to allow 515 * for WordPress to create the defaults for you. 516 * 517 * Example for string would be <code>'name=whatever;id=whatever1'</code> and for 518 * the array it would be <code>array( 519 * 'name' => 'whatever', 520 * 'id' => 'whatever1')</code>. 521 * 522 * name - The name of the sidebar, which presumably the title which will be 523 * displayed. 524 * id - The unique identifier by which the sidebar will be called by. 525 * before_widget - The content that will prepended to the widgets when they are 526 * displayed. 527 * after_widget - The content that will be appended to the widgets when they are 528 * displayed. 529 * before_title - The content that will be prepended to the title when displayed. 530 * after_title - the content that will be appended to the title when displayed. 531 * 532 * <em>Content</em> is assumed to be HTML and should be formatted as such, but 533 * doesn't have to be. 534 * 535 * @since 2.2.0 536 * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID. 537 * @uses parse_str() Converts a string to an array to be used in the rest of the function. 538 * @usedby register_sidebars() 539 * 540 * @param string|array $args Builds Sidebar based off of 'name' and 'id' values 541 * @return string The sidebar id that was added. 542 */ 543 function register_sidebar($args = array()) { 544 global $wp_registered_sidebars; 545 546 if ( is_string($args) ) 547 parse_str($args, $args); 548 549 $i = count($wp_registered_sidebars) + 1; 550 551 $defaults = array( 552 'name' => sprintf(__('Sidebar %d'), $i ), 553 'id' => "sidebar-$i", 554 'description' => '', 555 'before_widget' => '<li id="%1$s" class="widget %2$s">', 556 'after_widget' => "</li>\n", 557 'before_title' => '<h2 class="widgettitle">', 558 'after_title' => "</h2>\n", 559 ); 560 561 $sidebar = array_merge($defaults, (array) $args); 562 563 $wp_registered_sidebars[$sidebar['id']] = $sidebar; 564 565 add_theme_support('widgets'); 566 567 return $sidebar['id']; 568 } 569 570 /** 571 * Removes a sidebar from the list. 572 * 573 * @since 2.2.0 574 * 575 * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID. 576 * 577 * @param string $name The ID of the sidebar when it was added. 578 */ 579 function unregister_sidebar( $name ) { 580 global $wp_registered_sidebars; 581 582 if ( isset( $wp_registered_sidebars[$name] ) ) 583 unset( $wp_registered_sidebars[$name] ); 584 } 585 586 /** 587 * Register widget for use in sidebars. 588 * 589 * The default widget option is 'classname' that can be override. 590 * 591 * The function can also be used to unregister widgets when $output_callback 592 * parameter is an empty string. 593 * 594 * @since 2.2.0 595 * 596 * @uses $wp_registered_widgets Uses stored registered widgets. 597 * @uses $wp_register_widget_defaults Retrieves widget defaults. 598 * 599 * @param int|string $id Widget ID. 600 * @param string $name Widget display title. 601 * @param callback $output_callback Run when widget is called. 602 * @param array|string Optional. $options Widget Options. 603 * @param mixed $params,... Widget parameters to add to widget. 604 * @return null Will return if $output_callback is empty after removing widget. 605 */ 606 function wp_register_sidebar_widget($id, $name, $output_callback, $options = array()) { 607 global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks; 608 609 $id = strtolower($id); 610 611 if ( empty($output_callback) ) { 612 unset($wp_registered_widgets[$id]); 613 return; 614 } 615 616 $id_base = _get_widget_id_base($id); 617 if ( in_array($output_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($output_callback) ) { 618 if ( isset($wp_registered_widget_controls[$id]) ) 619 unset($wp_registered_widget_controls[$id]); 620 621 if ( isset($wp_registered_widget_updates[$id_base]) ) 622 unset($wp_registered_widget_updates[$id_base]); 623 624 return; 625 } 626 627 $defaults = array('classname' => $output_callback); 628 $options = wp_parse_args($options, $defaults); 629 $widget = array( 630 'name' => $name, 631 'id' => $id, 632 'callback' => $output_callback, 633 'params' => array_slice(func_get_args(), 4) 634 ); 635 $widget = array_merge($widget, $options); 636 637 if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) ) 638 $wp_registered_widgets[$id] = $widget; 639 } 640 641 /** 642 * Retrieve description for widget. 643 * 644 * When registering widgets, the options can also include 'description' that 645 * describes the widget for display on the widget administration panel or 646 * in the theme. 647 * 648 * @since 2.5.0 649 * 650 * @param int|string $id Widget ID. 651 * @return string Widget description, if available. Null on failure to retrieve description. 652 */ 653 function wp_widget_description( $id ) { 654 if ( !is_scalar($id) ) 655 return; 656 657 global $wp_registered_widgets; 658 659 if ( isset($wp_registered_widgets[$id]['description']) ) 660 return esc_html( $wp_registered_widgets[$id]['description'] ); 661 } 662 663 /** 664 * Retrieve description for a sidebar. 665 * 666 * When registering sidebars a 'description' parameter can be included that 667 * describes the sidebar for display on the widget administration panel. 668 * 669 * @since 2.9.0 670 * 671 * @param int|string $id sidebar ID. 672 * @return string Sidebar description, if available. Null on failure to retrieve description. 673 */ 674 function wp_sidebar_description( $id ) { 675 if ( !is_scalar($id) ) 676 return; 677 678 global $wp_registered_sidebars; 679 680 if ( isset($wp_registered_sidebars[$id]['description']) ) 681 return esc_html( $wp_registered_sidebars[$id]['description'] ); 682 } 683 684 685 /** 686 * Remove widget from sidebar. 687 * 688 * @since 2.2.0 689 * 690 * @param int|string $id Widget ID. 691 */ 692 function wp_unregister_sidebar_widget($id) { 693 wp_register_sidebar_widget($id, '', ''); 694 wp_unregister_widget_control($id); 695 } 696 697 /** 698 * Registers widget control callback for customizing options. 699 * 700 * The options contains the 'height', 'width', and 'id_base' keys. The 'height' 701 * option is never used. The 'width' option is the width of the fully expanded 702 * control form, but try hard to use the default width. The 'id_base' is for 703 * multi-widgets (widgets which allow multiple instances such as the text 704 * widget), an id_base must be provided. The widget id will end up looking like 705 * {$id_base}-{$unique_number}. 706 * 707 * @since 2.2.0 708 * 709 * @param int|string $id Sidebar ID. 710 * @param string $name Sidebar display name. 711 * @param callback $control_callback Run when sidebar is displayed. 712 * @param array|string $options Optional. Widget options. See above long description. 713 * @param mixed $params,... Optional. Additional parameters to add to widget. 714 */ 715 function wp_register_widget_control($id, $name, $control_callback, $options = array()) { 716 global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks; 717 718 $id = strtolower($id); 719 $id_base = _get_widget_id_base($id); 720 721 if ( empty($control_callback) ) { 722 unset($wp_registered_widget_controls[$id]); 723 unset($wp_registered_widget_updates[$id_base]); 724 return; 725 } 726 727 if ( in_array($control_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($control_callback) ) { 728 if ( isset($wp_registered_widgets[$id]) ) 729 unset($wp_registered_widgets[$id]); 730 731 return; 732 } 733 734 if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) ) 735 return; 736 737 $defaults = array('width' => 250, 'height' => 200 ); // height is never used 738 $options = wp_parse_args($options, $defaults); 739 $options['width'] = (int) $options['width']; 740 $options['height'] = (int) $options['height']; 741 742 $widget = array( 743 'name' => $name, 744 'id' => $id, 745 'callback' => $control_callback, 746 'params' => array_slice(func_get_args(), 4) 747 ); 748 $widget = array_merge($widget, $options); 749 750 $wp_registered_widget_controls[$id] = $widget; 751 752 if ( isset($wp_registered_widget_updates[$id_base]) ) 753 return; 754 755 if ( isset($widget['params'][0]['number']) ) 756 $widget['params'][0]['number'] = -1; 757 758 unset($widget['width'], $widget['height'], $widget['name'], $widget['id']); 759 $wp_registered_widget_updates[$id_base] = $widget; 760 } 761 762 function _register_widget_update_callback($id_base, $update_callback, $options = array()) { 763 global $wp_registered_widget_updates; 764 765 if ( isset($wp_registered_widget_updates[$id_base]) ) { 766 if ( empty($update_callback) ) 767 unset($wp_registered_widget_updates[$id_base]); 768 return; 769 } 770 771 $widget = array( 772 'callback' => $update_callback, 773 'params' => array_slice(func_get_args(), 3) 774 ); 775 776 $widget = array_merge($widget, $options); 777 $wp_registered_widget_updates[$id_base] = $widget; 778 } 779 780 function _register_widget_form_callback($id, $name, $form_callback, $options = array()) { 781 global $wp_registered_widget_controls; 782 783 $id = strtolower($id); 784 785 if ( empty($form_callback) ) { 786 unset($wp_registered_widget_controls[$id]); 787 return; 788 } 789 790 if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) ) 791 return; 792 793 $defaults = array('width' => 250, 'height' => 200 ); 794 $options = wp_parse_args($options, $defaults); 795 $options['width'] = (int) $options['width']; 796 $options['height'] = (int) $options['height']; 797 798 $widget = array( 799 'name' => $name, 800 'id' => $id, 801 'callback' => $form_callback, 802 'params' => array_slice(func_get_args(), 4) 803 ); 804 $widget = array_merge($widget, $options); 805 806 $wp_registered_widget_controls[$id] = $widget; 807 } 808 809 /** 810 * Remove control callback for widget. 811 * 812 * @since 2.2.0 813 * @uses wp_register_widget_control() Unregisters by using empty callback. 814 * 815 * @param int|string $id Widget ID. 816 */ 817 function wp_unregister_widget_control($id) { 818 return wp_register_widget_control($id, '', ''); 819 } 820 821 /** 822 * Display dynamic sidebar. 823 * 824 * By default it displays the default sidebar or 'sidebar-1'. The 'sidebar-1' is 825 * not named by the theme, the actual name is '1', but 'sidebar-' is added to 826 * the registered sidebars for the name. If you named your sidebar 'after-post', 827 * then the parameter $index will still be 'after-post', but the lookup will be 828 * for 'sidebar-after-post'. 829 * 830 * It is confusing for the $index parameter, but just know that it should just 831 * work. When you register the sidebar in the theme, you will use the same name 832 * for this function or "Pay no heed to the man behind the curtain." Just accept 833 * it as an oddity of WordPress sidebar register and display. 834 * 835 * @since 2.2.0 836 * 837 * @param int|string $index Optional, default is 1. Name or ID of dynamic sidebar. 838 * @return bool True, if widget sidebar was found and called. False if not found or not called. 839 */ 840 function dynamic_sidebar($index = 1) { 841 global $wp_registered_sidebars, $wp_registered_widgets; 842 843 if ( is_int($index) ) { 844 $index = "sidebar-$index"; 845 } else { 846 $index = sanitize_title($index); 847 foreach ( (array) $wp_registered_sidebars as $key => $value ) { 848 if ( sanitize_title($value['name']) == $index ) { 849 $index = $key; 850 break; 851 } 852 } 853 } 854 855 $sidebars_widgets = wp_get_sidebars_widgets(); 856 857 if ( empty($wp_registered_sidebars[$index]) || !array_key_exists($index, $sidebars_widgets) || !is_array($sidebars_widgets[$index]) || empty($sidebars_widgets[$index]) ) 858 return false; 859 860 $sidebar = $wp_registered_sidebars[$index]; 861 862 $did_one = false; 863 foreach ( (array) $sidebars_widgets[$index] as $id ) { 864 865 if ( !isset($wp_registered_widgets[$id]) ) continue; 866 867 $params = array_merge( 868 array( array_merge( $sidebar, array('widget_id' => $id, 'widget_name' => $wp_registered_widgets[$id]['name']) ) ), 869 (array) $wp_registered_widgets[$id]['params'] 870 ); 871 872 // Substitute HTML id and class attributes into before_widget 873 $classname_ = ''; 874 foreach ( (array) $wp_registered_widgets[$id]['classname'] as $cn ) { 875 if ( is_string($cn) ) 876 $classname_ .= '_' . $cn; 877 elseif ( is_object($cn) ) 878 $classname_ .= '_' . get_class($cn); 879 } 880 $classname_ = ltrim($classname_, '_'); 881 $params[0]['before_widget'] = sprintf($params[0]['before_widget'], $id, $classname_); 882 883 $params = apply_filters( 'dynamic_sidebar_params', $params ); 884 885 $callback = $wp_registered_widgets[$id]['callback']; 886 887 if ( is_callable($callback) ) { 888 call_user_func_array($callback, $params); 889 $did_one = true; 890 } 891 } 892 893 return $did_one; 894 } 895 896 /** 897 * Whether widget is displayied on the front-end. 898 * 899 * Either $callback or $id_base can be used 900 * $id_base is the first argument when extending WP_Widget class 901 * Without the optional $widget_id parameter, returns the ID of the first sidebar 902 * in which the first instance of the widget with the given callback or $id_base is found. 903 * With the $widget_id parameter, returns the ID of the sidebar where 904 * the widget with that callback/$id_base AND that ID is found. 905 * 906 * NOTE: $widget_id and $id_base are the same for single widgets. To be effective 907 * this function has to run after widgets have initialized, at action 'init' or later. 908 * 909 * @since 2.2.0 910 * 911 * @param callback Optional, Widget callback to check. 912 * @param int $widget_id Optional, but needed for checking. Widget ID. 913 * @param string $id_base Optional, the base ID of a widget created by extending WP_Widget. 914 * @param bool $skip_inactive Optional, whether to check in 'wp_inactive_widgets'. 915 * @return mixed false if widget is not active or id of sidebar in which the widget is active. 916 */ 917 function is_active_widget($callback = false, $widget_id = false, $id_base = false, $skip_inactive = true) { 918 global $wp_registered_widgets; 919 920 $sidebars_widgets = wp_get_sidebars_widgets(); 921 922 if ( is_array($sidebars_widgets) ) { 923 foreach ( $sidebars_widgets as $sidebar => $widgets ) { 924 if ( $skip_inactive && 'wp_inactive_widgets' == $sidebar ) 925 continue; 926 927 if ( is_array($widgets) ) { 928 foreach ( $widgets as $widget ) { 929 if ( ( $callback && isset($wp_registered_widgets[$widget]['callback']) && $wp_registered_widgets[$widget]['callback'] == $callback ) || ( $id_base && _get_widget_id_base($widget) == $id_base ) ) { 930 if ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] ) 931 return $sidebar; 932 } 933 } 934 } 935 } 936 } 937 return false; 938 } 939 940 /** 941 * Whether the dynamic sidebar is enabled and used by theme. 942 * 943 * @since 2.2.0 944 * 945 * @return bool True, if using widgets. False, if not using widgets. 946 */ 947 function is_dynamic_sidebar() { 948 global $wp_registered_widgets, $wp_registered_sidebars; 949 $sidebars_widgets = get_option('sidebars_widgets'); 950 foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) { 951 if ( count($sidebars_widgets[$index]) ) { 952 foreach ( (array) $sidebars_widgets[$index] as $widget ) 953 if ( array_key_exists($widget, $wp_registered_widgets) ) 954 return true; 955 } 956 } 957 return false; 958 } 959 960 /** 961 * Whether a sidebar is in use. 962 * 963 * @since 2.8 964 * 965 * @param mixed $index, sidebar name, id or number to check. 966 * @return bool true if the sidebar is in use, false otherwise. 967 */ 968 function is_active_sidebar( $index ) { 969 $index = ( is_int($index) ) ? "sidebar-$index" : sanitize_title($index); 970 $sidebars_widgets = wp_get_sidebars_widgets(); 971 if ( !empty($sidebars_widgets[$index]) ) 972 return true; 973 974 return false; 975 } 976 977 /* Internal Functions */ 978 979 /** 980 * Retrieve full list of sidebars and their widgets. 981 * 982 * Will upgrade sidebar widget list, if needed. Will also save updated list, if 983 * needed. 984 * 985 * @since 2.2.0 986 * @access private 987 * 988 * @param bool $deprecated. Not used. 989 * @return array Upgraded list of widgets to version 3 array format when called from the admin. 990 */ 991 function wp_get_sidebars_widgets($deprecated = true) { 992 if ( $deprecated !== true ) 993 _deprecated_argument( __FUNCTION__, '2.8.1' ); 994 995 global $wp_registered_widgets, $wp_registered_sidebars, $_wp_sidebars_widgets; 996 997 // If loading from front page, consult $_wp_sidebars_widgets rather than options 998 // to see if wp_convert_widget_settings() has made manipulations in memory. 999 if ( !is_admin() ) { 1000 if ( empty($_wp_sidebars_widgets) ) 1001 $_wp_sidebars_widgets = get_option('sidebars_widgets', array()); 1002 1003 $sidebars_widgets = $_wp_sidebars_widgets; 1004 } else { 1005 $sidebars_widgets = get_option('sidebars_widgets', array()); 1006 $_sidebars_widgets = array(); 1007 1008 if ( isset($sidebars_widgets['wp_inactive_widgets']) || empty($sidebars_widgets) ) 1009 $sidebars_widgets['array_version'] = 3; 1010 elseif ( !isset($sidebars_widgets['array_version']) ) 1011 $sidebars_widgets['array_version'] = 1; 1012 1013 switch ( $sidebars_widgets['array_version'] ) { 1014 case 1 : 1015 foreach ( (array) $sidebars_widgets as $index => $sidebar ) 1016 if ( is_array($sidebar) ) 1017 foreach ( (array) $sidebar as $i => $name ) { 1018 $id = strtolower($name); 1019 if ( isset($wp_registered_widgets[$id]) ) { 1020 $_sidebars_widgets[$index][$i] = $id; 1021 continue; 1022 } 1023 $id = sanitize_title($name); 1024 if ( isset($wp_registered_widgets[$id]) ) { 1025 $_sidebars_widgets[$index][$i] = $id; 1026 continue; 1027 } 1028 1029 $found = false; 1030 1031 foreach ( $wp_registered_widgets as $widget_id => $widget ) { 1032 if ( strtolower($widget['name']) == strtolower($name) ) { 1033 $_sidebars_widgets[$index][$i] = $widget['id']; 1034 $found = true; 1035 break; 1036 } elseif ( sanitize_title($widget['name']) == sanitize_title($name) ) { 1037 $_sidebars_widgets[$index][$i] = $widget['id']; 1038 $found = true; 1039 break; 1040 } 1041 } 1042 1043 if ( $found ) 1044 continue; 1045 1046 unset($_sidebars_widgets[$index][$i]); 1047 } 1048 $_sidebars_widgets['array_version'] = 2; 1049 $sidebars_widgets = $_sidebars_widgets; 1050 unset($_sidebars_widgets); 1051 1052 case 2 : 1053 $sidebars = array_keys( $wp_registered_sidebars ); 1054 if ( !empty( $sidebars ) ) { 1055 // Move the known-good ones first 1056 foreach ( (array) $sidebars as $id ) { 1057 if ( array_key_exists( $id, $sidebars_widgets ) ) { 1058 $_sidebars_widgets[$id] = $sidebars_widgets[$id]; 1059 unset($sidebars_widgets[$id], $sidebars[$id]); 1060 } 1061 } 1062 1063 // move the rest to wp_inactive_widgets 1064 if ( !isset($_sidebars_widgets['wp_inactive_widgets']) ) 1065 $_sidebars_widgets['wp_inactive_widgets'] = array(); 1066 1067 if ( !empty($sidebars_widgets) ) { 1068 foreach ( $sidebars_widgets as $lost => $val ) { 1069 if ( is_array($val) ) 1070 $_sidebars_widgets['wp_inactive_widgets'] = array_merge( (array) $_sidebars_widgets['wp_inactive_widgets'], $val ); 1071 } 1072 } 1073 1074 $sidebars_widgets = $_sidebars_widgets; 1075 unset($_sidebars_widgets); 1076 } 1077 } 1078 } 1079 1080 if ( isset($sidebars_widgets['array_version']) ) 1081 unset($sidebars_widgets['array_version']); 1082 1083 $sidebars_widgets = apply_filters('sidebars_widgets', $sidebars_widgets); 1084 return $sidebars_widgets; 1085 } 1086 1087 /** 1088 * Set the sidebar widget option to update sidebars. 1089 * 1090 * @since 2.2.0 1091 * @access private 1092 * 1093 * @param array $sidebars_widgets Sidebar widgets and their settings. 1094 */ 1095 function wp_set_sidebars_widgets( $sidebars_widgets ) { 1096 if ( !isset( $sidebars_widgets['array_version'] ) ) 1097 $sidebars_widgets['array_version'] = 3; 1098 update_option( 'sidebars_widgets', $sidebars_widgets ); 1099 } 1100 1101 /** 1102 * Retrieve default registered sidebars list. 1103 * 1104 * @since 2.2.0 1105 * @access private 1106 * 1107 * @return array 1108 */ 1109 function wp_get_widget_defaults() { 1110 global $wp_registered_sidebars; 1111 1112 $defaults = array(); 1113 1114 foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) 1115 $defaults[$index] = array(); 1116 1117 return $defaults; 1118 } 1119 1120 /** 1121 * Convert the widget settings from single to multi-widget format. 1122 * 1123 * @since 2.8.0 1124 * 1125 * @return array 1126 */ 1127 function wp_convert_widget_settings($base_name, $option_name, $settings) { 1128 // This test may need expanding. 1129 $single = $changed = false; 1130 if ( empty($settings) ) { 1131 $single = true; 1132 } else { 1133 foreach ( array_keys($settings) as $number ) { 1134 if ( 'number' == $number ) 1135 continue; 1136 if ( !is_numeric($number) ) { 1137 $single = true; 1138 break; 1139 } 1140 } 1141 } 1142 1143 if ( $single ) { 1144 $settings = array( 2 => $settings ); 1145 1146 // If loading from the front page, update sidebar in memory but don't save to options 1147 if ( is_admin() ) { 1148 $sidebars_widgets = get_option('sidebars_widgets'); 1149 } else { 1150 if ( empty($GLOBALS['_wp_sidebars_widgets']) ) 1151 $GLOBALS['_wp_sidebars_widgets'] = get_option('sidebars_widgets', array()); 1152 $sidebars_widgets = &$GLOBALS['_wp_sidebars_widgets']; 1153 } 1154 1155 foreach ( (array) $sidebars_widgets as $index => $sidebar ) { 1156 if ( is_array($sidebar) ) { 1157 foreach ( $sidebar as $i => $name ) { 1158 if ( $base_name == $name ) { 1159 $sidebars_widgets[$index][$i] = "$name-2"; 1160 $changed = true; 1161 break 2; 1162 } 1163 } 1164 } 1165 } 1166 1167 if ( is_admin() && $changed ) 1168 update_option('sidebars_widgets', $sidebars_widgets); 1169 } 1170 1171 $settings['_multiwidget'] = 1; 1172 if ( is_admin() ) 1173 update_option( $option_name, $settings ); 1174 1175 return $settings; 1176 } 1177 1178 /** 1179 * Output an arbitrary widget as a template tag 1180 * 1181 * @since 2.8 1182 * 1183 * @param string $widget the widget's PHP class name (see default-widgets.php) 1184 * @param array $instance the widget's instance settings 1185 * @param array $args the widget's sidebar args 1186 * @return void 1187 **/ 1188 function the_widget($widget, $instance = array(), $args = array()) { 1189 global $wp_widget_factory; 1190 1191 $widget_obj = $wp_widget_factory->widgets[$widget]; 1192 if ( !is_a($widget_obj, 'WP_Widget') ) 1193 return; 1194 1195 $before_widget = sprintf('<div class="widget %s">', $widget_obj->widget_options['classname']); 1196 $default_args = array('before_widget' => $before_widget, 'after_widget' => "</div>", 'before_title' => '<h2 class="widgettitle">', 'after_title' => '</h2>'); 1197 1198 $args = wp_parse_args($args, $default_args); 1199 $instance = wp_parse_args($instance); 1200 1201 $widget_obj->_set(-1); 1202 $widget_obj->widget($args, $instance); 1203 } 1204 1205 /** 1206 * Private 1207 */ 1208 function _get_widget_id_base($id) { 1209 return preg_replace( '/-[0-9]+$/', '', $id ); 1210 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Mon Apr 5 14:26:09 2010 | Cross-referenced by PHPXref 0.7 |
