_wp_register_default_connector_settings()

Compatibility

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

Performance profile

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

7

Executed per call on PHP 8.5. The body compiles to 109.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()one call below _wp_register_default_connector_settings()
• optionoption read or writeget_option()one call below _wp_register_default_connector_settings()

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 · 1 distinct outcome

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

Uses · 5

• get_registered_settings()Retrieves an array of registered settings.
• wp_get_connectors()Retrieves all registered connectors.
• register_setting()Registers a setting and its data.
• __()Retrieves the translation of $text.
• wp_connectors_sanitize_application_password_credentials()Sanitizes stored application-password credentials for a connector.

Source code

View on Trac ↗View on GitHub ↗

761function _wp_register_default_connector_settings(): void {762	$registered_settings = get_registered_settings();763 764	foreach ( wp_get_connectors() as $connector_data ) {765		$auth = $connector_data['authentication'];766		if ( 'api_key' !== $auth['method'] && 'application_password' !== $auth['method'] ) {767			continue;768		}769 770		if ( empty( $auth['setting_name'] ) || isset( $registered_settings[ $auth['setting_name'] ] ) ) {771			continue;772		}773		$setting_name = $auth['setting_name'];774 775		if ( ! isset( $connector_data['plugin']['is_active'] ) || ! is_callable( $connector_data['plugin']['is_active'] ) ) {776			continue;777		}778 779		if ( ! call_user_func( $connector_data['plugin']['is_active'] ) ) {780			continue;781		}782 783		if ( 'api_key' === $auth['method'] ) {784			register_setting(785				'connectors',786				$setting_name,787				array(788					'type'              => 'string',789					'label'             => sprintf(790						/* translators: %s: Connector name. */791						__( '%s API Key' ),792						$connector_data['name']793					),794					'description'       => sprintf(795						/* translators: %s: Connector name. */796						__( 'API key for the %s connector.' ),797						$connector_data['name']798					),799					'default'           => '',800					'show_in_rest'      => true,801					'sanitize_callback' => 'sanitize_text_field',802				)803			);804		} elseif ( 'application_password' === $auth['method'] ) {805			register_setting(806				'connectors',807				$setting_name,808				array(809					'type'              => 'object',810					'label'             => sprintf(811						/* translators: %s: Connector name. */812						__( '%s Credentials' ),813						$connector_data['name']814					),815					'description'       => sprintf(816						/* translators: %s: Connector name. */817						__( 'Application password credentials for the %s connector.' ),818						$connector_data['name']819					),820					'default'           => array(821						'username' => '',822						'password' => '',823					),824					'show_in_rest'      => array(825						'schema' => array(826							'type'                 => 'object',827							'properties'           => array(828								'username' => array(829									'type' => 'string',830								),831								'password' => array(832									'type' => 'string',833								),834							),835							'additionalProperties' => false,836						),837					),838					'sanitize_callback' => static function ( $value ) use ( $setting_name ) {839						return wp_connectors_sanitize_application_password_credentials( $value, $setting_name );840					},

Changelog

Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

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.