the_widget

Fires before rendering the requested widget.

Description

do_action( 'the_widget', (string) $widget, (array) $instance, (array) $args ); 

Parameters (3)

0. $widget (string)
The widget's class name.
1. $instance (array)
The current widget instance's settings.
2. $args (array)
An array of the widget's sidebar arguments.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'the_widget', $widget, $instance, $args ); 
The following example is for adding a hook callback.
  1. // define the the_widget callback 
  2. function action_the_widget( $widget, $instance, $args ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'the_widget', 'action_the_widget', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'the_widget', 'action_the_widget', 10, 3 ); 

Defined (1)

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

/wp-includes/widgets.php  
  1. do_action( 'the_widget', $widget, $instance, $args );