Docs: Correctly notate that the default `$width` and `$height` embed dimensions are passed to the `embed_defaults` filter as a compacted array, and not two distinct parameters.

Props swissspidy.
Fixes #34522.


git-svn-id: https://develop.svn.wordpress.org/trunk@35485 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-11-01 15:41:28 +00:00
parent bce985a5d7
commit d74794fdde
1 changed files with 4 additions and 4 deletions

View File

@ -43,7 +43,7 @@ function wp_embed_unregister_handler( $id, $priority = 10 ) {
} }
/** /**
* Create default array of embed parameters. * Creates default array of embed parameters.
* *
* The width defaults to the content width as specified by the theme. If the * 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. * theme does not specify a content width, then 500px is used.
@ -74,9 +74,9 @@ function wp_embed_defaults( $url = '' ) {
* *
* @since 2.9.0 * @since 2.9.0
* *
* @param int $width Width of the embed in pixels. * @param array $size An array of embed width and height values
* @param int $height Height of the embed in pixels. * in pixels (in that order).
* @param string $url The URL that should be embedded. * @param string $url The URL that should be embedded.
*/ */
return apply_filters( 'embed_defaults', compact( 'width', 'height' ), $url ); return apply_filters( 'embed_defaults', compact( 'width', 'height' ), $url );
} }