Deprecate renderEmbedCode() in 3.1.0, remove in 4.0.0

Updated 2026-04-30: removal target moved from 3.2.0 to 4.0.0 to comply with SemVer (removal of public API requires a major bump). Thanks to kmonty for the pushback.

Summary

The renderEmbedCode($width, $height, $autoplay, $title_format, $use_title_fallback) method should be deprecated in favor of renderEmbed(array $options).

The new renderEmbed() method provides a cleaner API that accepts an options array instead of positional parameters. The base implementation in ProviderPluginBase::renderEmbed() already delegates to renderEmbedCode() for backward compatibility, and all core providers (YouTube, Vimeo, YouTubePlaylist) already override renderEmbed() directly.

Steps

3.1.0

1. Add @deprecated in video_embed_field:3.1.0 and is removed from video_embed_field:4.0.0. Use \Drupal\video_embed_field\ProviderPluginInterface::renderEmbed() instead. to:
   • ProviderPluginInterface::renderEmbedCode()
   • ProviderPluginBase::renderEmbedCode()
2. Add a @trigger_error() call in ProviderPluginBase::renderEmbedCode() to emit a deprecation notice at runtime.
3. Update any remaining callers in the module to use renderEmbed() instead.

4.0.0

1. Remove renderEmbedCode() from ProviderPluginInterface.
2. Remove renderEmbedCode() from ProviderPluginBase.
3. Remove renderEmbedCode() overrides from provider plugins (YouTube, Vimeo, YouTubePlaylist).
4. Remove the delegation in ProviderPluginBase::renderEmbed() that calls renderEmbedCode().

Motivation

The options array pattern is more flexible and easier to extend without breaking the method signature. Third-party provider plugins (e.g. video_embed_dailymotion) need to support both methods during the transition period.