wp_embed_defaults( string $url = '' )
Creates default array of embed parameters.
Description 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 Parameters
- $url
-
(string) (Optional) The URL that should be embedded.
Default value: ''
Return Return
(array) Default embed parameters.
Source Source
File: wp-includes/embed.php
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 array $size An array of embed width and height values
* in pixels (in that order).
* @param string $url The URL that should be embedded.
*/
return apply_filters( 'embed_defaults', compact( 'width', 'height' ), $url );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example
$defaults = wp_embed_defaults(); var_dump( $defaults ); /* Example output: array(2) { ["width"]=> int(625) ["height"]=> float(938) } */