Skip to content

Kirby 4.1.2

video()

Creates a video embed via iframe for Youtube or Vimeo videos. The embed Urls are automatically detected from the given Url.

video(string $url, array $options = [ ], array $attr = [ ]): string|null

Parameters

Name Type Default
$url * string
$options array [ ]
$attr array [ ]

Return type

string|null

Examples

Basic example

<?= video('https://www.youtube.com/watch?v=QwjX8JAwBws') ?>

With parameters

You can add query parameters as arrays for the respective video type using the keys youtube or vimeo. In case you want to use both YouTube or Vimeo URLs, you can add options for both types.

<?= video('https://www.youtube.com/watch?v=QwjX8JAwBws', 
  [
    'youtube' => [
      'autoplay' => 1,
      'controls' => 0,
      'mute'     => 1
    ],
  ]
) ?>

With additional attributes

You can add additional attributes as a third parameter:

<?= video('https://www.youtube.com/watch?v=QwjX8JAwBws', 
  [
    'youtube' => [
      'autoplay' => 1,
      'controls' => 0,
      'mute'     => 1
    ],
  ], 
  [
    'class' => 'myvideo'
  ]
) ?>