Return the markup value for a given field name or {tag} string
- If given a field name (or
name.subname
orname1|name2|name3
) it will return the markup value as defined by the fieldtype. - If given a string with field names referenced in
{tags}
, it will populate those tags and return the populated string.
Usage
$string = $page->getMarkup(string $key);
Arguments
Name | Type(s) | Description |
---|---|---|
key | string | Field name or markup string with field {name} tags in it |
Return value
string
Hooking $page->getMarkup(…)
You can add your own hook events that are executed either before or after the $page
method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.
Hooking before
The 'before' hooks are called immediately before each $page
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('Page::getMarkup', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$page = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$key = $event->arguments(0);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $key);
});
Hooking after
The 'after' hooks are called immediately after each $page
method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('Page::getMarkup', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$page = $event->object;
// An 'after' hook can retrieve and/or modify the return value
$return = $event->return;
// Get values of arguments sent to hook (if needed)
$key = $event->arguments(0);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
});
See Also
API reference based on ProcessWire core version 3.0.236