Header Visuals > Header Video Vimeo url don't work

[llemurya]

In Customizer in Header Visuals Section on Header Video option, when I paste a Vimeo url, for example
​https://vimeo.com/185808340, the background header didn't appear, with Youtube it works as well.

[joemcgill]

Thanks @llemurya.

We currently don't have a handler defined to handle Vimeo URLs in wp-custom-header.js. We either need to write one, similar to the youtubeHandler() or note that only YouTube is supported in WordPress 4.7 and update the helper text in the customizer to be more accurate.

Additionally, we should consider how themes or plugins could extend the core functionality by adding their own handlers.

[bradyvercher]

Vimeo currently only supports ​background videos for Plus and PRO members and it's only experimental at this point, so there isn't a core handler for it.

The label in the Customizer needs to be updated to indicate that only YouTube is supported for now. There's also a validator for the external_video_header setting that probably needs to be updated or removed if it won't allow plugins to add additional handlers.

I'll try to put together a plugin to add Vimeo support as a proof of concept to see if anything needs to be adjusted to make adding new handlers easier.

[bradyvercher]

Video header handler for Vimeo

[bradyvercher]

custom-header-vimeo.php​ is a basic plugin for adding Vimeo support. It uses their official player API, which doesn't contain support for the background setting mentioned earlier. To set that, the iframe would need to be constructed manually, but this at least shows how a custom handler can be registered.

[celloexpressions]

Plugins can hook into the customizer validity filter to remove an invalid notice if there's a source they're adding. So I think adjusting the label is all that will be needed here. This should definitely live as a plugin for now, and would be good to see it on .org if someone's able to make a fully-fledged version.

[joemcgill]

Since the consensus is that we can't support Vimeo URLs by default, 38544.diff​ removes the reference to Vimeo from the description for the external header video controls.

[joemcgill]

In 39128:

Customize: Remove Vimeo reference from description for external header videos.

Vimeo's API requires a Pro account to display videos as background videos
(i.e., without player controls), thus we shouldn't support Vimeo
URLs by default in custom header videos. This removes the reference of Vimeo
from the control description in the customizer.

Fixes #38544.

[ocean90]

_validate_external_header_video() should be updated as well. It's confusing that the error message says that you should enter a Vimeo URL even if it's not supported.

[westonruter]

Also, in \WP_Customize_Manager::_validate_external_header_video() it’s using esc_url() with a (default) display context. It probably won’t impact the validation logic as it stands right now, but esc_url() will inject HTML entities into the returned string, so that could cause unexpected behavior. In short, I think this should be changed to use esc_url_raw() instead.

[peterwilsoncc]

In 38544.2.diff​:

• updated error message
• replaces esc_url with esc_url_raw (correct although benign in this context)

[joemcgill]

Good catch @ocean90 and @westonruter. 38544.2.diff​ looks good (thanks @peterwilsoncc).

[joemcgill]

In 39148:

Customize: Remove Vimeo validation for external videos.

Following [39128], this removes the validation logic for Vimeo URLs from
_validate_external_header_video() since WP does not support the
display of videos from Vimeo by default.

This also includes a change to using esc_url_raw() instead of esc_url()
on the URL value to avoid unexpected behavior from the inclusion of HTML
entities.

Props peterwilsoncc, westonruter.
Fixes #38544.

[afercia]

Was just commenting while @joemcgill committed [39148] :) I'd say to remove references to Vimeo from the inline documentation too, see * Ensures that the provided URL is for YouTube or Vimeo.. Probably also remove the regex for Vimeo from get_header_video_settings()

[joemcgill]

38544.3.diff​ removes the mime type logic for Vimeo URLs from get_header_video_settings() and cleans up the docs for _validate_external_header_video().

[joemcgill]

In 39165:

Themes: Remove Vimeo logic from header_video_settings().

Following [39148] and [39128], this removes the mime type logic for
Vimeo URLs from get_header_video_settings() and removes remaining
Vimeo reference from _validate_external_header_video() docs.

Fixes #38544.