[e2pdf-save]
Shortcode is applied to save PDF file on the server.
To avoid PDF overwriting, it's recommended to set a unique dynamic name under PDF Local Name inside E2Pdf Template.
- Default PDF save path:
- /wp-content/uploads/e2pdf/tpl/{Template ID}/save/
- See how to use with different extensions: Caldera Forms, Contact Form 7, Divi Contact Forms, Elementor Forms, Fluent Forms, Formidable Forms, Forminator Forms, Gravity Forms, Ninja Forms, WooCommerce, WPForms.
Basic Attributes#
- Default shortcode can be used inside elements that support the "auto" dataset.
- id - The ID of the E2pdf Template to use.
-
- dataset - The ID of the "dataset" to use for which it must be generated PDF. A dynamic dataset will be used if not set, depending on where the shortcode is placed.
It's required to be set if shortcode placed at:- PHP functions
- Elements that do not support "auto" dataset
- dataset - The ID of the "dataset" to use for which it must be generated PDF. A dynamic dataset will be used if not set, depending on where the shortcode is placed.
-
- dataset2 - The ID of the 2nd "dataset" to use for which it must be generated PDF.
Can be used with:- Extension: Formidable Forms, Item: Merged Items
- dataset2 - The ID of the 2nd "dataset" to use for which it must be generated PDF.
-
- user_id - Overwrite defined User ID for [e2pdf-user] shortcode.
-
-
arg1, arg2, arg3, ... - Add custom values to be accessible inside PDF.
- Usage inside E2Pdf Template:
-
arg1, arg2, arg3, ... - Add custom values to be accessible inside PDF.
-
- output - Output of the shortcode.
- url - Output PDF download link for the saved PDF.
- path - Output path of the saved PDF.
- esc_url_raw - Output PDF Encoded / Non encoded PDF download link.
- output - Output of the shortcode.
-
- apply - Required if called via custom call or via do_shortcode function.
Save and Output Attributes #
-
- download - Shortcode is applied to generate PDF download link from the saved PDF. Attributes from [e2pdf-download] shortcode can be applied.
-
- view - Shortcode is applied to insert saved PDF to the Page via pdf.js viewer. Attributes from [e2pdf-view] shortcode can be applied.
-
- attachment - Shortcode is applied to generate PDF attachment from the saved PDF. Attributes from [e2pdf-attachment] shortcode can be applied.
-
- zapier - Shortcode is applied to generate and send Zapier request for the saved PDF. Attributes from [e2pdf-zapier] shortcode can be applied.
- webhook - Zapier Webhook URL is required on any [e2pdf-zapier] shortcode usage
PDF Settings Attributes #
-
- name - Overwrite the "PDF Name" option setting inside E2Pdf Template. If "savename" attribute or "PDF Local Name" is empty - it will be used as "Save PDF Name"
-
- savename - Overwrite the "PDF Local Name" option setting inside E2Pdf Template.
-
- password - Overwrite the "PDF Password" option setting inside E2Pdf Template.
-
- format - Overwrite the "Format" option setting inside E2Pdf Template.
- jpg
- format - Overwrite the "Format" option setting inside E2Pdf Template.
-
- flatten - Overwrite the "Flatten" (read-only) option setting inside E2Pdf Template.
- 0 - No flatten (editable fields)
- 1 - Flatten (readonly fields)
- 2 - Full flatten (PDF pages as images)
- flatten - Overwrite the "Flatten" (read-only) option setting inside E2Pdf Template.
-
- inline - Overwrite the "Inline" option setting inside E2Pdf Template.
-
- overwrite - Overwrite the file if it exists.
-
-
dir - Overwrite PDF file save path. Directory must exists, be accessable and be writable.
- Absolut Path:
- Relative Path:
-
dir - Overwrite PDF file save path. Directory must exists, be accessable and be writable.
-
- create_dir - Create the directory if it does not exist.
-
- create_index - Create an index.php file if it does not exist, to prevent listing PDFs.
-
- create_htaccess - Create a .htaccess file if it does not exist, to prevent access.