WP_Site_Health::get_test_search_engine_visibility(): array

In this article

Tests whether search engine indexing is enabled.

Description

Surfaces as “good” if blog_public === 1, or “recommended” if blog_public === 0.

Return

array The test results.

Source

public function get_test_search_engine_visibility() {
	$result = array(
		'label'       => __( 'Search engine indexing is enabled.', 'default' ),
		'status'      => 'good',
		'badge'       => array(
			'label' => __( 'Privacy', 'default' ),
			'color' => 'blue',
		),
		'description' => sprintf(
			'<p>%s</p>',
			__( 'Search engines can crawl and index your site. No action needed.', 'default' )
		),
		'actions'     => sprintf(
			'<p><a href="%1$s">%2$s</a></p>',
			esc_url( admin_url( 'options-reading.php#blog_public' ) ),
			__( 'Review your visibility settings', 'default' )
		),
		'test'        => 'search_engine_visibility',
	);

	// If indexing is discouraged, flip to “recommended”:
	if ( ! get_option( 'blog_public' ) ) {
		$result['status']         = 'recommended';
		$result['label']          = __( 'Search engines are discouraged from indexing this site.', 'default' );
		$result['badge']['color'] = 'blue';
		$result['description']    = sprintf(
			'<p>%s</p>',
			__( 'Your site is hidden from search engines. Consider enabling indexing if this is a public site.', 'default' )
		);
	}

	return $result;
}

Changelog

VersionDescription
6.9.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.