Function Hook_media_rendering_code->render
Definitions
sources/hooks/systems/media_rendering/code.php
- Provide code to display what is at the URL, in the most appropriate way.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $url | mixed | required parameter | N/A | N/A | URL to render |
| $url_safe | mixed | required parameter | N/A | N/A | URL to render (no sessions etc) |
| $attributes | array | required parameter | N/A | N/A | Attributes (e.g. width, height, length) |
| $as_admin | boolean | False | N/A | N/A | Whether there are admin privileges, to render dangerous media types |
| $source_member | ?MEMBER | Null | N/A | N/A | Member to run as (null: current member) |
| $url_direct_filesystem | ?URLPATH | Null | N/A | N/A | Direct URL (not via a script) (null: just use the normal URL) |
| $original_filename | ?string | Null | N/A | N/A | Originally filename to display as a link caption where appropriate (null: use $url_safe) |
Return
- Rendered version
- Type: Tempcode
- Set: N/A
- Range: N/A