WP_Recovery_Mode_Link_Service::get_recovery_mode_begin_url( string $token, string $key ): string

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Gets a URL to begin recovery mode.

Parameters

$tokenstringrequired
Recovery Mode token created by generate_recovery_mode_token().
$keystringrequired
Recovery Mode key created by generate_and_store_recovery_mode_key().

Return

string Recovery mode begin URL.

Source

private function get_recovery_mode_begin_url( $token, $key ) {

	$url = add_query_arg(
		array(
			'action'   => self::LOGIN_ACTION_ENTER,
			'rm_token' => $token,
			'rm_key'   => $key,
		),
		wp_login_url()
	);

	/**
	 * Filters the URL to begin recovery mode.
	 *
	 * @since 5.2.0
	 *
	 * @param string $url   The generated recovery mode begin URL.
	 * @param string $token The token used to identify the key.
	 * @param string $key   The recovery mode key.
	 */
	return apply_filters( 'recovery_mode_begin_url', $url, $token, $key );
}

Hooks

apply_filters( ‘recovery_mode_begin_url’, string $url, string $token, string $key )

Filters the URL to begin recovery mode.

Changelog

VersionDescription
5.2.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.