_register_widget_update_callback

Registers the update callback for a widget.

Description

_register_widget_update_callback( (string) $id_base, (callable) $update_callback, (array) $options = array() ); 

Parameters (3)

0. $id_base (string)
The base ID of a widget created by extending WP_Widget.
1. $update_callback (callable)
Update callback method for the widget.
2. $options — Optional. (array) => array()
Widget control options. See wp_register_widget_control(…). Default empty array.

Usage

  1. if ( !function_exists( '_register_widget_update_callback' ) ) { 
  2.     require_once ABSPATH . WPINC . '/widgets.php'; 
  3. } 
  4.   
  5. // The base ID of a widget created by extending WP_Widget. 
  6. $id_base = ''; 
  7.   
  8. // Update callback method for the widget. 
  9. $update_callback = null; 
  10.   
  11. // Optional. Widget control options. See wp_register_widget_control(). 
  12. // Default empty array. 
  13. $options = array(); 
  14.   
  15. // NOTICE! Understand what this does before running. 
  16. $result = _register_widget_update_callback($id_base, $update_callback, $options); 
  17.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/widgets.php  
  1. function _register_widget_update_callback( $id_base, $update_callback, $options = array() ) { 
  2.     global $wp_registered_widget_updates; 
  3.  
  4.     if ( isset($wp_registered_widget_updates[$id_base]) ) { 
  5.         if ( empty($update_callback) ) 
  6.             unset($wp_registered_widget_updates[$id_base]); 
  7.         return; 
  8.     } 
  9.  
  10.     $widget = array( 
  11.         'callback' => $update_callback,  
  12.         'params' => array_slice(func_get_args(), 3) 
  13.  ); 
  14.  
  15.     $widget = array_merge($widget, $options); 
  16.     $wp_registered_widget_updates[$id_base] = $widget; 
  17. }