WP_Widget_Media_Image::render_media( array $instance )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$instancearray

Widget instance props.

Performance profile

How much work a call to WP_Widget_Media_Image::render_media() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

32–162

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 260.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()one call below WP_Widget_Media_Image::render_media()
• optionoption read or writeget_option()one call below WP_Widget_Media_Image::render_media()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 97 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Widget_Media_Image::render_media() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 15

• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• wp_parse_args()Merges user defined arguments into defaults array.
• get_post()Retrieves post data given a post ID or post object.
• get_intermediate_image_sizes()Gets the available intermediate image size names.
• _wp_get_image_size_from_meta()Gets the image size as array from its meta data.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• wp_get_attachment_image()Gets an HTML img element representing an image attachment.
• wp_get_loading_optimization_attributes()Gets loading optimization attributes.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• get_attachment_link()Retrieves the permalink for an attachment.
• esc_url()Checks and cleans a URL.
• esc_attr()Escaping for HTML attributes.

Source code

View on Trac ↗View on GitHub ↗

177	public function render_media( $instance ) {178		$instance = array_merge( wp_list_pluck( $this->get_instance_schema(), 'default' ), $instance );179		$instance = wp_parse_args(180			$instance,181			array(182				'size' => 'thumbnail',183			)184		);185 186		$attachment = null;187 188		if ( $this->is_attachment_with_mime_type( $instance['attachment_id'], $this->widget_options['mime_type'] ) ) {189			$attachment = get_post( $instance['attachment_id'] );190		}191 192		if ( $attachment ) {193			$caption = '';194			if ( ! isset( $instance['caption'] ) ) {195				$caption = $attachment->post_excerpt;196			} elseif ( trim( $instance['caption'] ) ) {197				$caption = $instance['caption'];198			}199 200			$image_attributes = array(201				'class' => sprintf( 'image wp-image-%d %s', $attachment->ID, $instance['image_classes'] ),202				'style' => 'max-width: 100%; height: auto;',203			);204			if ( ! empty( $instance['image_title'] ) ) {205				$image_attributes['title'] = $instance['image_title'];206			}207 208			if ( $instance['alt'] ) {209				$image_attributes['alt'] = $instance['alt'];210			}211 212			$size = $instance['size'];213 214			if ( 'custom' === $size || ! in_array( $size, array_merge( get_intermediate_image_sizes(), array( 'full' ) ), true ) ) {215				$size  = array( $instance['width'], $instance['height'] );216				$width = $instance['width'];217			} else {218				$caption_size = _wp_get_image_size_from_meta( $instance['size'], wp_get_attachment_metadata( $attachment->ID ) );219				$width        = empty( $caption_size[0] ) ? 0 : $caption_size[0];220			}221 222			$image_attributes['class'] .= sprintf( ' attachment-%1$s size-%1$s', is_array( $size ) ? implode( 'x', $size ) : $size );223 224			$image = wp_get_attachment_image( $attachment->ID, $size, false, $image_attributes );225 226		} else {227			if ( empty( $instance['url'] ) ) {228				return;229			}230 231			$instance['size'] = 'custom';232			$caption          = $instance['caption'];233			$width            = $instance['width'];234			$classes          = 'image ' . $instance['image_classes'];235			if ( 0 === $instance['width'] ) {236				$instance['width'] = '';237			}238			if ( 0 === $instance['height'] ) {239				$instance['height'] = '';240			}241 242			$attr = array(243				'class'  => $classes,244				'src'    => $instance['url'],245				'alt'    => $instance['alt'],246				'width'  => $instance['width'],247				'height' => $instance['height'],248			);249 250			$loading_optimization_attr = wp_get_loading_optimization_attributes(251				'img',252				$attr,253				'widget_media_image'254			);255 256			$attr = array_merge( $attr, $loading_optimization_attr );

Changelog

Introduced in 4.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/widgets/class-wp-widget-media-image.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.