Procedural File: elastic.php
Source Location: /elastic.php
Classes:
Elastic
Handles internal framework operation. Do not access directly. Instead, use elastic_get() and elastic_set().
Page Details:
Elastic API: Access to atomic hook functions, context, paths, and Elastic data (prefixes, theme data).
Tags:
elastic_apply_atomic [line 390]
void elastic_apply_atomic(
string $id, mixed $value, [string $prefix = NULL])
|
|
Calls apply_filters() at all context levels. Filters are applied in the order: global, abstract, general, specific. Filters are not applied to null contexts. $value is updated every time apply_filters() is run. (i.e. apply_filters() at the 'specific' level receives any changes made at the 'global' level).
Tags:
Parameters
| string |
$id |
The id of the hook. |
| mixed |
$value |
The value to be filtered. |
| string |
$prefix |
Optional. Defaults to Elastic::$prefix. |
elastic_apply_atomic_specific [line 420]
void elastic_apply_atomic_specific(
string $id, mixed $value, [string $prefix = NULL])
|
|
Calls apply_filters() at the most specific atomic level with a registered action. For example, if filters were registered at the 'global' and 'general' levels, only the 'general' filter would be called.
Tags:
Parameters
| string |
$id |
The id of the hook. |
| mixed |
$value |
The value to be filtered. |
| string |
$prefix |
Optional. Defaults to Elastic::$prefix. |
elastic_do_atomic [line 341]
void elastic_do_atomic(
string $id, [ $prefix = NULL])
|
|
Calls do_action() at all context levels. Actions are run in the order: global, abstract, general, specific. Actions are not run for null contexts.
Tags:
Parameters
| string |
$id |
The id of the hook. |
| |
$prefix |
|
elastic_do_atomic_specific [line 362]
void elastic_do_atomic_specific(
string $id, [string $prefix = NULL])
|
|
Calls do_action() at the most specific atomic level with a registered action. For example, if actions were registered at the 'global' and 'general' levels, only the 'general' action would be called.
Tags:
Parameters
| string |
$id |
The id of the hook. |
| string |
$prefix |
Optional. Defaults to Elastic::$prefix. |
elastic_format_hook [line 449]
string elastic_format_hook(
string $id, [string $view = ''], [string $prefix = NULL])
|
|
Returns a formatted hook title.
Tags:
Parameters
elastic_get [line 279]
mixed elastic_get(
string $var)
|
|
Gets data within the global Elastic instance ($elastic).
Tags:
Parameters
elastic_get_path [line 316]
string elastic_get_path(
string $name, [string $arg1 = 'abs'], [string $arg2 = 'theme'])
|
|
Returns a path within the Elastic framework. Arguments specify absolute or URI, and theme or child theme. Takes a path $name, then up to two optional arguments: ['abs' or 'uri'] and ['theme' or 'child']. Defaults to 'abs' and 'theme'.
Tags:
Parameters
| string |
$name |
The name of the path requested. A common value is 'custom'. |
| string |
$arg1 |
Optional. Takes ['abs' or 'uri'] or ['theme' or 'child'] |
| string |
$arg2 |
Optional. Takes ['abs' or 'uri'] or ['theme' or 'child'] |
elastic_module_format_hook [line 464]
string elastic_module_format_hook(
string $id, [string $view = ''])
|
|
Returns a formatted hook title with the module prefix.
Tags:
Parameters
elastic_set [line 297]
void elastic_set(
string $var, string $value)
|
|
Sets data within the global Elastic instance ($elastic).
Tags:
Parameters
| string |
$var |
Variable name to set. |
| string |
$value |
Value to be set. |
|
|