apply_filters( 'embed_thumbnail_image_shape', string $shape, int $thumbnail_id )
- Since
- 4.4.0, 4.5.0
Filters the thumbnail shape for use in the embed template.
Description
Rectangular images are shown above the title while square images are shown next to the content.
Compatibility
- WordPress
- since 4.5.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Parameters
$shapestring- Thumbnail image shape. Either 'rectangular' or 'square'.
$thumbnail_idint- Attachment ID.
Where this hook fires · 1
wp-includes/theme-compat/embed-content.php:75file scope
Source code
* @since 4.4.0 * @since 4.5.0 Added `$thumbnail_id` parameter. * * @param string $shape Thumbnail image shape. Either 'rectangular' or 'square'. * @param int $thumbnail_id Attachment ID. */ $shape = apply_filters( 'embed_thumbnail_image_shape', $shape, $thumbnail_id ); } if ( $thumbnail_id && 'rectangular' === $shape ) : ?> <div class="wp-embed-featured-image rectangular"> <a href="<?php the_permalink(); ?>" target="_top">Changelog
Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
4.5.0
Added
$thumbnail_id parameter.from the docblock4.4.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, 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.