wp_robots_noindex() WordPress Function

The wp_robots_noindex() function is used to tell search engines not to index a certain page or post. This is useful if you have a page that you don't want people to find through search engines.

wp_robots_noindex( array $robots ) #

Adds noindex to the robots meta tag if required by the site configuration.


Description

If a blog is marked as not being public then noindex will be output to tell web robots not to index the page content. Add this to the ‘wp_robots’ filter.

Typical usage is as a ‘wp_robots’ callback:

add_filter( 'wp_robots', 'wp_robots_noindex' );

Top ↑

See also


Top ↑

Parameters

$robots

(array)(Required)Associative array of robots directives.


Top ↑

Return

(array) Filtered robots directives.


Top ↑

Source

File: wp-includes/robots-template.php

function wp_robots_noindex( array $robots ) {
	if ( ! get_option( 'blog_public' ) ) {
		return wp_robots_no_robots( $robots );
	}

	return $robots;
}


Top ↑

Changelog

Changelog
VersionDescription
5.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.