Function __global->show_banner
Definitions
sources/banners.php
- Get the Tempcode for the display of the defined banner.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $name | ID_TEXT | required parameter | N/A | N/A | The name of the banner |
| $title_text | SHORT_TEXT | required parameter | N/A | N/A | The title text of the banner (displayed for a text banner only) |
| $caption | Tempcode | required parameter | N/A | N/A | The caption of the banner |
| $direct_code | LONG_TEXT | required parameter | N/A | N/A | The full HTML/PHP for the banner |
| $img_url | URLPATH | required parameter | N/A | N/A | The URL to the banner image |
| $source | ID_TEXT | required parameter | N/A | N/A | The name of the banner for the site that will get the return-hit (blank: none) |
| $url | URLPATH | required parameter | N/A | N/A | The URL to the banner's target |
| $b_type | ID_TEXT | required parameter | N/A | N/A | The banner type |
| $submitter | MEMBER | required parameter | N/A | N/A | The submitting user |
| $width | ?integer | Null | N/A | N/A | The width (null: standard for banner type) |
| $height | ?integer | Null | N/A | N/A | The height (null: standard for banner type) |
Return
- The rendered banner
- Type: Tempcode
- Set: N/A
- Range: N/A