WP_Widget::__construct( string $id_base, string $name, array $widget_options = array(), array $control_options = array() )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$id_basestring

Base ID for the widget, lowercase and unique. If left empty, a portion of the widget's PHP class name will be used. Has to be unique.

$namestring

Name for the widget displayed on the configuration page.

$widget_optionsarrayoptional

Widget options. See wp_register_sidebar_widget() for information on accepted arguments. Default empty array.Default: array()

$control_optionsarrayoptional

Widget control options. See wp_register_widget_control() for information on accepted arguments. Default empty array.Default: array()

Performance profile

How much work a call to WP_Widget::__construct() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

39–42

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 47.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

19

19 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Widget::__construct() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• wp_parse_args()Merges user defined arguments into defaults array.

Used by · 19

• Twenty_Eleven_Ephemera_Widget::__construct()PHP5 constructor.
• Twenty_Fourteen_Ephemera_Widget::__construct()Constructor.
• WP_Nav_Menu_Widget::__construct()Sets up a new Navigation Menu widget instance.
• WP_Widget::WP_Widget()PHP4 constructor.
• WP_Widget_Archives::__construct()Sets up a new Archives widget instance.
• WP_Widget_Block::__construct()Sets up a new Block widget instance.
• WP_Widget_Calendar::__construct()Sets up a new Calendar widget instance.
• WP_Widget_Categories::__construct()Sets up a new Categories widget instance.
• WP_Widget_Custom_HTML::__construct()Sets up a new Custom HTML widget instance.
• WP_Widget_Links::__construct()Sets up a new Links widget instance.
• WP_Widget_Media::__construct()Constructor.
• WP_Widget_Meta::__construct()Sets up a new Meta widget instance.

Source code

View on Trac ↗View on GitHub ↗

163	public function __construct( $id_base, $name, $widget_options = array(), $control_options = array() ) {164		if ( ! empty( $id_base ) ) {165			$id_base = strtolower( $id_base );166		} else {167			$id_base = preg_replace( '/(wp_)?widget_/', '', strtolower( get_class( $this ) ) );168		}169 170		$this->id_base         = $id_base;171		$this->name            = $name;172		$this->option_name     = 'widget_' . $this->id_base;173		$this->widget_options  = wp_parse_args(174			$widget_options,175			array(176				'classname'                   => str_replace( '\\', '_', $this->option_name ),177				'customize_selective_refresh' => false,178			)179		);180		$this->control_options = wp_parse_args( $control_options, array( 'id_base' => $this->id_base ) );181	}

Changelog

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.9.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.