wp_video_shortcode( array $attr, string $content = '' ): string|void

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$attrarray

Attributes of the shortcode.

• $srcstringdefault: empty

  URL to the source of the video file.

• $heightintdefault: 360

  Height of the video embed in pixels.

• $widthintdefault: $content_width or 640

  Width of the video embed in pixels.

• $posterstringdefault: empty

  The 'poster' attribute for the <video> element.

• $loopstringdefault: empty

  The 'loop' attribute for the <video> element.

• $autoplaystringdefault: empty

  The 'autoplay' attribute for the <video> element.

• $mutedstringdefault: false

  The 'muted' attribute for the <video> element.

• $preloadstringdefault: 'metadata'

  The 'preload' attribute for the <video> element.

• $classstringdefault: 'wp-video-shortcode'

  The 'class' attribute for the <video> element.

$contentstringoptional

Shortcode content.Default: ''

Return value

string|void

HTML content to display video.

Performance profile

How much work a call to wp_video_shortcode() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

146–190

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 449.

Plugin surface

4 hooks

Third-party callbacks on 'wp_video_shortcode_override', 'wp_video_shortcode_library', 'wp_video_shortcode_class' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 8 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_video_shortcode() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 4

4 hooks fire while wp_video_shortcode() runs, in this order:

1. 1
   apply_filters( wp_video_shortcode_override )filterline 3643 (+22 into the body)

   Filters the default video shortcode output.

2. 2
   apply_filters( wp_video_shortcode_library )filterline 3741 (+120 into the body)

   Filters the media library used for the video shortcode.

3. 3
   apply_filters( wp_video_shortcode_class )filterline 3777 (+156 into the body)

   Filters the class attribute for the video shortcode output container.

4. 4
   apply_filters( wp_video_shortcode )filterline 3865 (+244 into the body)

   Filters the output of the video shortcode.

Uses · 24

• get_post()Retrieves post data given a post ID or post object.
• get_the_ID()Retrieves the ID of the current item in the WordPress Loop.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_get_video_extensions()Returns a filtered list of supported video formats.
• shortcode_atts()Combines user attributes with known attributes and fill in defaults when needed.
• is_admin()Determines whether the current request is for an administrative interface page.
• wp_check_filetype()Retrieves the file type from the file name.
• wp_get_mime_types()Retrieves the list of mime types and file extensions.
• esc_url()Checks and cleans a URL.
• esc_html()Escaping for HTML blocks.
• wp_enqueue_script()Enqueues a script.
• get_attached_media()Retrieves media attached to the passed post.

Used by · 3

• WP_Widget_Media_Video::render_media()Render the media on the frontend.
• edit_form_image_editor()Displays the image and editor in the post editor
• prepend_attachment()Wraps attachment in paragraph tag before content.

Source code

View on Trac ↗View on GitHub ↗

3621function wp_video_shortcode( $attr, $content = '' ) {3622	global $content_width;3623	$post_id = get_post() ? get_the_ID() : 0;3624 3625	static $instance = 0;3626	++$instance;3627 3628	/**3629	 * Filters the default video shortcode output.3630	 *3631	 * If the filtered output isn't empty, it will be used instead of generating3632	 * the default video template.3633	 *3634	 * @since 3.6.03635	 *3636	 * @see wp_video_shortcode()3637	 *3638	 * @param string $html     Empty variable to be replaced with shortcode markup.3639	 * @param array  $attr     Attributes of the shortcode. See {@see wp_video_shortcode()}.3640	 * @param string $content  Video shortcode content.3641	 * @param int    $instance Unique numeric ID of this video shortcode instance.3642	 */3643	$override = apply_filters( 'wp_video_shortcode_override', '', $attr, $content, $instance );3644 3645	if ( '' !== $override ) {3646		return $override;3647	}3648 3649	$video = null;3650 3651	$default_types = wp_get_video_extensions();3652	$defaults_atts = array(3653		'src'      => '',3654		'poster'   => '',3655		'loop'     => '',3656		'autoplay' => '',3657		'muted'    => 'false',3658		'preload'  => 'metadata',3659		'width'    => 640,3660		'height'   => 360,3661		'class'    => 'wp-video-shortcode',3662	);3663 3664	foreach ( $default_types as $type ) {3665		$defaults_atts[ $type ] = '';3666	}3667 3668	$atts = shortcode_atts( $defaults_atts, $attr, 'video' );3669 3670	if ( is_admin() ) {3671		// Shrink the video so it isn't huge in the admin.3672		if ( $atts['width'] > $defaults_atts['width'] ) {3673			$atts['height'] = round( ( $atts['height'] * $defaults_atts['width'] ) / $atts['width'] );3674			$atts['width']  = $defaults_atts['width'];3675		}3676	} else {3677		// If the video is bigger than the theme.3678		if ( ! empty( $content_width ) && $atts['width'] > $content_width ) {3679			$atts['height'] = round( ( $atts['height'] * $content_width ) / $atts['width'] );3680			$atts['width']  = $content_width;3681		}3682	}3683 3684	$is_vimeo      = false;3685	$is_youtube    = false;3686	$yt_pattern    = '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#';3687	$vimeo_pattern = '#^https?://(.+\.)?vimeo\.com/.*#';3688 3689	$primary = false;3690	if ( ! empty( $atts['src'] ) ) {3691		$is_vimeo   = ( preg_match( $vimeo_pattern, $atts['src'] ) );3692		$is_youtube = ( preg_match( $yt_pattern, $atts['src'] ) );3693 3694		if ( ! $is_youtube && ! $is_vimeo ) {3695			$type = wp_check_filetype( $atts['src'], wp_get_mime_types() );3696 3697			if ( ! in_array( strtolower( $type['ext'] ), $default_types, true ) ) {3698				return sprintf( '<a class="wp-embedded-video" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );3699			}3700		}

Changelog

Introduced in 3.6.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/media.php, 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.