gpapf_init_args

  1. Description
  2. Usage
  3. Parameters
  4. Since
  5. Examples
    1. Set Default Country for Specific Field
    2. Set API key for IPinfo.io

Description

Filter the args to initialize Advanced Phone Field on the frontend.

Usage

Apply to all GPAPF-enabled Phone fields.

add_filter( 'gpapf_init_args', 'my_custom_function' );

Apply to all GPAPF-enabled Phone fields on a specific form.

add_filter( 'gpapf_init_args_FORMID', 'my_custom_function' );

Apply to a specific GPAPF-enabled Phone field on a specific form.

add_filter( 'gpapf_init_args_FORMID_FIELDID', 'my_custom_function' );

Parameters

  • args array

    Arguments used to initialize the JavaScript instance of GP_Advanced_Phone_Field.

  • field \GF_Field

    The current field.

  • form array

    The current form.

Since

This filter is available since Gravity Forms Advanced Phone Field 1.0.

Examples

Set Default Country for Specific Field

<?php
/**
 * Gravity Perks // Advanced Phone Field // Set Default Country for a Specific Field
 * https://gravitywiz.com/documentation/gravity-forms-advanced-phone-field/
 */
// Update "123" to your form ID and "4" to your Advanced Phone Field's ID.
add_filter( 'gpapf_init_args_123_4', function( $args ) {
	$args['defaultCountry'] = 'GB';
	return $args;
} );

Set API key for IPinfo.io

add_filter( 'gpapf_init_args', function( $args ) {
	$args['ipInfoAPIToken'] = 'abc123';
	return $args;
} );