wp_register_widget_control( int|string $id, string $name, callable $control_callback, array $options = array(), mixed $params )

Compatibility

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

Parameters

$idint|string

Sidebar ID.

$namestring

Sidebar display name.

$control_callbackcallable

Run when sidebar is displayed.

$optionsarrayoptional

Array or string of control options. Default empty array.Default: array()

• $heightintdefault: 200

  Never used.

• $widthintdefault: 250

  Width of the fully expanded control form (but try hard to use the default width).

• $id_baseint|string

  Required for multi-widgets, i.e widgets that allow multiple instances such as the text widget. The widget ID will end up looking like {$id_base}-{$unique_number}.

$paramsmixed

Optional additional parameters to pass to the callback function when it's called.

Performance profile

How much work a call to wp_register_widget_control() 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

22–75

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

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

What one call costs · 8 distinct outcomes

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

Uses · 3

• _get_widget_id_base()Retrieves the widget ID base value.
• did_action()Retrieves the number of times an action has been fired during the current request.
• wp_parse_args()Merges user defined arguments into defaults array.

Used by · 2

• register_widget_control()Registers widget control callback for customizing options.
• wp_unregister_widget_control()Removes control callback for widget.

Source code

View on Trac ↗View on GitHub ↗

538function wp_register_widget_control( $id, $name, $control_callback, $options = array(), ...$params ) {539	global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks;540 541	$id      = strtolower( $id );542	$id_base = _get_widget_id_base( $id );543 544	if ( empty( $control_callback ) ) {545		unset( $wp_registered_widget_controls[ $id ] );546		unset( $wp_registered_widget_updates[ $id_base ] );547		return;548	}549 550	if ( in_array( $control_callback, $_wp_deprecated_widgets_callbacks, true ) && ! is_callable( $control_callback ) ) {551		unset( $wp_registered_widgets[ $id ] );552		return;553	}554 555	if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) {556		return;557	}558 559	$defaults          = array(560		'width'  => 250,561		'height' => 200,562	); // Height is never used.563	$options           = wp_parse_args( $options, $defaults );564	$options['width']  = (int) $options['width'];565	$options['height'] = (int) $options['height'];566 567	$widget = array(568		'name'     => $name,569		'id'       => $id,570		'callback' => $control_callback,571		'params'   => $params,572	);573	$widget = array_merge( $widget, $options );574 575	$wp_registered_widget_controls[ $id ] = $widget;576 577	if ( isset( $wp_registered_widget_updates[ $id_base ] ) ) {578		return;579	}580 581	if ( isset( $widget['params'][0]['number'] ) ) {582		$widget['params'][0]['number'] = -1;583	}584 585	unset( $widget['width'], $widget['height'], $widget['name'], $widget['id'] );586	$wp_registered_widget_updates[ $id_base ] = $widget;587}

Changelog

Introduced in 2.2.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 7.1.0 tag, from src/wp-includes/widgets.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.