Opened 6 months ago
Last modified 3 weeks ago
#60178 accepted defect (bug)
wp_video_shortcode() outputs invalid HTML
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 6.7 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Media | Keywords: | has-patch |
Focuses: | Cc: |
Description
Did an audit of a website and found several invalid HTML for video tags that were output with wp_video_shortcode()
. The errors:
- Bad value
1
for attributeloop
on elementvideo
- Bad value
1
for attributeautoplay
on elementvideo
- Bad value
1
for attributemuted
on elementvideo
Based on documentation from Mozilla, all 3 are boolean attributes. Here is an example of function usage that produced the HTML validation errors:
<?php echo wp_video_shortcode( [ 'src' => wp_get_attachment_url(9999), 'class' => 'my-custom-video', 'poster' => '', 'loop' => 'true', 'autoplay' => 'true', 'muted' => 'true', 'height' => 1080, 'width' => 1920 ] );
This part in wp_video_shortcode()
is the culprit:
<?php $attr_strings = array(); foreach ( $html_atts as $k => $v ) { $attr_strings[] = $k . '="' . esc_attr( $v ) . '"'; }
Currently, we are using the filter to clean up these attributes like this:
<?php add_filter( 'wp_video_shortcode', function ( $output ) { // Clean up attributes for HTML validation $output = str_replace( [ 'autoplay="1"', 'loop="1"', 'muted="1"', ], [ 'autoplay', 'loop', 'muted', ], $output ); return $output; } );
Change History (9)
#1
@
6 months ago
- Component changed from Shortcodes to Media
- Keywords needs-patch added
- Version 6.4.2 deleted
#2
@
3 months ago
- Milestone changed from Awaiting Review to 6.6
The coding standards for HTML are still referencing XHTML standards, which tells me it may be time to do an update on those coding standards.
I think we should ignore the coding standards if they conflict with HTML standards, and as @sabernhardt observes, there is a precedent.
#3
@
3 months ago
HTML Coding standards update PR: https://github.com/WordPress/wpcs-docs/pull/136
#5
@
3 months ago
HTML standards updated: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/html/
This ticket was mentioned in Slack in #core-media by antpb. View the logs.
5 weeks ago
This ticket was mentioned in PR #6772 on WordPress/wordpress-develop by @shub07.
4 weeks ago
#7
- Keywords has-patch added; needs-patch removed
wp_video_shortcode() was chaging boolean attributes to 1, as of true === 1, in debug i notice it was directly happening after foreach, not by eascaping, so I have add a if statement to handle boolean attributes and make ternary opretion for them, so we can still escape value as WP standards and our problem solves too.
The attribute values were "1" with WordPress 5.0 and possibly since 4.0 (r30185). Also, the unit tests have expected that since r36240.
The handbook still says to use quotes for attribute values, though the comment form can print its attributes without values when the theme declares support.
To pass validation, the shortcode's attributes simply could have values that match the attribute:
Or instead of editing the
foreach
loop, the$html_atts
array could set the string values (similar to code proposed for thecontrols
attribute on #40590):Similar edits should be made for the audio shortcode too.