WP_Recovery_Mode_Link_Service::get_recovery_mode_begin_url

Advertisement

Private Access Private Access

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.

Summery Summery

Gets a URL to begin recovery mode.

Syntax Syntax

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

Parameters Parameters

$token

(string) (Required) Recovery Mode token created by generate_recovery_mode_token().

$key

(string) (Required) Recovery Mode key created by generate_and_store_recovery_mode_key().

Return Return

(string) Recovery mode begin URL.

Source Source

File: wp-includes/class-wp-recovery-mode-link-service.php

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

		/**
		 * Filter 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 );
	}

Advertisement

Changelog Changelog

Changelog
Version Description
5.2.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.