Function Hook_ecommerce_topic_pin->is_available
Definitions
sources/hooks/systems/ecommerce/topic_pin.php
- Check whether the product codename is available for purchase by the member.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: int
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $type_code | ID_TEXT | required parameter | N/A | N/A | The product codename |
| $member_id | MEMBER | required parameter | N/A | N/A | The member we are checking against |
| $req_quantity | integer | 1 | N/A | N/A | The number required |
| $must_be_listed | boolean | False | N/A | N/A | Whether the product must be available for public listing |
Return
- The availability code (a ECOMMERCE_PRODUCT_* constant)
- Type: integer
- Set: N/A
- Range: N/A