_register_widget_form_callback( int|string $id, string $name, callable $form_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

Widget ID.

$namestring

Name attribute for the widget.

$form_callbackcallable

Form callback.

$optionsarrayoptional

Widget control options. See wp_register_widget_control().
Default empty array.Default: array()

$paramsmixed

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

Performance profile

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

14–45

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What one call costs · 4 distinct outcomes

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

Uses · 2

• 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 · 1

• WP_Widget::_register_one()Registers an instance of the widget class.

Source code

View on Trac ↗View on GitHub ↗

640function _register_widget_form_callback( $id, $name, $form_callback, $options = array(), ...$params ) {641	global $wp_registered_widget_controls;642 643	$id = strtolower( $id );644 645	if ( empty( $form_callback ) ) {646		unset( $wp_registered_widget_controls[ $id ] );647		return;648	}649 650	if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) {651		return;652	}653 654	$defaults          = array(655		'width'  => 250,656		'height' => 200,657	);658	$options           = wp_parse_args( $options, $defaults );659	$options['width']  = (int) $options['width'];660	$options['height'] = (int) $options['height'];661 662	$widget = array(663		'name'     => $name,664		'id'       => $id,665		'callback' => $form_callback,666		'params'   => $params,667	);668	$widget = array_merge( $widget, $options );669 670	$wp_registered_widget_controls[ $id ] = $widget;671}

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