Gravity Wiz Gravity Wiz
GF Unique ID

gpui_unique_id

  1. Description
  2. Usage
  3. Parameters
  4. Examples
    1. Reset Genereated ID when it reaches a number
  5. Since

Description

Allows you to modify the generated Unique ID using a custom function.

This modifies a core aspect of this perk and may break your forms. Make sure that your custom function always returns a unique string by incorporating the $unique parameter in its output.

Usage

add_filter( 'gpui_unique_id', 'my_custom_function', 10, 3);

Parameters

  • unique string or integer

    The generated Unique ID.

  • form_id integer

    The ID of the current form containing the Unique ID (UID) field.

  • field_id integer

    The ID of the Unique ID form field.

Examples

Reset Genereated ID when it reaches a number

This example shows you how to reset a sequentially generated ID when it reaches a specific number.

<?php
/**
 * Gravity Perks // Unique ID // Reset Sequence at Specific Threshold
 * https://gravitywiz.com/documentation/gravity-forms-unique-id/
 *
 * Reset the sequence of a Sequential Unique ID field when the sequence reaches a specified number.
 */
add_filter( 'gpui_unique_id', function( $unique, $form_id, $field_id ) {

	// Update "123" to your form ID and "4" to the ID of your Unique ID field.
	if ( $form_id == 123 && $field_id == 4 ) {

		// Update "1" to the number the sequence should be reset to when the threshold is reached.
		$starting_number = 1;

		// Update "99" to the threshold at which the sequence should be reset.
		$reset_number = 99;

		if ( $unique == $reset_number ) {
			gp_unique_id()->set_sequential_starting_number( $form_id, $field_id, $starting_number - 1 );
		}
	}

	return $unique;
}, 10, 3 );

Since

This filter is available since Gravity Forms Unique ID 1.3.13.

All Perks