WP_REST_Site_Health_Controller::get_item_schema() – Gets the schema for each site health test.

You appear to be a bot. Output may be restricted

Description

Gets the schema for each site health test.

Usage

$array = WP_REST_Site_Health_Controller::get_item_schema();

Parameters

Returns

array The test schema.

Source

File name: wordpress/wp-includes/rest-api/endpoints/class-wp-rest-site-health-controller.php
Lines:

1 to 57 of 57
  public function get_item_schema() {
    if ( $this->schema ) {
      return $this->schema;
    }

    $this->schema = array(
      '$schema'    => 'http://json-schema.org/draft-04/schema#',
      'title'      => 'wp-site-health-test',
      'type'       => 'object',
      'properties' => array(
        'test'        => array(
          'type'        => 'string',
          'description' => __( 'The name of the test being run.' ),
          'readonly'    => true,
        ),
        'label'       => array(
          'type'        => 'string',
          'description' => __( 'A label describing the test.' ),
          'readonly'    => true,
        ),
        'status'      => array(
          'type'        => 'string',
          'description' => __( 'The status of the test.' ),
          'enum'        => array( 'good', 'recommended', 'critical' ),
          'readonly'    => true,
        ),
        'badge'       => array(
          'type'        => 'object',
          'description' => __( 'The category this test is grouped in.' ),
          'properties'  => array(
            'label' => array(
              'type'     => 'string',
              'readonly' => true,
            ),
            'color' => array(
              'type'     => 'string',
              'enum'     => array( 'blue', 'orange', 'red', 'green', 'purple', 'gray' ),
              'readonly' => true,
            ),
          ),
          'readonly'    => true,
        ),
        'description' => array(
          'type'        => 'string',
          'description' => __( 'A more descriptive explanation of what the test looks for, and why it is important for the user.' ),
          'readonly'    => true,
        ),
        'actions'     => array(
          'type'        => 'string',
          'description' => __( 'HTML containing an action to direct the user to where they can resolve the issue.' ),
          'readonly'    => true,
        ),
      ),
    );

    return $this->schema;
  }
 

 View on GitHub View on Trac