Function __global->hyperlink
Definitions
sources/templates.php
- Get the Tempcode for a hyperlink.
- 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 | The URL to put in the hyperlink (URLPATH or Tempcode) |
| $caption | mixed | required parameter | N/A | N/A | The hyperlinks caption, format depends on $auto_escape (string or Tempcode) |
| $external | boolean | required parameter | N/A | N/A | Whether the link is an external one (by default, the external template makes it open in a new window) |
| $auto_escape | boolean | required parameter | N/A | N/A | Whether to automatically escape if $caption is plain-text entry so that it cannot contain HTML |
| $title | mixed | Blank (empty string) | N/A | N/A | Link title, in plain-text format (string or Tempcode) (blank: none) |
| $accesskey | ?string | Null | N/A | N/A | The access key to use (null: none) |
| $post_data | ?Tempcode | Null | N/A | N/A | Data to post (null: an ordinary link) |
| $rel | ?string | Null | N/A | N/A | Rel (link type) (null: no special type) |
| $overlay | ?ID_TEXT | Null | N/A | N/A | Open in overlay with the default link/form target being as follows (e.g. _top or _self) (null: an ordinary link) |
Return
- The generated hyperlink
- Type: Tempcode
- Set: N/A
- Range: N/A