Skip to content

Kirby 5.0.4

video()

Creates a privacy-friendly video embed via iframe for YouTube

video(string $url, Kirby\Cms\File $poster, array $options = [ ], array $attr = [ ]): string|null

Parameters

Name Type Default
$urlrequired string no default value
$posterrequired Kirby\Cms\File no default value
$options array [ ]
$attr array [ ]

Return types

stringornull

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'
  ]
) ?>