wp_connectors_get_application_password_credentials( array $auth ): array{username:

Description

Compatibility

Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$autharray

The connector's authentication configuration.

Return value

array{username:

string, password: string, source: string} Resolved credentials and their source: 'env', 'constant', 'database', or 'none'.

Performance profile

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

33–115

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksdo_action()one call below wp_connectors_get_application_password_credentials()
• cacheobject cachewp_cache_get()one call below wp_connectors_get_application_password_credentials()
• serializeserialisationmaybe_unserialize()one call below wp_connectors_get_application_password_credentials()

Further down the call graph this can also reach 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 · 14 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 5

• wp_connectors_parse_application_password_credentials()Parses a `username:password` credentials string.
• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• esc_html()Escaping for HTML blocks.
• get_option()Retrieves an option value based on an option name.

Used by · 1

• _wp_connectors_get_connector_script_module_data()Exposes connector settings to the connectors-wp-admin script module.

Source code

View on Trac ↗View on GitHub ↗

522function wp_connectors_get_application_password_credentials( array $auth ): array {523	// Check environment variable first.524	$env_var_name = $auth['env_var_name'] ?? '';525	if ( '' !== $env_var_name ) {526		$env_value = getenv( $env_var_name );527		if ( false !== $env_value && '' !== $env_value ) {528			$credentials = wp_connectors_parse_application_password_credentials( $env_value );529			if ( '' !== $credentials['username'] && '' !== $credentials['password'] ) {530				$credentials['source'] = 'env';531				return $credentials;532			}533 534			_doing_it_wrong(535				__FUNCTION__,536				sprintf(537					/* translators: %s: Environment variable name. */538					__( 'The %s environment variable must contain application password credentials in "username:password" format.' ),539					esc_html( $env_var_name )540				),541				'7.1.0'542			);543		}544	}545 546	// Check PHP constant.547	$constant_name = $auth['constant_name'] ?? '';548	if ( '' !== $constant_name && defined( $constant_name ) ) {549		$const_value = constant( $constant_name );550		if ( is_string( $const_value ) && '' !== $const_value ) {551			$credentials = wp_connectors_parse_application_password_credentials( $const_value );552			if ( '' !== $credentials['username'] && '' !== $credentials['password'] ) {553				$credentials['source'] = 'constant';554				return $credentials;555			}556 557			_doing_it_wrong(558				__FUNCTION__,559				sprintf(560					/* translators: %s: PHP constant name. */561					__( 'The %s constant must contain application password credentials in "username:password" format.' ),562					esc_html( $constant_name )563				),564				'7.1.0'565			);566		}567	}568 569	// Check database.570	$stored   = get_option( $auth['setting_name'] ?? '', array() );571	$username = is_array( $stored ) && isset( $stored['username'] ) && is_string( $stored['username'] ) ? $stored['username'] : '';572	$password = is_array( $stored ) && isset( $stored['password'] ) && is_string( $stored['password'] ) ? $stored['password'] : '';573 574	return array(575		'username' => $username,576		'password' => $password,577		'source'   => '' !== $username && '' !== $password ? 'database' : 'none',578	);579}

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/connectors.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.