gfpdf_page_names_display_setting

Return the optional template-specific page names field.

Description

Returns (array)

Parameters (9)

0. $id_show_page_names — Optional. (string) => [ 'id' => 'show_page_names'
The id show page names.
1. $name_esc_html_show_page_names_gravity_forms_pdf_extended — Optional. (string) => 'name' => esc_html__( 'Show Page Names', 'gravity-forms-pdf-extended' )
The name esc html show page names gravity forms pdf extended.
2. $desc_sprintf_esc_html_display_form_page_names_on_the_pdf_requires_the_use_of_the_spage_break_field_s_gravity_forms_pdf_extended_a_href_https_www_gravityhelp_com_documentation_article_page_break_a — Optional. (string) => 'desc' => sprintf( esc_html__( 'Display form page names on the PDF. Requires the use of the %sPage Break field%s.', 'gravity-forms-pdf-extended' ), '', '' )
The desc sprintf esc html display form page names on the pdf requires the use of the spage break field s gravity forms pdf extended a href https www gravityhelp com documentation article page break a.
3. $type_radio — Optional. (string) => 'type' => 'radio'
The type radio.
4. $options_yes_esc_html_yes_gravity_forms_pdf_extended — Optional. (string) => 'options' => [ 'Yes' => esc_html__( 'Yes', 'gravity-forms-pdf-extended' )
The options yes esc html yes gravity forms pdf extended.
5. $no_esc_html_no_gravity_forms_pdf_extended — Optional. (string) => 'No' => esc_html__( 'No', 'gravity-forms-pdf-extended' )
The no esc html no gravity forms pdf extended.
6. $var (unknown) => ]
The var.
7. $std_esc_html_no_gravity_forms_pdf_extended — Optional. (string) => 'std' => esc_html__( 'No', 'gravity-forms-pdf-extended' )
The std esc html no gravity forms pdf extended.
8. $var (unknown) => ]
The var.

Usage

To run the hook, copy the example below.
  1. $id_show_page_names = apply_filters( 'gfpdf_page_names_display_setting', $id_show_page_names, $name_esc_html_show_page_names_gravity_forms_pdf_extended, $desc_sprintf_esc_html_display_form_page_names_on_the_pdf_requires_the_use_of_the_spage_break_field_s_gravity_forms_pdf_extended_a_href_https_www_gravityhelp_com_documentation_article_page_break_a, $type_radio, $options_yes_esc_html_yes_gravity_forms_pdf_extended, $no_esc_html_no_gravity_forms_pdf_extended, $var, $std_esc_html_no_gravity_forms_pdf_extended, $var ); 
  2.  
  3. if ( !empty( $id_show_page_names ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the gfpdf_page_names_display_setting callback 
  2. function filter_gfpdf_page_names_display_setting( $id_show_page_names, $name_esc_html_show_page_names_gravity_forms_pdf_extended, $desc_sprintf_esc_html_display_form_page_names_on_the_pdf_requires_the_use_of_the_spage_break_field_s_gravity_forms_pdf_extended_a_href_https_www_gravityhelp_com_documentation_article_page_break_a, $type_radio, $options_yes_esc_html_yes_gravity_forms_pdf_extended, $no_esc_html_no_gravity_forms_pdf_extended, $var, $std_esc_html_no_gravity_forms_pdf_extended, $var ) { 
  3. // make filter magic happen here... 
  4. return $id_show_page_names
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'gfpdf_page_names_display_setting', 'filter_gfpdf_page_names_display_setting', 10, 9 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'gfpdf_page_names_display_setting', 'filter_gfpdf_page_names_display_setting', 10, 9 ); 

Defined (1)

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

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