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