gpi_inventory_limit_advanced

  1. Description
  2. Usage
  3. Parameters
  4. Examples
    1. Set inventory limit by custom field.
  5. Since

Description

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

Usage

Apply to all fields on all forms.

add_filter( 'gpi_inventory_limit_advanced', 'my_custom_function' );

Apply to all fields on a specific form.

add_filter( 'gpi_inventory_limit_advanced_FORMID', 'my_custom_function' );

Apply to a specific field on a specific form.

add_filter( 'gpi_inventory_limit_advanced_FORMID_FIELDID', 'my_custom_function' );

Parameters

  • inventory_limit int

    Inventory limit of the current field.

  • field GF_Field

    The current field.

Examples

Set inventory limit by custom field.

This example sets the inventory of an Advanced resource dynamically based on the inventory custom field of the post/page on which the form is embedded.

<?php
/**
 * Gravity Perks // Inventory // Set Inventory Limit by Custom Field
 * https://gravitywiz.com/documentation/gravity-forms-inventory/
 *
 * This filter sets the inventory of an Advanced resource dynamically based on the
 * inventory custom field of the post/page on which the form is embedded.
 */
add_filter( 'gpi_inventory_limit_advanced', function() {
	// Update 'inventory' to the custom field meta key.
	return get_post_meta( get_queried_object_id(), 'inventory', true );
} );

Since

This filter is available since Gravity Forms Inventory 1.0-beta-1.0.