Keep up to date with Gravity PDF

  • This field is for validation purposes and should be left unchanged.
Gravity PDF v4 will receive bug fixes and security updates until October 4, 2019, however it's recommended you upgrade to v5 as soon as practical.
Jump To Section

Description #description

This field can be used to create new core PDF template fields and make them available to the PDF configuration.

Parameters #parameters

$fields | array
The associative array which holds the field ID in the array key and the method/function which will get passed to PHP’s call_user_func function.
$template_settings | array
The current template settings being run. Read more about template configurations here.
$class | object
The current template’s configuration class being processed.

Usage #usage

This snippet shows how to leverage this filter to create a new core field and define that core field’s settings:

add_action( 'gfpdf_core_template_fields_list', function( $fields, $template_settings, $class ) {
    $fields['prefix_custom_core_field'] = 'prefix_custom_core_field_function'; /* the value references our callback. Anything PHP's `call_user_func` function accepts can be passed here */

    return $fields;
}, 10, 3 );

/**
 * This is our callback function which includes our new field details
 * See https://gravitypdf.com/documentation/v4/developer-template-configuration-and-image/#custom-fields for details about the array structure
 * If a PDF template configuration passes `prefix_custom_core_field` as true in it's core array this field will now show on the PDF template tab
 */
function prefix_custom_core_field_function() {
    return array(
        'id' => 'prefix_custom_core_field',
        'name'    => __( 'Custom Field', 'prefix-text-domain' ),
        'type'    => 'radio',
        'options' => array(
            'Yes' => __( 'Yes', 'gravity-forms-pdf-extended' ),
            'No'  => __( 'No', 'gravity-forms-pdf-extended' ),
        ),
        'std'     => __( 'No', 'gravity-forms-pdf-extended' ),
    );

    return $fields;
}

While this adds a new core field you still need to process the value when set. Use the gfpdf_core_template action to do this.

Source Code #source-code

This filter is located in the Model_Form_Settings::setup_core_custom_appearance_settings() method of /src/model/Model_Form_Settings.php.

Signup for the latest Gravity PDF news, tips and updates

  • This field is for validation purposes and should be left unchanged.
Scroll To Top

Choose your currency:

Close
Converted prices are for reference only - all orders are charged in $ Australian Dollars ($) AUD.
  • AUDAustralian Dollars ($)
  • USDUS Dollars ($)
  • CADCanadian Dollars ($)
  • EUREuros (€)
  • GBPPound Sterling (£)
  • NZDNew Zealand Dollar ($)
  • JPYJapanese Yen (¥)