gfpdf_footer_field_setting

Return the optional template-specific footer field.

Description

(array) apply_filters( 'gfpdf_footer_field_setting', (unknown) $id_footer, (string) $name_esc_html_footer_gravity_forms_pdf_extended, (string) $type_rich_editor, (string) $size_8, (string) $desc_sprintf_esc_html_the_footer_is_included_at_the_bottom_of_every_page_for_simple_columns_stry_this_html_table_snippet_s_gravity_forms_pdf_extended_a_href_https_gist_github_com_jakejackson1_e6179a96cd97ef0a8457_a, (string) $inputclass_merge_tag_support_mt_wp_editor_mt_manual_position_mt_position_right_mt_hide_all_fields, (string) $tooltip_h6_esc_html_footer_gravity_forms_pdf_extended_h6_sprintf_esc_html_for_simple_text_footers_use_the_left_center_and_right_alignment_buttons_in_the_editor_you_can_also_use_the_special_s_pageno_s_and_s_nbpg_s_tags_to_display_page_numbering_gravity_forms_pdf_extended_em_em_em_em, (unknown) $var ); 

Returns (array)

Parameters (8)

0. $id_footer — Optional. (unknown) => [ 'id' => 'footer'
The id footer.
1. $name_esc_html_footer_gravity_forms_pdf_extended — Optional. (string) => 'name' => esc_html__( 'Footer', 'gravity-forms-pdf-extended' )
The name esc html 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_sprintf_esc_html_the_footer_is_included_at_the_bottom_of_every_page_for_simple_columns_stry_this_html_table_snippet_s_gravity_forms_pdf_extended_a_href_https_gist_github_com_jakejackson1_e6179a96cd97ef0a8457_a — Optional. (string) => 'desc' => sprintf( esc_html__( 'The footer is included at the bottom of every page. For simple columns %stry this HTML table snippet%s.', 'gravity-forms-pdf-extended' ), '', '' )
The desc sprintf esc html the footer is included at the bottom of every page for simple columns stry this html table snippet s gravity forms pdf extended a href https gist github com jakejackson1 e6179a96cd97ef0a8457 a.
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. $tooltip_h6_esc_html_footer_gravity_forms_pdf_extended_h6_sprintf_esc_html_for_simple_text_footers_use_the_left_center_and_right_alignment_buttons_in_the_editor_you_can_also_use_the_special_s_pageno_s_and_s_nbpg_s_tags_to_display_page_numbering_gravity_forms_pdf_extended_em_em_em_em — Optional. (string) => 'tooltip' => '
' . esc_html__( 'Footer', 'gravity-forms-pdf-extended' ) . '
' . sprintf( esc_html__( 'For simple text footers use the left, center and right alignment buttons in the editor. You can also use the special %s{PAGENO}%s and %s{nbpg}%s tags to display page numbering.', 'gravity-forms-pdf-extended' ), '', '', '', '' )
The tooltip h6 esc html footer gravity forms pdf extended h6 sprintf esc html for simple text footers use the left center and right alignment buttons in the editor you can also use the special s pageno s and s nbpg s tags to display page numbering gravity forms pdf extended em em em em.
7. $var (unknown) => ]
The var.

Usage

To run the hook, copy the example below.
  1. $id_footer = apply_filters( 'gfpdf_footer_field_setting', $id_footer, $name_esc_html_footer_gravity_forms_pdf_extended, $type_rich_editor, $size_8, $desc_sprintf_esc_html_the_footer_is_included_at_the_bottom_of_every_page_for_simple_columns_stry_this_html_table_snippet_s_gravity_forms_pdf_extended_a_href_https_gist_github_com_jakejackson1_e6179a96cd97ef0a8457_a, $inputclass_merge_tag_support_mt_wp_editor_mt_manual_position_mt_position_right_mt_hide_all_fields, $tooltip_h6_esc_html_footer_gravity_forms_pdf_extended_h6_sprintf_esc_html_for_simple_text_footers_use_the_left_center_and_right_alignment_buttons_in_the_editor_you_can_also_use_the_special_s_pageno_s_and_s_nbpg_s_tags_to_display_page_numbering_gravity_forms_pdf_extended_em_em_em_em, $var ); 
  2.  
  3. if ( !empty( $id_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_footer_field_setting callback 
  2. function filter_gfpdf_footer_field_setting( $id_footer, $name_esc_html_footer_gravity_forms_pdf_extended, $type_rich_editor, $size_8, $desc_sprintf_esc_html_the_footer_is_included_at_the_bottom_of_every_page_for_simple_columns_stry_this_html_table_snippet_s_gravity_forms_pdf_extended_a_href_https_gist_github_com_jakejackson1_e6179a96cd97ef0a8457_a, $inputclass_merge_tag_support_mt_wp_editor_mt_manual_position_mt_position_right_mt_hide_all_fields, $tooltip_h6_esc_html_footer_gravity_forms_pdf_extended_h6_sprintf_esc_html_for_simple_text_footers_use_the_left_center_and_right_alignment_buttons_in_the_editor_you_can_also_use_the_special_s_pageno_s_and_s_nbpg_s_tags_to_display_page_numbering_gravity_forms_pdf_extended_em_em_em_em, $var ) { 
  3. // make filter magic happen here... 
  4. return $id_footer
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'gfpdf_footer_field_setting', 'filter_gfpdf_footer_field_setting', 10, 8 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'gfpdf_footer_field_setting', 'filter_gfpdf_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_footer_field_setting', [