wp_is_password_reset_allowed_for_user( int|WP_User $user ): bool|WP_Error
- Since
- 6.3.0
- Source
wp-includes/user.php:5279
Compatibility
- WordPress
- since 6.3.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|WP_Error- True if allowed, false or WP_Error otherwise.
Performance profile
How much work a call to wp_is_password_reset_allowed_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–28
- 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 29.
Third-party callbacks on 'allow_password_reset' 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_password_reset_allowed_for_user()
What one call costs · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_is_password_reset_allowed_for_user() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_object($user) | 5 | none |
is_object($user) && !->exists() | 8 | ->exists() |
!is_object($user) | 9 | get_userdata() |
!is_object($user) && !->exists() | 12 | get_userdata(), ->exists() |
is_object($user) && ->exists() && !is_multisite() | 19 | ->exists(), is_multisite(), apply_filters() |
is_object($user) && ->exists() && is_multisite() | 23–24 | ->exists(), is_multisite(), is_user_spammy(), apply_filters() |
!is_object($user) && ->exists() && !is_multisite() | 23 | get_userdata(), ->exists(), is_multisite(), apply_filters() |
!is_object($user) && ->exists() && is_multisite() | 27–28 | get_userdata(), ->exists(), is_multisite(), is_user_spammy(), 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: 29 instructions, 5–28 executed per call, 5 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_password_reset_allowed_for_user() runs, in this order:
- apply_filters( allow_password_reset )filterline 5300 (+21 into the body)
Filters whether to allow a password to be reset.
Uses · 4
- get_userdata()Retrieves user info by user ID.
- is_multisite()Determines whether Multisite is enabled.
- is_user_spammy()Determines whether a user is marked as a spammer, based on user login.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 2
- WP_Users_List_Table::single_row()Generates HTML for a single row on the users.php admin panel.
- get_password_reset_key()Creates, stores, then returns a password reset key for user.
Source code
function wp_is_password_reset_allowed_for_user( $user ) { if ( ! is_object( $user ) ) { $user = get_userdata( $user ); } if ( ! $user || ! $user->exists() ) { return false; } $allow = true; if ( is_multisite() && is_user_spammy( $user ) ) { $allow = false; } /** * Filters whether to allow a password to be reset. * * @since 2.7.0 * * @param bool $allow Whether to allow the password to be reset. Default true. * @param int $user_id The ID of the user attempting to reset a password. */ return apply_filters( 'allow_password_reset', $allow, $user->ID );}Changelog
Introduced in 6.3.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/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.