Function __global->render_screen_preview
Definitions
sources/lorem.php
- Shows the preview of a screen.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $hook | ?ID_TEXT | No | No | required parameter | N/A | N/A | The hook the preview is in (null: search) |
| $function | ID_TEXT | No | No | required parameter | N/A | N/A | The name of the screen preview |
| $template | ?ID_TEXT | No | No | Null | N/A | N/A | The template to be previewed (e.g. templates/DOWNLOAD_BOX.tpl) (null: do not consider template) |
Returns
- The previewed screen
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Shows the preview of a screen.
*
* @param ?ID_TEXT $hook The hook the preview is in (null: search)
* @param ID_TEXT $function The name of the screen preview
* @param ?ID_TEXT $template The template to be previewed (e.g. templates/DOWNLOAD_BOX.tpl) (null: do not consider template)
* @return Tempcode The previewed screen
*/
function render_screen_preview(?string $hook, string $function, ?string $template = null) : object
* Shows the preview of a screen.
*
* @param ?ID_TEXT $hook The hook the preview is in (null: search)
* @param ID_TEXT $function The name of the screen preview
* @param ?ID_TEXT $template The template to be previewed (e.g. templates/DOWNLOAD_BOX.tpl) (null: do not consider template)
* @return Tempcode The previewed screen
*/
function render_screen_preview(?string $hook, string $function, ?string $template = null) : object
