WordPress at a glance

wp_register_widget_control() WP 1.0

Registers widget control callback for customizing options.

No Hooks.

Return

Null. Nothing.

Usage

wp_register_widget_control( $id, $name, $control_callback, $options );
$id(int/string) (required)
Sidebar ID.
$name(string) (required)
Sidebar display name.
$control_callback(callable) (required)
Run when sidebar is displayed.
$options(array)

Array or string of control options.

  • $height (int)
    Never used.
    Default: 200

  • $width (int)
    Width of the fully expanded control form (but try hard to use the default width).
    Default: 250

  • $id_base (int/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}.

Default: empty array

Notes

  • Global. Array. $wp_registered_widget_controls
  • Global. Array. $wp_registered_widget_updates
  • Global. Array. $wp_registered_widgets
  • Global. Array. $_wp_deprecated_widgets_callbacks

Changelog

Since 2.2.0 Introduced.

Code of wp register widget control: wp-includes/widgets.php WP 5.2.2

<?php
function wp_register_widget_control( $id, $name, $control_callback, $options = array() ) {
	global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks;

	$id      = strtolower( $id );
	$id_base = _get_widget_id_base( $id );

	if ( empty( $control_callback ) ) {
		unset( $wp_registered_widget_controls[ $id ] );
		unset( $wp_registered_widget_updates[ $id_base ] );
		return;
	}

	if ( in_array( $control_callback, $_wp_deprecated_widgets_callbacks, true ) && ! is_callable( $control_callback ) ) {
		unset( $wp_registered_widgets[ $id ] );
		return;
	}

	if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) {
		return;
	}

	$defaults          = array(
		'width'  => 250,
		'height' => 200,
	); // height is never used
	$options           = wp_parse_args( $options, $defaults );
	$options['width']  = (int) $options['width'];
	$options['height'] = (int) $options['height'];

	$widget = array(
		'name'     => $name,
		'id'       => $id,
		'callback' => $control_callback,
		'params'   => array_slice( func_get_args(), 4 ),
	);
	$widget = array_merge( $widget, $options );

	$wp_registered_widget_controls[ $id ] = $widget;

	if ( isset( $wp_registered_widget_updates[ $id_base ] ) ) {
		return;
	}

	if ( isset( $widget['params'][0]['number'] ) ) {
		$widget['params'][0]['number'] = -1;
	}

	unset( $widget['width'], $widget['height'], $widget['name'], $widget['id'] );
	$wp_registered_widget_updates[ $id_base ] = $widget;
}

Related Functions

From tag: Sidebar (widgets)

No comments
    Hello, !     Log In . Register