wp_is_application_passwords_available_for_user( int|WP_User $user ): bool
- Since
- 5.6.0
- Source
wp-includes/user.php:5091
Description
By default all users can use Application Passwords. Use 'wp_is_application_passwords_available_for_user' to restrict availability to certain users.
Compatibility
- WordPress
- since 5.6.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
$userint|WP_User- The user to check.
Return value
bool
Performance profile
How much work a call to wp_is_application_passwords_available_for_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
- Heavy
- Scaling
- Constant
- Instructions
- 5–20
- Plugin surface
- 1 hook
- Called by
- 2
Reaches the database via get_user_by().
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 22.
Third-party callbacks on 'wp_is_application_passwords_available_for_user' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - querycontent query
get_user_by()one call below wp_is_application_passwords_available_for_user()
Further down the call graph this can also reach 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 · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_is_application_passwords_available_for_user() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 5–8 | wp_is_application_passwords_available() |
wp_is_application_passwords_available() && is_object($user) && !->exists() | 11 | wp_is_application_passwords_available(), ->exists() |
wp_is_application_passwords_available() && !is_object($user) | 12 | wp_is_application_passwords_available(), get_userdata() |
wp_is_application_passwords_available() && !is_object($user) && !->exists() | 15 | wp_is_application_passwords_available(), get_userdata(), ->exists() |
wp_is_application_passwords_available() && is_object($user) && ->exists() | 16 | wp_is_application_passwords_available(), ->exists(), apply_filters() |
wp_is_application_passwords_available() && !is_object($user) && ->exists() | 20 | wp_is_application_passwords_available(), get_userdata(), ->exists(), apply_filters() |
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, 5–20 executed per call, 4 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.
Hooks and filters fired · 1
One hook fires while wp_is_application_passwords_available_for_user() runs, in this order:
- apply_filters( wp_is_application_passwords_available_for_user )filterline 5112 (+21 into the body)
Filters whether Application Passwords is available for a specific user.
Uses · 3
- wp_is_application_passwords_available()Checks if Application Passwords is globally available.
- get_userdata()Retrieves user info by user ID.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 2
- WP_REST_Application_Passwords_Controller::get_user()Gets the requested user.
- wp_authenticate_application_password()Authenticates the user using an application password.
Source code
function wp_is_application_passwords_available_for_user( $user ) { if ( ! wp_is_application_passwords_available() ) { return false; } if ( ! is_object( $user ) ) { $user = get_userdata( $user ); } if ( ! $user || ! $user->exists() ) { return false; } /** * Filters whether Application Passwords is available for a specific user. * * @since 5.6.0 * * @param bool $available True if available, false otherwise. * @param WP_User $user The user to check. */ return apply_filters( 'wp_is_application_passwords_available_for_user', true, $user );}Changelog
Introduced in 5.6.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 6.8.8 tag, from
src/wp-includes/user.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.