Function __global->catalogue_category_breadcrumbs
Definitions
sources/catalogues.php
- Get a formatted HTML string of the route back to the specified root, from the specified catalogue category.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $category_id | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The category we are finding for (null: already ascended too far for anything to be left) |
| $root | ?AUTO_LINK | No | No | Null | N/A | N/A | The root of the tree (null: the true root) |
| $include_link | boolean | No | No | False | N/A | N/A | Whether to include category links at this level (the recursed levels will always contain links - the top level is optional, hence this parameter) |
| $attach_to_url_filter | boolean | No | No | False | N/A | N/A | Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing |
Returns
- The breadcrumbs
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a formatted HTML string of the route back to the specified root, from the specified catalogue category.
*
* @param ?AUTO_LINK $category_id The category we are finding for (null: already ascended too far for anything to be left)
* @param ?AUTO_LINK $root The root of the tree (null: the true root)
* @param boolean $include_link Whether to include category links at this level (the recursed levels will always contain links - the top level is optional, hence this parameter)
* @param boolean $attach_to_url_filter Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing
* @return array The breadcrumbs
*/
function catalogue_category_breadcrumbs(?int $category_id, ?int $root = null, bool $include_link = false, bool $attach_to_url_filter = false) : array
* Get a formatted HTML string of the route back to the specified root, from the specified catalogue category.
*
* @param ?AUTO_LINK $category_id The category we are finding for (null: already ascended too far for anything to be left)
* @param ?AUTO_LINK $root The root of the tree (null: the true root)
* @param boolean $include_link Whether to include category links at this level (the recursed levels will always contain links - the top level is optional, hence this parameter)
* @param boolean $attach_to_url_filter Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing
* @return array The breadcrumbs
*/
function catalogue_category_breadcrumbs(?int $category_id, ?int $root = null, bool $include_link = false, bool $attach_to_url_filter = false) : array
