wppaste
WordPress

is_blog_user( int $blog_id = 0 ): bool

Since
MU (3.0.0)
Source
wp-includes/deprecated.php:2843
Checks if the current user belong to a given site.

Compatibility

Deprecated in WordPress 3.3.0. Use is_user_member_of_blog()

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

$blog_idintoptional
Site IDDefault: 0

Return value

bool
True if the current users belong to $blog_id, false if not.

Performance profile

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

Executed per call on PHP 8.5. The body compiles to 13.

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_blog_user()

Further down the call graph this can also reach query, cache, serialize, option 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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always13_deprecated_function(), get_current_user_id(), is_user_member_of_blog()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 13 instructions, 13 executed per call, 0 branches. 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_blog_user( $blog_id = 0 ) {	_deprecated_function( __FUNCTION__, '3.3.0', 'is_user_member_of_blog()' ); 	return is_user_member_of_blog( get_current_user_id(), $blog_id );}

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.

3.3.0
Deprecated. Use is_user_member_of_blog()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/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.