Skip to main content

PDF for GravityView API – get_single_entry_pdf_settings()

Description​

Returns a View's Single Entry PDF settings.

note

There's no Multiple Entries version of this method. Read a Multiple Entries PDF setting from the View directly, such as gravityview()->views->get( $view_id )->settings->get( 'gpdf_multiple_size' ). Each Single Entry key gpdf_x has a matching Multiple Entries key gpdf_multiple_x.

Version​

This method was introduced in PDF for GravityView 0.8.

Parameters​

$view_id | integer​

  • The GravityView ID (the View's Post ID).

Return​

array | WP_Error​

  • An array of the View's Single Entry PDF settings, or a WP_Error (invalid_view_id) if the View doesn't exist.

Usage​

Get the Single Entry PDF settings for View 50:

add_action( 'init', function () {
	$settings = \PDFGV_API::get_single_entry_pdf_settings( 50 );

	if ( is_wp_error( $settings ) ) {
		return;
	}

	// do something with $settings
} );

Source Code​

This method is located in api.php of the PDF for GravityView extension.

Last updated on