Function __global->is_video

Definitions

sources/images.php

  • Find whether the video specified is actually a 'video', based on file extension.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$name string No No required parameter N/A N/A A URL or file path to the video
$as_admin boolean No No required parameter N/A N/A Whether there are admin privileges, to render dangerous media types (client-side risk only)
$must_be_true_video boolean No No False N/A N/A Whether it really must be an actual video/audio, not some other kind of rich media which we may render in a video spot

Returns

  • Whether the string pointed to a file appeared to be a video
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find whether the video specified is actually a 'video', based on file extension.
 *
 * @param  string $name A URL or file path to the video
 * @param  boolean $as_admin Whether there are admin privileges, to render dangerous media types (client-side risk only)
 * @param  boolean $must_be_true_video Whether it really must be an actual video/audio, not some other kind of rich media which we may render in a video spot
 * @return boolean Whether the string pointed to a file appeared to be a video
 */
function is_video(string $name, bool $as_admin, bool $must_be_true_video = false) : bool