WP_Site_Health::get_test_authorization_header() │ public │ WP 5.6.0

Tests if the Authorization header has the expected values.

Method of the class: WP_Site_Health{}

No Hooks.

Return

Array.

Usage

$WP_Site_Health = new WP_Site_Health();
$WP_Site_Health->get_test_authorization_header();

Changelog

WP_Site_Health::get_test_authorization_header() WP Site Health::get test authorization header code ^{WP 6.6.2}

public function get_test_authorization_header() {
	$result = array(
		'label'       => __( 'The Authorization header is working as expected' ),
		'status'      => 'good',
		'badge'       => array(
			'label' => __( 'Security' ),
			'color' => 'blue',
		),
		'description' => sprintf(
			'<p>%s</p>',
			__( 'The Authorization header is used by third-party applications you have approved for this site. Without this header, those apps cannot connect to your site.' )
		),
		'actions'     => '',
		'test'        => 'authorization_header',
	);

	if ( ! isset( $_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW'] ) ) {
		$result['label'] = __( 'The authorization header is missing' );
	} elseif ( 'user' !== $_SERVER['PHP_AUTH_USER'] || 'pwd' !== $_SERVER['PHP_AUTH_PW'] ) {
		$result['label'] = __( 'The authorization header is invalid' );
	} else {
		return $result;
	}

	$result['status']       = 'recommended';
	$result['description'] .= sprintf(
		'<p>%s</p>',
		__( 'If you are still seeing this warning after having tried the actions below, you may need to contact your hosting provider for further assistance.' )
	);

	if ( ! function_exists( 'got_mod_rewrite' ) ) {
		require_once ABSPATH . 'wp-admin/includes/misc.php';
	}

	if ( got_mod_rewrite() ) {
		$result['actions'] .= sprintf(
			'<p><a href="%s">%s</a></p>',
			esc_url( admin_url( 'options-permalink.php' ) ),
			__( 'Flush permalinks' )
		);
	} else {
		$result['actions'] .= sprintf(
			'<p><a href="%s" target="_blank" rel="noopener">%s<span class="screen-reader-text"> %s</span><span aria-hidden="true" class="dashicons dashicons-external"></span></a></p>',
			__( 'https://developer.wordpress.org/rest-api/frequently-asked-questions/#why-is-authentication-not-working' ),
			__( 'Learn how to configure the Authorization header.' ),
			/* translators: Hidden accessibility text. */
			__( '(opens in a new tab)' )
		);
	}

	return $result;
}