Function Media_renderer_with_fallback->fallback_render

Definitions

sources/media_renderer.php

  • If we are rendering in low-fi, result to simple image fall-back.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$url mixed No No required parameter N/A N/A URL to render
$url_safe mixed No No required parameter N/A N/A URL to render (no sessions etc)
$attributes array No No required parameter N/A N/A Attributes (e.g. width, height, length)
$as_admin boolean No No required parameter N/A N/A Whether there are admin privileges, to render dangerous media types
$source_member ?MEMBER No No required parameter N/A N/A Member to run as (null: current member)
$click_url ?mixed No No Null N/A N/A URL to route clicks through to (null: no special URL)

Returns

  • Rendered version (null: do not render)
  • Type: ?Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * If we are rendering in low-fi, result to simple image fall-back.
 *
 * @param  mixed $url URL to render
 * @param  mixed $url_safe URL to render (no sessions etc)
 * @param  array $attributes Attributes (e.g. width, height, length)
 * @param  boolean $as_admin Whether there are admin privileges, to render dangerous media types
 * @param  ?MEMBER $source_member Member to run as (null: current member)
 * @param  ?mixed $click_url URL to route clicks through to (null: no special URL)
 * @return ?Tempcode Rendered version (null: do not render)
 */
public function fallback_render($url, $url_safe, array $attributes, bool $as_admin, ?int $source_member, $click_url = null) : ?object