Make WordPress Core

01/21/2021 01:35:16 AM (3 years ago)

Robots: Introduce Robots API.

This changeset introduces a filter-based Robots API, providing central control over the robots meta tag.

  • Introduces wp_robots() function which should be called anywhere a robots meta tag should be included.
  • Introduces wp_robots filter which allows adding or modifying directives for the robots meta tag. The wp_robots() function is entirely filter-based, i.e. if no filter is added to wp_robots, no directives will be present, and therefore the entire robots meta tag will be omitted.
  • Introduces the following wp_robots filter functions which replace similar existing functions that were manually rendering a robots meta tag:
    • wp_robots_noindex() replaces noindex(), which has been deprecated.
    • wp_robots_no_robots() replaces wp_no_robots(), which has been deprecated.
    • wp_robots_sensitive_page() replaces wp_sensitive_page_meta(), which has been deprecated. Its rendering of the referrer meta tag has been moved to another new function wp_strict_cross_origin_referrer().

Migration to the new functions is straightforward. For example, a call to add_action( 'wp_head', 'wp_no_robots' ) should be replaced with add_filter( 'wp_robots', 'wp_robots_no_robots' ).

Plugins and themes that render their own robots meta tags are encouraged to switch to rely on the wp_robots filter in order to use the central management layer now provided by WordPress core.

Props adamsilverstein, flixos90, timothyblynjacobs, westonruter.
See #51511.

1 edited


  • trunk/src/wp-includes/embed.php

    r49936 r49992  
    12441244    return $result;
     1248 * Adds noindex to the robots meta tag for embeds.
     1249 *
     1250 * Typical usage is as a {@see 'wp_robots'} callback:
     1251 *
     1252 *     add_filter( 'wp_robots', 'wp_embed_no_robots' );
     1253 *
     1254 * @since 5.7.0
     1255 *
     1256 * @param array $robots Associative array of robots directives.
     1257 * @return array Filtered robots directives.
     1258 */
     1259function wp_embed_no_robots( array $robots ) {
     1260    if ( ! is_embed() ) {
     1261        return $robots;
     1262    }
     1264    return wp_robots_no_robots( $robots );
Note: See TracChangeset for help on using the changeset viewer.