viget/craft-video-embed

Generate an embed URL from a YouTube or Vimeo URL

Maintainers

Details

github.com/vigetlabs/craft-videoembed

Source

Issues

Documentation

Installs: 56 743

Dependents: 0

Suggesters: 0

Security: 0

Stars: 24

Watchers: 27

Forks: 4

Open Issues: 3

Type:craft-plugin

2.0.3 2024-04-02 16:31 UTC

Requires

MIT 9528d3d9d65a94471c7fed33c78ade21776da476

cmsCraftcraftcmscraft-pluginvideo embed

This package is auto-updated.

Last update: 2024-10-23 17:09:59 UTC

README

Generate an embed URL from a YouTube or Vimeo URL.

Requirements

This plugin requires Craft CMS 4.0.0 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

     cd /path/to/project

  2. Then tell Composer to load the plugin:

     composer require viget/craft-video-embed

  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Video Embed.

Using Video Embed

Pass a YouTube or Vimeo URL to the getVideoData method and a VideoData object is returned.

If the plugin is unable to parse the URL, null is returned.

  • type - If the video is youtube or vimeo
  • id - The ID of the video
  • image - The thumbnail of the video (only works for Youtube)
  • embedUrl - The URL you would use for the embed
  • url - The link to the embedded video

Example:

{% set video = craft.videoEmbed.getVideoData('https://www.youtube.com/watch?v=6xWpo5Dn254') %}

{% if video %}
   <iframe src="{{ video.embedUrl }}"></iframe>
{% endif %}

Output:

<iframe src="//www.youtube.com/embed/6xWpo5Dn254"></iframe>
Code At Viget

Visit code.viget.com to see more projects from Viget.