WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_robots_no_robots()

wp_robots_no_robots( array $robots ): array

In this article

Back to top

Adds noindex to the robots meta tag.

Description

This directive tells web robots not to index the page content.

Typical usage is as a ‘wp_robots’ callback:

add_filter( 'wp_robots', 'wp_robots_no_robots' );

Parameters

$robotsarrayrequired
Associative array of robots directives.

Return

array Filtered robots directives.

Source

function wp_robots_no_robots( array $robots ) {	$robots['noindex'] = true;	if ( get_option( 'blog_public' ) ) {	$robots['follow'] = true;	} else {	$robots['nofollow'] = true;	}	return $robots; }

View all references View on Trac View on GitHub

UsesDescription
get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Used byDescription
wp_robots_noindex()wp-includes/robots-template.php

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

wp_robots_noindex_embeds()wp-includes/robots-template.php

Adds noindex to the robots meta tag for embeds.

wp_robots_noindex_search()wp-includes/robots-template.php

Adds noindex to the robots meta tag if a search is being performed.

Changelog

VersionDescription
5.7.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Rolf Allard van Hagen
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Two examples, both adding noindex to all Post Format archives:

    add_action( 'wp_head', function() { is_tax( 'post_format' ) && add_filter( 'wp_robots', 'wp_robots_no_robots' ); }, 0 );

    (Note: a priority of 0 otherwise the action runs too late.)

    add_filter( 'wp_robots', function ( array $robots ) { if ( is_tax( 'post_format' ) ) { return wp_robots_no_robots( $robots ); } return $robots; } );

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