Whenever you're dealing with a link in your template, you're actually working with a Link object.
Link objects can be classified into two parts, the Link Type and the Link, which represent the settings and value respectively. All attributes and methods are available to you in templates, but you'll likely only need Link data for the front-end.
The Link Type represents the chosen type of link you want the link to be.
| Attribute | Description |
|---|---|
label | The label for the link type. |
handle | The handle for the link type. Automatically generated and cannot be changed. |
enabled | Whether the link type is enabled or not. |
isCustom | Whether this is a custom-created link type, or a default one. |
| Method | Description |
|---|---|
getSettingsConfig() | An array of variables for this link type, used in the field settings template and saved to the database. |
getInputConfig() | An array of variables for this link type, used in the field input Vue component. |
getSerializedValues() | An array of variables to save as the value of a link (its content) to the database. |
getFieldLayout() | Returns the field layout for fields and UI elements. |
An Element Link is an extension of a regular Link object, and is inherited by all element-base link types like an Entry, Category, etc.
| Attribute | Description |
|---|---|
sources | The allowed sources for users to pick elements from. |
selectionLabel | The text used for the Choose button to select an element. |
The Link represents the actual value of the field, as you'd want to output in your template.
| Attribute | Description |
|---|---|
type | Returns the link type class name chosen for the link. |
linkType | Returns the link type chosen for the link. |
url | The value used for the href for the link. Supports .env variables and aliases, and combines any prefix or suffix. |
text | The custom text for the label of the link. If an element link type, the title of the element will be used automatically. |
target | Returns _blank if the link should open in a new window. |
newWindow | Whether the link should open in a new window. |
linkUrl | The link URL. Supports .env variables and aliases. |
linkValue | The value of the link. This will vary depending on the link type. |
ariaLabel | The value for the aria-label attribute for the link. |
urlSuffix | The suffix value to append to the URL. |
linkTitle | The value for the title attribute for the link. |
classes | The value for the class attribute for the link. |
customAttributes | Any custom attributes for the link. |
| Method | Description |
|---|---|
getElement(status) | Returns the linked element if an element-based link type. status can be supplied to filter based on the status (by default, only live elements will be returned). |
hasElement(status) | Returns whether linked to an element, or an element-based link type. status can be supplied to filter based on the status (by default, only live elements will be returned). |
getLink(attributes) | Returns an <a> anchor element. Pass in an array of attributes to override any. |
getLinkAttributes(attributes, asString) | Returns a collection of attributes to be used when creating an <a> HTML element. You can also have this returned as a string instead of an array. |
An Element Link is an extension of a regular Link object, and is inherited by all element-base link types like an Entry, Category, etc.
| Attribute | Description |
|---|---|
linkSiteId | The site ID for the chosen linked element. |
An Embed Link contains extra content fetched from the link target.
| Method | Description |
|---|---|
getHtml() | Returns the HTML code for rendering a preview of the media. |
getData() | Returns the raw data as fetched from the link target. |
You can create Link objects programatically for cases where you might want to add links to a Hyper field in your own code. To do this, you'll need to create the Link object, and assign it to the field on the element that stores your Hyper field.
For example, let's say we have a Hyper field called ctaLink attached to an entry.
$value = new \verbb\hyper\links\Url();
$value->linkText = 'some text';
$value->linkValue = 'http://…';
$value->fields = [
'myCustomField' => 'some value',
];
$entry->setFieldValue('ctaLink', [$value]);
Here, we set the type of link we want to use, the linkText and linkValue as applicable, and any custom fields (fields) that are set for the link type. We then use $entry->setFieldValue() or $entry->setFieldValues() to add that link to the field's value. Note that we always deal with an array of links!
Similarly, for an Entry link type:
$value = new \verbb\hyper\links\Entry();
$value->linkValue = 1234;
$entry->setFieldValue('ctaLink', [$value]);
Where the linkValue represents the ID of the entry you are linking to.