Function Hook_addon_registry_core_rich_media->do_media_preview

Definitions

sources/hooks/systems/addon_registry/core_rich_media.php

  • Render a media preview through a specific template.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$template ID_TEXT No No required parameter N/A N/A Template name

Returns

  • Preview
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Render a media preview through a specific template.
 *
 * @param  ID_TEXT $template Template name
 * @return Tempcode Preview
 */
public function do_media_preview(string $template) : object