gpcp_price (PHP)

  1. Description
  2. Usage
  3. Parameters

Description

Filter the matched pricing level’s price before it is compared to the submitted price.

This filter must be used with its JS counterpart to handle filtering the price on the frontend.

Usage

Apply to all fields on all forms.

add_filter( 'gpcp_price', 'my_custom_function' );

Apply to all fields on a specific form.

add_filter( 'gpcp_price_FORMID', 'my_custom_function' );

Apply to a specific field on a specific form.

add_filter( 'gpcp_price_FORMID_FIELDID', 'my_custom_function' );

Parameters

  • $price string|float

    The expected price of the matching pricing level.

  • $matched_pricing_level array

    The matched pricing level object to which the submitted price is being compared for validation.

  • $product array

    The product object that has been generated by the submitted price.

  • $field \GF_Field

    The current Product field.

  • $choice array

    The selected choice object from the current Product field. May be null if this is not a choice-based product.