Function Hook_health_check_marketing_seo_robotstxt->testRobotsTxtValidity

Definitions

sources/hooks/systems/health_checks/marketing_seo_robotstxt.php

  • Run a section of health checks.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$check_context integer No No required parameter N/A N/A The current state of the website (a CHECK_CONTEXT__* constant)
$manual_checks boolean No No False N/A N/A Mention manual checks
$automatic_repair boolean No No False N/A N/A Do automatic repairs where possible
$use_test_data_for_pass ?boolean No No 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 No No Null N/A N/A List of URLs and/or page-links to operate on, if applicable (null: those configured)
$comcode_segments ?array No No Null N/A N/A Map of field names to Comcode segments to operate on, if applicable (null: N/A)

Preview

Code (PHP)

/**
 * Run a section of health checks.
 *
 * @param  integer $check_context The current state of the website (a CHECK_CONTEXT__* constant)
 * @param  boolean $manual_checks Mention manual checks
 * @param  boolean $automatic_repair Do automatic repairs where possible
 * @param  ?boolean $use_test_data_for_pass Should test data be for a pass [if test data supported] (null: no test data)
 * @param  ?array $urls_or_page_links List of URLs and/or page-links to operate on, if applicable (null: those configured)
 * @param  ?array $comcode_segments Map of field names to Comcode segments to operate on, if applicable (null: N/A)
 */

public function testRobotsTxtValidity(int $check_context, bool $manual_checks = false, bool $automatic_repair = false, ?bool $use_test_data_for_pass = null, ?array $urls_or_page_links = null, ?array $comcode_segments = null)