Documentation Category: Hook

gpi_disable_choices

Filter whether choices should be disabled if not removed.

gpi_remove_choices

Filter whether choices should be removed.

gpi_selected_values

Filter the selected values for the current choice-based field.

gpi_out_of_stock_message

Filter validation message when the item is out of stock.

gpi_pre_render_choice

DescriptionUsageParametersSinceDescription Filter to modify choices (includes whether the choice has exceeded its limit). Usage Apply to all fields on all forms. Apply to all fields …

gpi_choice_counts

Filter the number of claimed choice counts for the given field.

gpi_is_edit_view

Filter if the current page should be treated as an “Edit View” to bypass Inventory Limits and allow [re-]selection of exhausted choices.

gpi_query

Filter the query used to get claimed inventory counts.

gpi_resource_post_type_args

Modify the arguments used for registering the Resource post type.

gpi_inventory_limit_simple

Filter the inventory limit for fields using the Simple Inventory Type.

gpi_inventory_limit_advanced

Filter the inventory limit for fields using the Advanced Inventory Type.

gpi_reset_value_on_property_change

Filter whether to reset the value of the current field with inventory that is using properties. Clearing out the value of choice-based fields will reset the selected choice back to the placeholder or the first available option.

gpi_choice_input_types

Specify what input types should utilize choice-based inventory.

gpi_always_show_inventory_limit_in_editor

Force the Form Editor to always show the Inventory Limit for choices, products, and resources rather than the current inventory.

gpi_supported_field_types

Specify what field types are supported. This works in conjunction with gpi_supported_input_types by overriding specific field types. When adding a field type to this filter, you can provide a value of true to enable Inventory for all input types of a given field type. To limit it to certain input types for a field, provide an array of the supported input types.