wp_robots │ filter-hook │ WP 5.7.0

Filters the directives to be included in the 'robots' meta tag.

The meta tag will only be included as necessary.

Usage

add_filter( 'wp_robots', 'wp_kama_robots_filter' );

/**
 * Function for `wp_robots` filter-hook.
 * 
 * @param array $robots Associative array of directives. Every key must be the name of the directive, and the corresponding value must either be a string to provide as value for the directive or a boolean `true` if it is a boolean directive, i.e. without a value.
 *
 * @return array
 */
function wp_kama_robots_filter( $robots ){

	// filter...
	return $robots;
}

$robots(array)

Associative array of directives. Every key must be the name of the directive, and the corresponding value must either be a string to provide as value for the directive or a boolean true if it is a boolean directive, i.e. without a value.

Changelog

Where the hook is called

$robots = apply_filters( 'wp_robots', array() );

Where the hook is used in WordPress

add_filter( 'wp_robots', 'wp_robots_sensitive_page' );

add_filter( 'wp_robots', 'wp_robots_no_robots' );

add_filter( 'wp_robots', 'wp_robots_noindex' );

add_filter( 'wp_robots', 'wp_robots_noindex_embeds' );

add_filter( 'wp_robots', 'wp_robots_noindex_search' );

add_filter( 'wp_robots', 'wp_robots_max_image_preview_large' );

add_filter( 'wp_robots', 'wp_robots_no_robots' );

add_filter( 'wp_robots', 'wp_robots_no_robots' );

remove_filter( 'wp_robots', 'wp_robots_noindex_embeds' );

remove_filter( 'wp_robots', 'wp_robots_noindex_search' );

add_filter( 'wp_robots', 'wp_robots_sensitive_page' );

add_filter( 'wp_robots', 'wp_robots_no_robots' );