wppaste
WordPress

is_user_option_local( string $key, int $user_id = 0, int $blog_id = 0 ): bool

Since
MU (3.0.0)
Source
wp-includes/ms-deprecated.php:546
Check whether a usermeta key has to do with the current blog.

Compatibility

Deprecated in WordPress 4.9.0. Kept for back-compatibility; avoid it in new code.

WordPress
since MU (3.0.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

$keystring
$user_idintoptional
Defaults to current user.Default: 0
$blog_idintoptional
Defaults to current blog.Default: 0

Return value

bool

Performance profile

How much work a call to is_user_option_local() 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
19–22

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksdo_action()one call below is_user_option_local()

Further down the call graph this can also reach query, option, cache, serialize 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 is_user_option_local() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
$blog_id != 019_deprecated_function(), wp_get_current_user(), ->get_blog_prefix()
$blog_id == 022_deprecated_function(), wp_get_current_user(), get_current_blog_id(), ->get_blog_prefix()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 22 instructions, 19–22 executed per call, 1 branch. The work does not change between versions.

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

Source code

View on Trac View on GitHub 

function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) {	global $wpdb; 	_deprecated_function( __FUNCTION__, '4.9.0' ); 	$current_user = wp_get_current_user();	if ( $blog_id == 0 ) {		$blog_id = get_current_blog_id();	}	$local_key = $wpdb->get_blog_prefix( $blog_id ) . $key; 	return isset( $current_user->$local_key );}

Changelog

Introduced in MU (3.0.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.

4.9.0
Deprecated.from the docblock
MU (3.0.0)
MU (3.0.0)from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/ms-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.