wp_embed_defaults( string $url = '' ): int[]
Creates default array of embed parameters.
Contents
Description
The width defaults to the content width as specified by the theme. If the theme does not specify a content width, then 500px is used.
The default height is 1.5 times the width, or 1000px, whichever is smaller.
The ’embed_defaults’ filter can be used to adjust either of these values.
Parameters
-
$urlstring Optional -
The URL that should be embedded.
Default:
''
Return
int[] Indexed array of the embed width and height in pixels.
- intThe embed width.
1intThe embed height.
Source
File: wp-includes/embed.php.
View all references
function wp_embed_defaults( $url = '' ) {
if ( ! empty( $GLOBALS['content_width'] ) ) {
$width = (int) $GLOBALS['content_width'];
}
if ( empty( $width ) ) {
$width = 500;
}
$height = min( ceil( $width * 1.5 ), 1000 );
/**
* Filters the default array of embed dimensions.
*
* @since 2.9.0
*
* @param int[] $size {
* Indexed array of the embed width and height in pixels.
*
* @type int $0 The embed width.
* @type int $1 The embed height.
* }
* @param string $url The URL that should be embedded.
*/
return apply_filters( 'embed_defaults', compact( 'width', 'height' ), $url );
}
Hooks
-
apply_filters( 'embed_defaults',
int[] $size ,string $url ) -
Filters the default array of embed dimensions.
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example