WP_Site_Health::get_test_rest_availability(): array

Description

Return

array

The test results.

Hooks fired · 1

One hook fires while WP_Site_Health::get_test_rest_availability() runs, in this order:

1. 1
   apply_filters( https_local_ssl_verify )filterline 2231 (+38 into the body)

   Filters whether SSL should be verified for local HTTP API requests.

Uses · 11

• __()Retrieves the translation of $text.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• wp_create_nonce()Creates a cryptographic token tied to a specific action, user, user session, and window of time.
• rest_url()Retrieves the URL to a REST endpoint.
• add_query_arg()Retrieves a modified URL query string.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_remote_get()Performs an HTTP request using the GET method and returns its response.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_remote_retrieve_response_code()Retrieves only the response code from the raw response.
• wp_remote_retrieve_response_message()Retrieves only the response message from the raw response.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.

Source

View on Trac ↗View on GitHub ↗

2193	public function get_test_rest_availability() {2194		$result = array(2195			'label'       => __( 'The REST API is available' ),2196			'status'      => 'good',2197			'badge'       => array(2198				'label' => __( 'Performance' ),2199				'color' => 'blue',2200			),2201			'description' => sprintf(2202				'<p>%s</p>',2203				__( 'The REST API is one way that WordPress and other applications communicate with the server. For example, the block editor screen relies on the REST API to display and save your posts and pages.' )2204			),2205			'actions'     => '',2206			'test'        => 'rest_availability',2207		);2208 2209		$cookies = wp_unslash( $_COOKIE );2210		$timeout = 10; // 10 seconds.2211		$headers = array(2212			'Cache-Control' => 'no-cache',2213			'X-WP-Nonce'    => wp_create_nonce( 'wp_rest' ),2214		);2215		// Include Basic auth in loopback requests.2216		if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {2217			$headers['Authorization'] = 'Basic ' . base64_encode( wp_unslash( $_SERVER['PHP_AUTH_USER'] ) . ':' . wp_unslash( $_SERVER['PHP_AUTH_PW'] ) );2218		}2219 2220		$url = rest_url( 'wp/v2/types/post' );2221 2222		// The context for this is editing with the new block editor.2223		$url = add_query_arg(2224			array(2225				'context' => 'edit',2226			),2227			$url2228		);2229 2230		/** This filter is documented in wp-includes/class-wp-http-streams.php */2231		$sslverify = apply_filters( 'https_local_ssl_verify', false, $url );2232 2233		$r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );2234 2235		if ( is_wp_error( $r ) ) {2236			$result['status'] = 'critical';2237 2238			$result['label'] = __( 'The REST API encountered an error' );2239 2240			$result['description'] .= sprintf(2241				'<p>%s</p><p>%s<br>%s</p>',2242				__( 'When testing the REST API, an error was encountered:' ),2243				sprintf(2244					// translators: %s: The REST API URL.2245					__( 'REST API Endpoint: %s' ),2246					$url2247				),2248				sprintf(2249					// translators: 1: The WordPress error code. 2: The WordPress error message.2250					__( 'REST API Response: (%1$s) %2$s' ),2251					$r->get_error_code(),2252					$r->get_error_message()2253				)2254			);2255		} elseif ( 200 !== wp_remote_retrieve_response_code( $r ) ) {2256			$result['status'] = 'recommended';2257 2258			$result['label'] = __( 'The REST API encountered an unexpected result' );2259 2260			$result['description'] .= sprintf(2261				'<p>%s</p><p>%s<br>%s</p>',2262				__( 'When testing the REST API, an unexpected result was returned:' ),2263				sprintf(2264					// translators: %s: The REST API URL.2265					__( 'REST API Endpoint: %s' ),2266					$url2267				),2268				sprintf(2269					// translators: 1: The WordPress error code. 2: The HTTP status code error message.2270					__( 'REST API Response: (%1$s) %2$s' ),2271					wp_remote_retrieve_response_code( $r ),2272					wp_remote_retrieve_response_message( $r )

History

Introduced in 5.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

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

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-wp-site-health.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.