WP_REST_Site_Health_Controller

Hooks fired · 1

Every hook that fires from inside WP_REST_Site_Health_Controller, in the order it appears in the class, grouped by the method that fires it.

Properties · 1

$site_healthWP_Site_Healthprivate

An instance of the site health class.

Methods · 12

• __construct()Site Health controller constructor.
• register_routes()Registers API routes.
• validate_request_permission()Validates if the current user can request this REST endpoint.
• test_background_updates()Checks if background updates work as expected.
• test_dotorg_communication()Checks that the site can reach the WordPress.org API.
• test_loopback_requests()Checks that loopbacks can be performed.
• test_https_status()Checks that the site's frontend can be accessed over HTTPS.
• test_authorization_header()Checks that the authorization header is valid.
• test_page_cache()Checks that full page cache is active.
• get_directory_sizes()Gets the current directory sizes for this install.
• load_admin_textdomain()Loads the admin textdomain for Site Health tests.
• get_item_schema()Gets the schema for each site health test.

Source

View on Trac ↗View on GitHub ↗

17class WP_REST_Site_Health_Controller extends WP_REST_Controller {18 19	/**20	 * An instance of the site health class.21	 *22	 * @since 5.6.023	 *24	 * @var WP_Site_Health25	 */26	private $site_health;27 28	/**29	 * Site Health controller constructor.30	 *31	 * @since 5.6.032	 *33	 * @param WP_Site_Health $site_health An instance of the site health class.34	 */35	public function __construct( $site_health ) {36		$this->namespace = 'wp-site-health/v1';37		$this->rest_base = 'tests';38 39		$this->site_health = $site_health;40	}41 42	/**43	 * Registers API routes.44	 *45	 * @since 5.6.046	 * @since 6.1.0 Adds page-cache async test.47	 *48	 * @see register_rest_route()49	 */50	public function register_routes() {51		register_rest_route(52			$this->namespace,53			sprintf(54				'/%s/%s',55				$this->rest_base,56				'background-updates'57			),58			array(59				array(60					'methods'             => 'GET',61					'callback'            => array( $this, 'test_background_updates' ),62					'permission_callback' => function () {63						return $this->validate_request_permission( 'background_updates' );64					},65				),66				'schema' => array( $this, 'get_public_item_schema' ),67			)68		);69 70		register_rest_route(71			$this->namespace,72			sprintf(73				'/%s/%s',74				$this->rest_base,75				'loopback-requests'76			),77			array(78				array(79					'methods'             => 'GET',80					'callback'            => array( $this, 'test_loopback_requests' ),81					'permission_callback' => function () {82						return $this->validate_request_permission( 'loopback_requests' );83					},84				),85				'schema' => array( $this, 'get_public_item_schema' ),86			)87		);88 89		register_rest_route(90			$this->namespace,91			sprintf(92				'/%s/%s',93				$this->rest_base,94				'https-status'95			),96			array(

History

Introduced in 5.6.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-includes/rest-api/endpoints/class-wp-rest-site-health-controller.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.