WP_Recovery_Mode_Link_Service::get_recovery_mode_begin_url │ private │ WP 5.2.0

Gets a URL to begin recovery mode.

Method of the class: WP_Recovery_Mode_Link_Service{}

Returns

String. Recovery mode begin URL.

Usage

// private - for code of main (parent) class only
$result = $this->get_recovery_mode_begin_url( $token, $key );

$token(string) (required)

Recovery Mode token created by {@see generate_recovery_mode_token()}.

$key(string) (required)

Recovery Mode key created by {@see generate_and_store_recovery_mode_key()}.

Changelog

WP_Recovery_Mode_Link_Service::get_recovery_mode_begin_url() WP Recovery Mode Link Service::get recovery mode begin url code ^{WP 6.9.1}

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 );
}