wp_get_user_contact_methods( WP_User|null $user = null ): string[]

Description

Compatibility

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

Moderate

Reads stored settings via get_site_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

13–26

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

Plugin surface

1 hook

Third-party callbacks on 'user_contactmethods' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionnetwork optionget_site_option()called directly
• hookthird-party callbacksapply_filters()called directly

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

Hooks and filters fired · 1

One hook fires while wp_get_user_contact_methods() runs, in this order:

1. 1
   apply_filters( user_contactmethods )filterline 2964 (+18 into the body)

   Filters the user contact methods.

Uses · 3

• get_site_option()Retrieve an option value for the current network based on name of option.
• __()Retrieves the translation of $text.
• 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

View on Trac ↗View on GitHub ↗

2946function wp_get_user_contact_methods( $user = null ) {2947	$methods = array();2948	if ( get_site_option( 'initial_db_version' ) < 23588 ) {2949		$methods = array(2950			'aim'    => __( 'AIM' ),2951			'yim'    => __( 'Yahoo IM' ),2952			'jabber' => __( 'Jabber / Google Talk' ),2953		);2954	}2955 2956	/**2957	 * Filters the user contact methods.2958	 *2959	 * @since 2.9.02960	 *2961	 * @param string[]     $methods Array of contact method labels keyed by contact method.2962	 * @param WP_User|null $user    WP_User object or null if none was provided.2963	 */2964	return apply_filters( 'user_contactmethods', $methods, $user );2965}

Changelog

Introduced in 3.7.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.

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.