Changeset 49992 for trunk/src/wp-includes/default-filters.php

Timestamp:

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

Author:

flixos90

Message:

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.

File:

• trunk/src/wp-includes/default-filters.php (modified) (5 diffs)

trunk/src/wp-includes/default-filters.php

@@ -231 +231 @@
 // Email filters.
 add_filter( 'wp_mail', 'wp_staticize_emoji_for_email' );
+
+// Robots filters.
+add_filter( 'wp_robots', 'wp_robots_noindex' );
 
 // Mark site as no longer fresh.
@@ -292 +295 @@
 add_action( 'wp_head', 'locale_stylesheet' );
 add_action( 'publish_future_post', 'check_and_publish_future_post', 10, 1 );
-add_action( 'wp_head', 'noindex', 1 );
+add_action( 'wp_head', 'wp_robots', 1 );
 add_action( 'wp_head', 'print_emoji_detection_script', 7 );
 add_action( 'wp_head', 'wp_print_styles', 8 );
@@ -312 +315 @@
 
 if ( isset( $_GET['replytocom'] ) ) {
-    add_action( 'wp_head', 'wp_no_robots' );
+    add_filter( 'wp_robots', 'wp_robots_no_robots' );
 }
 
 // Login actions.
+add_action( 'login_head', 'wp_robots', 1 );
 add_filter( 'login_head', 'wp_resource_hints', 8 );
 add_action( 'login_head', 'wp_print_head_scripts', 9 );
@@ -586 +590 @@
 add_action( 'embed_head', 'wp_print_head_scripts', 20 );
 add_action( 'embed_head', 'wp_print_styles', 20 );
-add_action( 'embed_head', 'wp_no_robots' );
+add_action( 'embed_head', 'wp_robots' );
 add_action( 'embed_head', 'rel_canonical' );
 add_action( 'embed_head', 'locale_stylesheet', 30 );
@@ -597 +601 @@
 add_action( 'embed_footer', 'wp_print_footer_scripts', 20 );
 
+add_filter( 'wp_robots', 'wp_embed_no_robots' );
 add_filter( 'excerpt_more', 'wp_embed_excerpt_more', 20 );
 add_filter( 'the_excerpt_embed', 'wptexturize' );