wp_robots_max_image_preview_large() WordPress Function

This function allows you to control the maximum image preview size for large images in the WordPress Media Library. By default, WordPress will generate a preview image that is 800px wide for large images. This function allows you to override that default behavior and set a custom maximum width for the preview image.

wp_robots_max_image_preview_large( array $robots ) #

Adds max-image-preview:large to the robots meta tag.


Description

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 ‘wp_robots’ callback:

add_filter( 'wp_robots', 'wp_robots_max_image_preview_large' );

Top ↑

Parameters

$robots

(array)(Required)Associative array of robots directives.


Top ↑

Return

(array) Filtered robots directives.


Top ↑

Source

File: wp-includes/robots-template.php

function wp_robots_max_image_preview_large( array $robots ) {
	if ( get_option( 'blog_public' ) ) {
		$robots['max-image-preview'] = 'large';
	}
	return $robots;
}


Top ↑

Changelog

Changelog
VersionDescription
5.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.