wp_get_user_contact_methods( WP_User|null $user = null ): string[]
- Since
- 3.7.0, 6.9.0
- Source
wp-includes/user.php:3024
Description
Default contact methods were removed for new installations in WordPress 3.6 and completely removed from the codebase in WordPress 6.9.
Use the 'user_contactmethods' filter to add or remove contact methods.
Compatibility
- WordPress
- since 6.9.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
$userWP_User|nulloptional- WP_User object.Default:
null
Return value
string[]- Array of contact method labels keyed by contact method.
Performance profile
How much work a call to wp_get_user_contact_methods() 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
- 8
- Plugin surface
- 1 hook
- Called by
- 4
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. The body compiles to 8.
Third-party callbacks on 'user_contactmethods' run inside this call, and their cost is not bounded by anything here.
4 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
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 wp_get_user_contact_methods() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 8 | 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: 8 instructions, 8 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.
Hooks and filters fired · 1
One hook fires while wp_get_user_contact_methods() runs, in this order:
- apply_filters( user_contactmethods )filterline 3035 (+11 into the body)
Filters the user contact methods.
Uses · 1
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 4
- _get_additional_user_keys()Returns a list of meta keys to be (maybe) populated in wp_update_user().
- _wp_get_user_contactmethods()The old private function for setting up user contact methods.
- edit_user()Edit user settings based on contents of $_POST
- wp_insert_user()Inserts a user into the database.
Source code
function wp_get_user_contact_methods( $user = null ) { $methods = array(); /** * Filters the user contact methods. * * @since 2.9.0 * * @param string[] $methods Array of contact method labels keyed by contact method. * @param WP_User|null $user WP_User object or null if none was provided. */ return apply_filters( 'user_contactmethods', $methods, $user );}Changelog
Introduced in 3.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
aim, jabber, and yim contact methods.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 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.