Changeset 50078

Timestamp:

01/29/2021 08:36:03 PM (4 years ago)

Author:

flixos90

Message:

Robots: Add max-image-preview:large directive by default.

This changeset introduces a wp_robots_max_image_preview_large() function which is hooked into the wp_robots filter to include the max-image-preview:large directive for all sites which are configured to be indexed by search engines. The directive allows search engines to display large image previews for the site in search results.

Props adamsilverstein, Clorith, flixos90, helen, joostdevalk, tweetythierry, westonruter.
Fixes #51511.

Location:

trunk

Files:

• src/wp-includes/default-filters.php (modified) (1 diff)
• src/wp-includes/robots-template.php (modified) (1 diff)
• tests/phpunit/tests/robots.php (modified) (1 diff)

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

@@ -234 +234 @@
 // Robots filters.
 add_filter( 'wp_robots', 'wp_robots_noindex' );
+add_filter( 'wp_robots', 'wp_robots_max_image_preview_large' );
 
 // Mark site as no longer fresh.

trunk/src/wp-includes/robots-template.php

@@ -134 +134 @@
     return $robots;
 }
+
+/**
+ * Adds 'max-image-preview:large' to the robots meta tag.
+ *
+ * This directive tells web robots that large image previews are allowed to be
+ * displayed, e.g. in search engines, unless the blog is marked as not being public.
+ *
+ * Typical usage is as a {@see 'wp_robots'} callback:
+ *
+ *     add_filter( 'wp_robots', 'wp_robots_max_image_preview_large' );
+ *
+ * @since 5.7.0
+ *
+ * @param array $robots Associative array of robots directives.
+ * @return array Filtered robots directives.
+ */
+function wp_robots_max_image_preview_large( array $robots ) {
+    if ( get_option( 'blog_public' ) ) {
+        $robots['max-image-preview'] = 'large';
+    }
+    return $robots;
+}

trunk/tests/phpunit/tests/robots.php

@@ -162 +162 @@
     }
 
+    /**
+     * @ticket 51511
+     */
+    public function test_wp_robots_max_image_preview_large() {
+        add_filter( 'wp_robots', 'wp_robots_max_image_preview_large' );
+
+        update_option( 'blog_public', '1' );
+        $output = get_echo( 'wp_robots' );
+        $this->assertContains( "'max-image-preview:large'", $output );
+
+        update_option( 'blog_public', '0' );
+        $output = get_echo( 'wp_robots' );
+        $this->assertEmpty( $output );
+    }
+
     public function add_noindex_directive( array $robots ) {
         $robots['noindex'] = true;