gfpdf_header_field_setting

Return the optional template-specific header field.

Description

Returns (array)

Parameters (8)

0. $id_header — Optional. (unknown) => [ 'id' => 'header'
The id header.
1. $name_esc_html_header_gravity_forms_pdf_extended — Optional. (string) => 'name' => esc_html__( 'Header', 'gravity-forms-pdf-extended' )
The name esc html header 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_header_is_included_at_the_top_of_each_page_for_simple_columns_stry_this_html_table_snippet_s_gravity_forms_pdf_extended_a_href_https_gist_github_com_jakejackson1_997b5dedf0a5e665e8ef_a — Optional. (string) => 'desc' => sprintf( esc_html__( 'The header is included at the top of each page. For simple columns %stry this HTML table snippet%s.', 'gravity-forms-pdf-extended' ), '', '' )
The desc sprintf esc html the header is included at the top of each page for simple columns stry this html table snippet s gravity forms pdf extended a href https gist github com jakejackson1 997b5dedf0a5e665e8ef 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_header_gravity_forms_pdf_extended_h6_sprintf_esc_html_when_inserting_images_in_the_header_set_the_size_to_slarge_s_or_sfull_size_s_gravity_forms_pdf_extended_em_em_em_em — Optional. (string) => 'tooltip' => '
' . esc_html__( 'Header', 'gravity-forms-pdf-extended' ) . '
' . sprintf( esc_html__( 'When inserting images in the header set the size to %sLarge%s or %sFull Size%s.', 'gravity-forms-pdf-extended' ), '', '', '', '' )
The tooltip h6 esc html header gravity forms pdf extended h6 sprintf esc html when inserting images in the header set the size to slarge s or sfull size s gravity forms pdf extended em em em em.
7. $var (unknown) => ]
The var.

Usage

To run the hook, copy the example below.
  1. $id_header = apply_filters( 'gfpdf_header_field_setting', $id_header, $name_esc_html_header_gravity_forms_pdf_extended, $type_rich_editor, $size_8, $desc_sprintf_esc_html_the_header_is_included_at_the_top_of_each_page_for_simple_columns_stry_this_html_table_snippet_s_gravity_forms_pdf_extended_a_href_https_gist_github_com_jakejackson1_997b5dedf0a5e665e8ef_a, $inputclass_merge_tag_support_mt_wp_editor_mt_manual_position_mt_position_right_mt_hide_all_fields, $tooltip_h6_esc_html_header_gravity_forms_pdf_extended_h6_sprintf_esc_html_when_inserting_images_in_the_header_set_the_size_to_slarge_s_or_sfull_size_s_gravity_forms_pdf_extended_em_em_em_em, $var ); 
  2.  
  3. if ( !empty( $id_header ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the gfpdf_header_field_setting callback 
  2. function filter_gfpdf_header_field_setting( $id_header, $name_esc_html_header_gravity_forms_pdf_extended, $type_rich_editor, $size_8, $desc_sprintf_esc_html_the_header_is_included_at_the_top_of_each_page_for_simple_columns_stry_this_html_table_snippet_s_gravity_forms_pdf_extended_a_href_https_gist_github_com_jakejackson1_997b5dedf0a5e665e8ef_a, $inputclass_merge_tag_support_mt_wp_editor_mt_manual_position_mt_position_right_mt_hide_all_fields, $tooltip_h6_esc_html_header_gravity_forms_pdf_extended_h6_sprintf_esc_html_when_inserting_images_in_the_header_set_the_size_to_slarge_s_or_sfull_size_s_gravity_forms_pdf_extended_em_em_em_em, $var ) { 
  3. // make filter magic happen here... 
  4. return $id_header
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'gfpdf_header_field_setting', 'filter_gfpdf_header_field_setting', 10, 8 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'gfpdf_header_field_setting', 'filter_gfpdf_header_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_header_field_setting', [