gfpdf_background_image_field_setting

Return the optional template-specific background image field.

Description

Returns (array)

Parameters (6)

0. $id_background_image — Optional. (unknown) => [ 'id' => 'background_image'
The id background image.
1. $name_esc_html_background_image_gravity_forms_pdf_extended — Optional. (string) => 'name' => esc_html__( 'Background Image', 'gravity-forms-pdf-extended' )
The name esc html background image gravity forms pdf extended.
2. $type_upload — Optional. (string) => 'type' => 'upload'
The type upload.
3. $desc_esc_html_the_background_image_is_included_on_all_pages_for_optimal_results_use_an_image_the_same_dimensions_as_the_paper_size_gravity_forms_pdf_extended — Optional. (string) => 'desc' => esc_html__( 'The background image is included on all pages. For optimal results, use an image the same dimensions as the paper size.', 'gravity-forms-pdf-extended' )
The desc esc html the background image is included on all pages for optimal results use an image the same dimensions as the paper size gravity forms pdf extended.
4. $tooltip_h6_esc_html_background_image_gravity_forms_pdf_extended_h6_esc_html_for_the_best_results_use_a_jpg_or_non_interlaced_8_bit_png_that_has_the_same_dimensions_as_the_paper_size_gravity_forms_pdf_extended — Optional. (string) => 'tooltip' => '
' . esc_html__( 'Background Image', 'gravity-forms-pdf-extended' ) . '
' . esc_html__( 'For the best results, use a JPG or non-interlaced 8-Bit PNG that has the same dimensions as the paper size.', 'gravity-forms-pdf-extended' )
The tooltip h6 esc html background image gravity forms pdf extended h6 esc html for the best results use a jpg or non interlaced 8 bit png that has the same dimensions as the paper size gravity forms pdf extended.
5. $var (unknown) => ]
The var.

Usage

To run the hook, copy the example below.
  1. $id_background_image = apply_filters( 'gfpdf_background_image_field_setting', $id_background_image, $name_esc_html_background_image_gravity_forms_pdf_extended, $type_upload, $desc_esc_html_the_background_image_is_included_on_all_pages_for_optimal_results_use_an_image_the_same_dimensions_as_the_paper_size_gravity_forms_pdf_extended, $tooltip_h6_esc_html_background_image_gravity_forms_pdf_extended_h6_esc_html_for_the_best_results_use_a_jpg_or_non_interlaced_8_bit_png_that_has_the_same_dimensions_as_the_paper_size_gravity_forms_pdf_extended, $var ); 
  2.  
  3. if ( !empty( $id_background_image ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the gfpdf_background_image_field_setting callback 
  2. function filter_gfpdf_background_image_field_setting( $id_background_image, $name_esc_html_background_image_gravity_forms_pdf_extended, $type_upload, $desc_esc_html_the_background_image_is_included_on_all_pages_for_optimal_results_use_an_image_the_same_dimensions_as_the_paper_size_gravity_forms_pdf_extended, $tooltip_h6_esc_html_background_image_gravity_forms_pdf_extended_h6_esc_html_for_the_best_results_use_a_jpg_or_non_interlaced_8_bit_png_that_has_the_same_dimensions_as_the_paper_size_gravity_forms_pdf_extended, $var ) { 
  3. // make filter magic happen here... 
  4. return $id_background_image
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'gfpdf_background_image_field_setting', 'filter_gfpdf_background_image_field_setting', 10, 6 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'gfpdf_background_image_field_setting', 'filter_gfpdf_background_image_field_setting', 10, 6 ); 

Defined (1)

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

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