gfpdf_background_color_field_setting

Return the optional template-specific background color field.

Description

(array) apply_filters( 'gfpdf_background_color_field_setting', (unknown) $id_background_color, (string) $name_esc_html_background_color_gravity_forms_pdf_extended, (string) $type_color, (string) $std_fff, (string) $desc_esc_html_set_the_background_color_for_all_pages_gravity_forms_pdf_extended, (unknown) $var ); 

Returns (array)

Parameters (6)

0. $id_background_color — Optional. (unknown) => [ 'id' => 'background_color'
The id background color.
1. $name_esc_html_background_color_gravity_forms_pdf_extended — Optional. (string) => 'name' => esc_html__( 'Background Color', 'gravity-forms-pdf-extended' )
The name esc html background color gravity forms pdf extended.
2. $type_color — Optional. (string) => 'type' => 'color'
The type color.
3. $std_fff — Optional. (string) => 'std' => '#FFF'
The std fff.
4. $desc_esc_html_set_the_background_color_for_all_pages_gravity_forms_pdf_extended — Optional. (string) => 'desc' => esc_html__( 'Set the background color for all pages.', 'gravity-forms-pdf-extended' )
The desc esc html set the background color for all pages gravity forms pdf extended.
5. $var (unknown) => ]
The var.

Usage

To run the hook, copy the example below.
  1. $id_background_color = apply_filters( 'gfpdf_background_color_field_setting', $id_background_color, $name_esc_html_background_color_gravity_forms_pdf_extended, $type_color, $std_fff, $desc_esc_html_set_the_background_color_for_all_pages_gravity_forms_pdf_extended, $var ); 
  2.  
  3. if ( !empty( $id_background_color ) ) { 
  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_color_field_setting callback 
  2. function filter_gfpdf_background_color_field_setting( $id_background_color, $name_esc_html_background_color_gravity_forms_pdf_extended, $type_color, $std_fff, $desc_esc_html_set_the_background_color_for_all_pages_gravity_forms_pdf_extended, $var ) { 
  3. // make filter magic happen here... 
  4. return $id_background_color
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'gfpdf_background_color_field_setting', 'filter_gfpdf_background_color_field_setting', 10, 6 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'gfpdf_background_color_field_setting', 'filter_gfpdf_background_color_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_color_field_setting', [