Function __global->render_media_url
Definitions
sources/media_renderer.php
- Render a media URL in the best way we can.
- 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 | The URL |
| $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). IMPORTANT NOTE: Only pass in 'mime_type' from user data if you have verified privileges to do so, no verification is done within the media API. |
| $as_admin | boolean | No | No | False | N/A | N/A | Whether there are admin privileges, to render dangerous media types |
| $source_member | ?MEMBER | No | No | Null | N/A | N/A | Member to run as (null: current member) |
| $acceptable_media | integer | No | No | 15 | N/A | N/A | Bitmask of media that we will support |
| $limit_to | ?ID_TEXT | No | No | Null | N/A | N/A | Limit to a media rendering hook (null: no limit) |
| $url_to_scan_against | ?URLPATH | No | No | Null | N/A | N/A | The URL to do media detection against (null: use $url) |
| $original_filename | ?string | No | No | Null | N/A | N/A | Originally filename to display as a link caption where appropriate (null: use $url_safe) |
Returns
- The rendered version (null: cannot render)
- Type: ?Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Render a media URL in the best way we can.
*
* @param mixed $url The URL
* @param mixed $url_safe URL to render (no sessions etc)
* @param array $attributes Attributes (e.g. width, height, length). IMPORTANT NOTE: Only pass in 'mime_type' from user data if you have verified privileges to do so, no verification is done within the media API.
* @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 integer $acceptable_media Bitmask of media that we will support
* @param ?ID_TEXT $limit_to Limit to a media rendering hook (null: no limit)
* @param ?URLPATH $url_to_scan_against The URL to do media detection against (null: use $url)
* @param ?string $original_filename Originally filename to display as a link caption where appropriate (null: use $url_safe)
* @return ?Tempcode The rendered version (null: cannot render)
*/
function render_media_url($url, $url_safe, array $attributes, bool $as_admin = false, ?int $source_member = null, int $acceptable_media = 15, ?string $limit_to = null, ?string $url_to_scan_against = null, ?string $original_filename = null) : ?object
* Render a media URL in the best way we can.
*
* @param mixed $url The URL
* @param mixed $url_safe URL to render (no sessions etc)
* @param array $attributes Attributes (e.g. width, height, length). IMPORTANT NOTE: Only pass in 'mime_type' from user data if you have verified privileges to do so, no verification is done within the media API.
* @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 integer $acceptable_media Bitmask of media that we will support
* @param ?ID_TEXT $limit_to Limit to a media rendering hook (null: no limit)
* @param ?URLPATH $url_to_scan_against The URL to do media detection against (null: use $url)
* @param ?string $original_filename Originally filename to display as a link caption where appropriate (null: use $url_safe)
* @return ?Tempcode The rendered version (null: cannot render)
*/
function render_media_url($url, $url_safe, array $attributes, bool $as_admin = false, ?int $source_member = null, int $acceptable_media = 15, ?string $limit_to = null, ?string $url_to_scan_against = null, ?string $original_filename = null) : ?object