From d74794fddecec9e5c91cdfa1b9cc12163ffe651c Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 1 Nov 2015 15:41:28 +0000 Subject: [PATCH] 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 --- src/wp-includes/embed-functions.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/wp-includes/embed-functions.php b/src/wp-includes/embed-functions.php index ba8b08df57..24604c1faa 100644 --- a/src/wp-includes/embed-functions.php +++ b/src/wp-includes/embed-functions.php @@ -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 * theme does not specify a content width, then 500px is used. @@ -74,9 +74,9 @@ function wp_embed_defaults( $url = '' ) { * * @since 2.9.0 * - * @param int $width Width of the embed in pixels. - * @param int $height Height of the embed in pixels. - * @param string $url The URL that should be embedded. + * @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 ); }