[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, Everest Forms, Fluent Forms, Formidable Forms, Forminator Forms, Gravity Forms, JetFormBuilder, MetForm, Ninja Forms, WooCommerce, WPForms.

Basic Attributes#

Default shortcode can be used inside elements that support the "auto" dataset. [e2pdf-save id="1"]
- id - The ID of the E2pdf Template to use.
[e2pdf-save id="1" dataset="1"]
- 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
[e2pdf-save id="1" dataset="1" dataset2="2"]
- 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
[e2pdf-save id="1" user_id="1"]
- user_id - Overwrite defined User ID for [e2pdf-user] shortcode.
[e2pdf-save id="1" arg1="Custom Value 1" arg2="Custom Value 2"]
- arg1, arg2, arg3, ... - Add custom values to be accessible inside PDF.
  - Usage inside E2Pdf Template: [e2pdf-arg1], [e2pdf-arg2]
[e2pdf-save id="1" output="url"]
- output - Output of the shortcode.
  - url - Outputs the PDF download link for the PDF.
  - url_raw - Outputs the raw PDF download link for the PDF.
  - url_encode - Outputs the encoded PDF download link for the PDF.
  - path - Outputs the path of the PDF.
[e2pdf-save id="1" dataset="1" apply="true"]
- apply - Required if called via custom call or via do_shortcode function.

Save and Output Attributes #

[e2pdf-save id="1" download="true"]
- download - Shortcode is applied to generate PDF download link from the saved PDF. Attributes from [e2pdf-download] shortcode can be applied.
[e2pdf-save id="1" view="true"]
- view - Shortcode is applied to insert saved PDF to the Page via pdf.js viewer. Attributes from [e2pdf-view] shortcode can be applied.
[e2pdf-save id="1" attachment="true"]
- attachment - Shortcode is applied to generate PDF attachment from the saved PDF. Attributes from [e2pdf-attachment] shortcode can be applied.
[e2pdf-save id="1" zapier="true" webhook="https://hooks.zapier.com/hooks/catch/1234567/ocfuhfo/"]
- 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
[e2pdf-save id="1" dir="/home/pdfs/"]
- dir - Overwrite PDF file save path. Directory must exists, be accessable and be writable.
  - Absolut Path: [e2pdf-save id="1" dir="/home/pdfs/"]
  - Relative Path: [e2pdf-save id="1" dir="wp-content/uploads/dir/"]
[e2pdf-save id="1" media="true"]
- media - Defines saving the PDF to the WordPress media library.
[e2pdf-save id="1" dir="/home/pdfs/" create_dir="true"]
- create_dir - Create the directory if it does not exist.
[e2pdf-save id="1" dir="/home/pdfs/" create_dir="true" create_index="true"]
- create_index - Create an index.php file if it does not exist, to prevent listing PDFs.
[e2pdf-save id="1" dir="/home/pdfs/" create_dir="true" create_htaccess="true"]
- create_htaccess - Create a .htaccess file if it does not exist, to prevent access.
[e2pdf-save id="1" overwrite="true"]
- overwrite - Overwrite the file if it exists.

PDF Settings Attributes #

[e2pdf-save id="1" name="name"]
- 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"
[e2pdf-save id="1" savename="savename"]
- savename - Overwrite the "PDF Local Name" option setting inside E2Pdf Template.
[e2pdf-save id="1" password="password"]
- password - Overwrite the "PDF Password" option setting inside E2Pdf Template.
[e2pdf-save id="1" format="jpg"]
- format - Overwrite the "Format" option setting inside E2Pdf Template.
  - pdf
  - jpg
[e2pdf-save id="1" flatten="1"]
- 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)
[e2pdf-save id="1" inline="true"]
- inline - Overwrite the "Inline" option setting inside E2Pdf Template.