Function __global->breadcrumbs_get_default_stub
Definitions
sources/site.php
- Get the Tempcode for the default breadcrumbs stub. This isn't entirely a default, because it does work with breadcrumb_set_parents. We refer to it as a default as it is possible to override the whole breadcrumbs environment via the special BREADCRUMBS global variable.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $link_to_self_entrypoint | boolean | No | No | True | N/A | N/A | Whether we'll be providing a link to where we are currently at |
Returns
- The default breadcrumb stub
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get the Tempcode for the default breadcrumbs stub. This isn't entirely a default, because it does work with breadcrumb_set_parents. We refer to it as a default as it is possible to override the whole breadcrumbs environment via the special BREADCRUMBS global variable.
*
* @param boolean $link_to_self_entrypoint Whether we'll be providing a link to where we are currently at
* @return Tempcode The default breadcrumb stub
*/
function breadcrumbs_get_default_stub(bool $link_to_self_entrypoint = true) : object
* Get the Tempcode for the default breadcrumbs stub. This isn't entirely a default, because it does work with breadcrumb_set_parents. We refer to it as a default as it is possible to override the whole breadcrumbs environment via the special BREADCRUMBS global variable.
*
* @param boolean $link_to_self_entrypoint Whether we'll be providing a link to where we are currently at
* @return Tempcode The default breadcrumb stub
*/
function breadcrumbs_get_default_stub(bool $link_to_self_entrypoint = true) : object
