WP_Widget

Description

Hooks fired · 4

Every hook that fires from inside WP_Widget, in the order it appears in the class, grouped by the method that fires it.

Properties · 9

$id_basemixed|stringpublic

Root ID for all widgets of this type.

$namestringpublic

Name for this widget type.

$option_namestringpublic

Option name for this widget type.

$alt_option_namestringpublic

Alt option name for this widget type.

$widget_optionsarraypublic

Option array passed to wp_register_sidebar_widget().

$control_optionsarraypublic

Option array passed to wp_register_widget_control().

$numberbool|intpublic

Unique ID number of the current instance.

$idbool|stringpublic

Unique ID string of the current instance (id_base-number).

$updatedboolpublic

Whether the widget data has been updated.

Methods · 19

• widget()Echoes the widget content.
• update()Updates a particular instance of a widget.
• form()Outputs the settings update form.
• __construct()PHP5 constructor.
• WP_Widget()PHP4 constructor.
• get_field_name()Constructs name attributes for use in form() fields
• get_field_id()Constructs id attributes for use in WP_Widget::form() fields.
• _register()Register all widget instances of this widget class.
• _set()Sets the internal order number for the widget instance.
• _get_display_callback()Retrieves the widget display callback.
• _get_update_callback()Retrieves the widget update callback.
• _get_form_callback()Retrieves the form callback.
• is_preview()Determines whether the current request is inside the Customizer preview.
• display_callback()Generates the actual widget content (Do NOT override).
• update_callback()Handles changed settings (Do NOT override).
• form_callback()Generates the widget control form (Do NOT override).
• _register_one()Registers an instance of the widget class.
• save_settings()Saves the settings for all instances of the widget class.
• get_settings()Retrieves the settings for all instances of the widget class.

Source

View on Trac ↗View on GitHub ↗

20#[AllowDynamicProperties]21class WP_Widget {22 23	/**24	 * Root ID for all widgets of this type.25	 *26	 * @since 2.8.027	 * @var mixed|string28	 */29	public $id_base;30 31	/**32	 * Name for this widget type.33	 *34	 * @since 2.8.035	 * @var string36	 */37	public $name;38 39	/**40	 * Option name for this widget type.41	 *42	 * @since 2.8.043	 * @var string44	 */45	public $option_name;46 47	/**48	 * Alt option name for this widget type.49	 *50	 * @since 2.8.051	 * @var string52	 */53	public $alt_option_name;54 55	/**56	 * Option array passed to wp_register_sidebar_widget().57	 *58	 * @since 2.8.059	 * @var array60	 */61	public $widget_options;62 63	/**64	 * Option array passed to wp_register_widget_control().65	 *66	 * @since 2.8.067	 * @var array68	 */69	public $control_options;70 71	/**72	 * Unique ID number of the current instance.73	 *74	 * @since 2.8.075	 * @var bool|int76	 */77	public $number = false;78 79	/**80	 * Unique ID string of the current instance (id_base-number).81	 *82	 * @since 2.8.083	 * @var bool|string84	 */85	public $id = false;86 87	/**88	 * Whether the widget data has been updated.89	 *90	 * Set to true when the data is updated after a POST submit - ensures it does91	 * not happen twice.92	 *93	 * @since 2.8.094	 * @var bool95	 */96	public $updated = false;97 98	//99	// Member functions that must be overridden by subclasses.

History

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-widget.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.