register_sidebar_widget( string|int $name, callable $output_callback, string $classname = '', mixed $params )
- Since
- 2.2.0
- Source
wp-includes/deprecated.php:2127
Description
Allows $name to be an array that accepts either three elements to grab the first element and the third for the name or just uses the first element of the array for the name.
Passes to wp_register_sidebar_widget() after argument list and backward compatibility is complete.
Compatibility
Deprecated in WordPress 2.8.0. Use wp_register_sidebar_widget()
- WordPress
- since 2.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$namestring|int- Widget ID.
$output_callbackcallable- Run when widget is called.
$classnamestringoptional- Classname widget option. Default empty.Default:
'' $paramsmixed- Widget parameters.
Performance profile
How much work a call to register_sidebar_widget() 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
- Scaling
- Constant
- Instructions
- 27–42
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 44.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()one call below register_sidebar_widget()
Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost register_sidebar_widget() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 27–36 | _deprecated_function(), sanitize_title(), wp_register_sidebar_widget() |
is_array($name) | 38–42 | _deprecated_function(), sprintf(), sanitize_title(), wp_register_sidebar_widget() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 44 | 27–42 | 4 | |
| 8.5 | 44 | 27–42 | 4 | |
| 8.4 | 44 | 27–42 | 4 | |
| 8.3 | 44 | 27–42 | 4 | |
| 8.2 | 44 | 27–42 | 4 | |
| 8.1 | 44 | 27–42 | 4 | 1 more instruction than PHP 7.4 |
| 7.4 | 43 | 26–41 | 4 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 3
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
- wp_register_sidebar_widget()Registers an instance of a widget.
Source code
function register_sidebar_widget($name, $output_callback, $classname = '', ...$params) { _deprecated_function( __FUNCTION__, '2.8.0', 'wp_register_sidebar_widget()' ); // Compat. if ( is_array( $name ) ) { if ( count( $name ) === 3 ) { $name = sprintf( $name[0], $name[2] ); } else { $name = $name[0]; } } $id = sanitize_title( $name ); $options = array(); if ( ! empty( $classname ) && is_string( $classname ) ) { $options['classname'] = $classname; } wp_register_sidebar_widget( $id, $name, $output_callback, $options, ...$params );}Changelog
Introduced in 2.2.0. Unchanged from 6.7.7 through 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/deprecated.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.