Function __global->run_health_check
Definitions
sources/health_check.php
- Run a Health Check.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $has_fails | boolean | required parameter | N/A | N/A | Whether there are fails (returned by reference) |
| $sections_to_run | ?array | Null | N/A | N/A | Which check sections to run (null: all) |
| $show_passes | boolean | False | N/A | N/A | Mention passed checks |
| $show_skips | boolean | False | N/A | N/A | Mention skipped checks |
| $show_manual_checks | boolean | False | N/A | N/A | Mention manual checks |
| $automatic_repair | boolean | False | N/A | N/A | Do automatic repairs where possible |
| $use_test_data_for_pass | ?boolean | Null | N/A | N/A | Should test data be for a pass [if test data supported] (null: no test data) |
| $urls_or_page_links | ?array | Null | N/A | N/A | List of URLs and/or page-links to operate on, if applicable (null: those configured) |
| $comcode_segments | ?array | Null | N/A | N/A | Map of field names to Comcode segments to operate on, if applicable (null: N/A) |
| $check_context | ?integer | Null | N/A | N/A | The current state of the website (a CHECK_CONTEXT__* constant) (null: auto-decide) |
Return
- List of result categories with results, template-ready
- Type: array
- Set: N/A
- Range: N/A