Function __global->get_product_purchase_steps
Definitions
sources/ecommerce.php
- Find the purchasing module breadcrumb steps for a product.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $product_object | object | No | No | required parameter | N/A | N/A | The product object |
| $type_code | ID_TEXT | No | No | required parameter | N/A | N/A | Type code for product |
| $consider_categories | boolean | No | No | required parameter | N/A | N/A | Whether to consider a category screen |
Returns
- A structure describing the steps
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find the purchasing module breadcrumb steps for a product.
*
* @param object $product_object The product object
* @param ID_TEXT $type_code Type code for product
* @param boolean $consider_categories Whether to consider a category screen
* @return array A structure describing the steps
*/
function get_product_purchase_steps(object $product_object, string $type_code, bool $consider_categories) : array
* Find the purchasing module breadcrumb steps for a product.
*
* @param object $product_object The product object
* @param ID_TEXT $type_code Type code for product
* @param boolean $consider_categories Whether to consider a category screen
* @return array A structure describing the steps
*/
function get_product_purchase_steps(object $product_object, string $type_code, bool $consider_categories) : array
