gfpdf_first_page_footer_field_setting

Return the optional template-specific first page footer field.

Description

Returns (array)

Parameters (8)

0. $id_first_footer — Optional. (unknown) => [ 'id' => 'first_footer'
The id first footer.
1. $name_esc_html_first_page_footer_gravity_forms_pdf_extended — Optional. (string) => 'name' => esc_html__( 'First Page Footer', 'gravity-forms-pdf-extended' )
The name esc html first page footer gravity forms pdf extended.
2. $type_rich_editor — Optional. (string) => 'type' => 'rich_editor'
The type rich editor.
3. $size_8 — Optional. (string) => 'size' => 8
The size 8.
4. $desc_esc_html_override_the_footer_on_the_first_page_of_the_pdf_gravity_forms_pdf_extended — Optional. (string) => 'desc' => esc_html__( 'Override the footer on the first page of the PDF.', 'gravity-forms-pdf-extended' )
The desc esc html override the footer on the first page of the pdf gravity forms pdf extended.
5. $inputclass_merge_tag_support_mt_wp_editor_mt_manual_position_mt_position_right_mt_hide_all_fields — Optional. (string) => 'inputClass' => 'merge-tag-support mt-wp_editor mt-manual_position mt-position-right mt-hide_all_fields'
The inputclass merge tag support mt wp editor mt manual position mt position right mt hide all fields.
6. $var — Optional. (string) => 'toggle' => esc_html__( 'Use different footer on first page of PDF?', 'gravity-forms-pdf-extended' )
The toggle esc html use different footer on first page of pdf gravity forms pdf extended.
7. $var (unknown) => ]
The var.

Usage

To run the hook, copy the example below.
  1. $id_first_footer = apply_filters( 'gfpdf_first_page_footer_field_setting', $id_first_footer, $name_esc_html_first_page_footer_gravity_forms_pdf_extended, $type_rich_editor, $size_8, $desc_esc_html_override_the_footer_on_the_first_page_of_the_pdf_gravity_forms_pdf_extended, $inputclass_merge_tag_support_mt_wp_editor_mt_manual_position_mt_position_right_mt_hide_all_fields, $var, $var ); 
  2.  
  3. if ( !empty( $id_first_footer ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the gfpdf_first_page_footer_field_setting callback 
  2. function filter_gfpdf_first_page_footer_field_setting( $id_first_footer, $name_esc_html_first_page_footer_gravity_forms_pdf_extended, $type_rich_editor, $size_8, $desc_esc_html_override_the_footer_on_the_first_page_of_the_pdf_gravity_forms_pdf_extended, $inputclass_merge_tag_support_mt_wp_editor_mt_manual_position_mt_position_right_mt_hide_all_fields, $var, $var ) { 
  3. // make filter magic happen here... 
  4. return $id_first_footer
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'gfpdf_first_page_footer_field_setting', 'filter_gfpdf_first_page_footer_field_setting', 10, 8 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'gfpdf_first_page_footer_field_setting', 'filter_gfpdf_first_page_footer_field_setting', 10, 8 ); 

Defined (1)

The filter is defined in the following location(s).

/src/helper/Helper_Options_Fields.php  
  1. return apply_filters( 'gfpdf_first_page_footer_field_setting', [