Behavior
Email From
The sender email. It can be empty if specified in your mailer plugin.
- Location:
- Expert Settings → Behavior → Email From
- Examples:
-
-
Plugin setting:
info@example.com -
Shortcode:
email_from
[save_as_pdf_pdfcrowd email_from="info@example.com"] -
PHP function:
email_from
echo create_save_as_pdf_pdfcrowd_button(array('email_from' => 'info@example.com'));
-
Plugin setting:
Email Recipient
Choose how to get the recipient's email. It can be dynamic or fixed. The fixed value may contain either a single email address or a comma-separated list of email addresses.
- Location:
- Expert Settings → Behavior → Email Recipient
- Default:
user- Allowed Values:
-
-
The address of the logged in user, otherwise prompt for an email address— Value for shortcode and PHP function: "user" -
Prompt for an email address— Value for shortcode and PHP function: "prompt" -
Email address— Value for shortcode and PHP function: "address"
-
- Examples:
-
-
Plugin setting:
Prompt for an email address -
Shortcode:
email_recipient
[save_as_pdf_pdfcrowd email_recipient="prompt"] -
PHP function:
email_recipient
echo create_save_as_pdf_pdfcrowd_button(array('email_recipient' => 'prompt'));
-
Plugin setting:
Email Cc
Additional recipients who will receive a copy of the email. It can be either a single email address or a comma-separated list of email addresses.
- Location:
- Expert Settings → Behavior → Email Cc
- Examples:
-
-
Plugin setting:
john@example.com -
Shortcode:
email_cc
[save_as_pdf_pdfcrowd email_cc="john@example.com"] -
PHP function:
email_cc
echo create_save_as_pdf_pdfcrowd_button(array('email_cc' => 'john@example.com'));
-
Plugin setting:
Email Bcc
Additional recipients who will receive a copy of the email without revealing their email addresses to the other recipients. It can be either a single email address or a comma-separated list of email addresses.
- Location:
- Expert Settings → Behavior → Email Bcc
- Examples:
-
-
Plugin setting:
mary@example.com -
Shortcode:
email_bcc
[save_as_pdf_pdfcrowd email_bcc="mary@example.com"] -
PHP function:
email_bcc
echo create_save_as_pdf_pdfcrowd_button(array('email_bcc' => 'mary@example.com'));
-
Plugin setting:
Email Subject
{{ }} that are dynamically expanded. Available variables are: - site - site name
- site_url - site url
- title - current page title
- user_name - user's login name
- user_first_name - user's first name
- user_last_name - user's last name
- user_display_name - user's display name
- Location:
- Expert Settings → Behavior → Email Subject
- Default:
{{site}} - {{title}} PDF- Examples:
-
-
Plugin setting:
{{user_name}} - Report -
Shortcode:
email_subject
[save_as_pdf_pdfcrowd email_subject="{{user_name}} - Report"] -
PHP function:
email_subject
echo create_save_as_pdf_pdfcrowd_button(array('email_subject' => '{{user_name}} - Report'));
-
Plugin setting:
Email Message
{{ }} that are dynamically expanded. Available variables are: - site - site name
- site_url - site url
- title - current page title
- user_name - user's login name
- user_first_name - user's first name
- user_last_name - user's last name
- user_display_name - user's display name
- Location:
- Expert Settings → Behavior → Email Message
- Default:
<p>Dear {{user_first_name}} {{user_last_name}},</p> <p>Please, find {{title}} attached.</p> <p>Best Regards,<br> <a href="{{site_url}}">{{site}}</a></p>- Examples:
-
-
Plugin setting:
<p>Dear {{user_first_name}} {{user_last_name}}, ...</p> -
Shortcode:
email_message
[save_as_pdf_pdfcrowd email_message="<p>Dear {{user_first_name}} {{user_last_name}}, ...</p>"] -
PHP function:
email_message
echo create_save_as_pdf_pdfcrowd_button(array('email_message' => '<p>Dear {{user_first_name}} {{user_last_name}}, ...</p>'));
-
Plugin setting:
Email Dialogs
Specify how to display a dialog when the mail configuration requires it. Such cases are Success dialog, Error dialog and Prompt dialog for recipient email.
- Location:
- Expert Settings → Behavior → Email Dialogs
- Default:
modal- Allowed Values:
-
-
System dialogs— Value for shortcode and PHP function: "system" -
Predefined modal dialogs— Value for shortcode and PHP function: "modal" -
No dialogs— Value for shortcode and PHP function: "none" -
Custom dialogs— Value for shortcode and PHP function: "custom"
-
- Examples:
-
-
Plugin setting:
Predefined modal dialogs -
Shortcode:
email_dialogs
[save_as_pdf_pdfcrowd email_dialogs="modal"] -
PHP function:
email_dialogs
echo create_save_as_pdf_pdfcrowd_button(array('email_dialogs' => 'modal'));
-
Plugin setting:
Output Name
The name of the output file. The name may not be specified and will be automatically created according to the page URL.
- Location:
- Expert Settings → Behavior → Output Name
- Default:
the name is generated automatically- Examples:
-
-
Plugin setting:
report.pdf -
Shortcode:
output_name
[save_as_pdf_pdfcrowd output_name="report.pdf"] -
PHP function:
output_name
echo create_save_as_pdf_pdfcrowd_button(array('output_name' => 'report.pdf'));
-
Plugin setting:
PDF Created Callback
The callback function is useful for custom actions, e.g. saving the pdf to a local folder, setting a custom HTTP response header, collecting email entered by user.
The callback function must be accessible to the plugin, with the recommended location being either the functions.php file or within the page contents.
Return true from your custom callback if you wish to skip the default functionality. The default functionality depends on the Button Click Action option and is either an HTTP response or email with the created pdf.
- output - the generated pdf data
- options - options used for the conversion
- file_name - the pdf filename
- error - null for a successful conversion otherwise WP_Error
- Location:
- Expert Settings → Behavior → PDF Created Callback
- Examples:
-
-
Plugin setting:
save_to_local -
Shortcode:
pdf_created_callback
[save_as_pdf_pdfcrowd pdf_created_callback="save_to_local"] -
PHP function:
pdf_created_callback
echo create_save_as_pdf_pdfcrowd_button(array('pdf_created_callback' => 'save_to_local'));
-
Plugin setting:
Custom Data
- Location:
- Expert Settings → Behavior → Custom Data
- Examples:
-
-
Plugin setting:
{'post_id': 123} -
Shortcode:
custom_data
[save_as_pdf_pdfcrowd custom_data="{'post_id': 123}"] -
PHP function:
custom_data
echo create_save_as_pdf_pdfcrowd_button(array('custom_data' => '{"post_id": 123}'));
-
Plugin setting:
Error Page
$_GET['error-code'],
$_GET['error-message'] and
$_GET['error-details'].
- Location:
- Expert Settings → Behavior → Error Page
- Default:
the plugin's default error page- Examples:
-
-
Plugin setting:
https://mysite.com/pdfcrowd-error/ -
Shortcode:
error_page
[save_as_pdf_pdfcrowd error_page="https://mysite.com/pdfcrowd-error/"] -
PHP function:
error_page
echo create_save_as_pdf_pdfcrowd_button(array('error_page' => 'https://mysite.com/pdfcrowd-error/'));
-
Plugin setting:
Mode
Conversion Mode
Specify the source for the conversion to PDF.
- Location:
- Basic Settings → Mode → Conversion Mode
- Default:
url- Allowed Values:
-
-
URL—The web page URL is uploaded for the conversion.
This mode is suitable for a public website.Value for shortcode and PHP function: "url" -
Upload—The contents of the web page is uploaded for the conversion.
This mode is suitable for any website, password-protected or not publicly accessible website.Value for shortcode and PHP function: "upload" -
Content—The current HTML contents shown in the browser is sent for conversion.
This mode is suitable for web forms and dynamic HTML contents.
It is recommended to check Disable JavaScript option too or disable WordPress caching.Value for shortcode and PHP function: "content" -
Development—The contents of the web page and some local assets are uploaded for the conversion.
This mode is suitable for a website which is not accessible from the Internet (e.g. localhost).
Local images and some CSS may not appear in the converted document.Value for shortcode and PHP function: "development" -
Auto—If web page URL is specified explicitly, the "url" mode is used otherwise "upload" mode is used.Value for shortcode and PHP function: "auto"
-
- Examples:
-
-
Plugin setting:
Content -
Shortcode:
conversion_mode
[save_as_pdf_pdfcrowd conversion_mode="content"] -
PHP function:
conversion_mode
echo create_save_as_pdf_pdfcrowd_button(array('conversion_mode' => 'content'));
-
Plugin setting:
URL Lookup
It allows to choose how to retrieve URLs for the Conversion Mode-URL. It is suitable for a website using different location than permalink.
- Location:
- Expert Settings → Mode → URL Lookup
- Default:
auto- Allowed Values:
-
-
Auto— Value for shortcode and PHP function: "auto" -
Location— Value for shortcode and PHP function: "location" -
Permalink— Value for shortcode and PHP function: "permalink"
-
- Examples:
-
-
Plugin setting:
Location -
Shortcode:
url_lookup
[save_as_pdf_pdfcrowd url_lookup="location"] -
PHP function:
url_lookup
echo create_save_as_pdf_pdfcrowd_button(array('url_lookup' => 'location'));
-
Plugin setting:
Diagnostics
- Location:
- Expert Settings → Mode → Diagnostics
- Default:
0- Allowed Values:
-
-
0 -
1
-
- Examples:
-
-
Shortcode:
diagnostics
[save_as_pdf_pdfcrowd diagnostics=1] -
PHP function:
diagnostics
echo create_save_as_pdf_pdfcrowd_button(array('diagnostics' => 1));
-
Shortcode:
Page Setup
Page Size
Set the output page size using standard formats (A4, Letter, A3, etc.). Use A4 for international documents, Letter for US-based content, or larger sizes like A3 for posters and presentations.
- Location:
- Basic Settings → Page Setup → Page Size
- Default:
A4- Allowed Values:
-
-
A0 -
A1 -
A2 -
A3 -
A4 -
A5 -
A6 -
Letter
-
- Examples:
-
-
Plugin setting:
Letter -
Shortcode:
page_size
[save_as_pdf_pdfcrowd page_size="Letter"] -
PHP function:
page_size
echo create_save_as_pdf_pdfcrowd_button(array('page_size' => 'Letter'));
-
Plugin setting:
Page Width
Set custom page dimensions when standard sizes don't fit your needs. Useful for banners, receipts, custom forms, or when matching specific printing equipment.
The safe maximum is 200in - larger sizes may fail to open in some PDF viewers. For standard sizes like A4 or Letter, use the predefined page size option instead.
- Location:
- Basic Settings → Page Setup → Page Width
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
8.27in- Examples:
-
-
Plugin setting:
8.5in -
Shortcode:
page_width
[save_as_pdf_pdfcrowd page_width="8.5in"] -
PHP function:
page_width
echo create_save_as_pdf_pdfcrowd_button(array('page_width' => '8.5in'));
-
Plugin setting:
Page Height
Set custom page height for specific formats like receipts, banners, or legal documents. Set to "-1" for a single-page PDF that expands to fit all content vertically. Use this for web pages, infographics, or documents where page breaks are undesirable.
The safe maximum is 200in otherwise some viewers cannot open the PDF. For standard sizes, use the predefined page size option instead.
- Location:
- Basic Settings → Page Setup → Page Height
- Constraint:
-
- The value must be -1 or specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
11.7in- Examples:
-
-
Plugin setting:
14in -
Shortcode:
page_height
[save_as_pdf_pdfcrowd page_height="14in"] -
PHP function:
page_height
echo create_save_as_pdf_pdfcrowd_button(array('page_height' => '14in'));
-
Plugin setting:
Orientation
Set the output page orientation to portrait or landscape. Use landscape for wide content like spreadsheets, charts, or dashboards. Use portrait for standard documents and text-heavy content.
- Location:
- Basic Settings → Page Setup → Orientation
- Default:
portrait- Allowed Values:
-
-
landscape -
portrait
-
- Examples:
-
-
Plugin setting:
landscape -
Shortcode:
orientation
[save_as_pdf_pdfcrowd orientation="landscape"] -
PHP function:
orientation
echo create_save_as_pdf_pdfcrowd_button(array('orientation' => 'landscape'));
-
Plugin setting:
Margin Top
Control white space at the top of the page. Increase for header space, formal documents, or annotation room (e.g., 1in or more). Decrease to maximize content area or fit more content (e.g., 5mm to 10mm).
Default 0.4in balances readability with space efficiency. Set to 0 for full-bleed designs. Affects where content starts and where headers appear.
- Location:
- Basic Settings → Page Setup → Margin Top
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
0.4in- Examples:
-
-
Plugin setting:
10mm -
Shortcode:
margin_top
[save_as_pdf_pdfcrowd margin_top="10mm"] -
PHP function:
margin_top
echo create_save_as_pdf_pdfcrowd_button(array('margin_top' => '10mm'));
-
Plugin setting:
Margin Right
Control white space on the right edge of the page. Increase for binding/hole-punch clearance or note-taking space (e.g., 1in or more). Decrease to fit wider content (e.g., 5mm to 10mm).
Default 0.4in balances readability with space efficiency. Set to 0 for full-bleed designs. Affects where content wraps and text line length.
- Location:
- Basic Settings → Page Setup → Margin Right
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
0.4in- Examples:
-
-
Plugin setting:
10mm -
Shortcode:
margin_right
[save_as_pdf_pdfcrowd margin_right="10mm"] -
PHP function:
margin_right
echo create_save_as_pdf_pdfcrowd_button(array('margin_right' => '10mm'));
-
Plugin setting:
Margin Bottom
Control white space at the bottom of the page. Increase for footer space, page numbers, or formal documents (e.g., 1in or more). Decrease to fit more content per page (e.g., 5mm to 10mm).
Default 0.4in balances readability with space efficiency. Set to 0 for full-bleed designs. Affects where content ends and where footers appear.
- Location:
- Basic Settings → Page Setup → Margin Bottom
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
0.4in- Examples:
-
-
Plugin setting:
10mm -
Shortcode:
margin_bottom
[save_as_pdf_pdfcrowd margin_bottom="10mm"] -
PHP function:
margin_bottom
echo create_save_as_pdf_pdfcrowd_button(array('margin_bottom' => '10mm'));
-
Plugin setting:
Margin Left
Control white space on the left edge of the page. Increase for binding/hole-punch clearance or note-taking space (e.g., 1in or more). Decrease to fit wider content (e.g., 5mm to 10mm).
Default 0.4in balances readability with space efficiency. Set to 0 for full-bleed designs. Affects where content starts horizontally and text line length.
- Location:
- Basic Settings → Page Setup → Margin Left
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
0.4in- Examples:
-
-
Plugin setting:
10mm -
Shortcode:
margin_left
[save_as_pdf_pdfcrowd margin_left="10mm"] -
PHP function:
margin_left
echo create_save_as_pdf_pdfcrowd_button(array('margin_left' => '10mm'));
-
Plugin setting:
No Margins
Disable all page margins to use the entire page area. Use this for full-bleed designs where content should extend to the page edges, such as posters, certificates, or branded materials.
Combine with custom CSS to ensure your content fills the page properly.
- Location:
- Expert Settings → Page Setup → No Margins
- Default:
false- Examples:
-
-
Shortcode:
no_margins
[save_as_pdf_pdfcrowd no_margins=true] -
PHP function:
no_margins
echo create_save_as_pdf_pdfcrowd_button(array('no_margins' => true));
-
Shortcode:
Print Page Range
Set the page range to print when you only need specific pages from the conversion. Use this to extract individual pages (e.g., "2"), specific ranges (e.g., "3-7"), or combinations (e.g., "1,4-6,last"). Use this for creating excerpts from long documents or excluding cover pages from batch processing.
- Location:
- Expert Settings → Page Setup → Print Page Range
- Constraint:
-
- A comma separated list of page numbers or ranges. Special strings may be used, such as 'odd', 'even' and 'last'.
- Examples:
-
-
Plugin setting:
3,6-9 -
Shortcode:
print_page_range
[save_as_pdf_pdfcrowd print_page_range="3,6-9"] -
PHP function:
print_page_range
echo create_save_as_pdf_pdfcrowd_button(array('print_page_range' => '3,6-9'));
-
Plugin setting:
Content Viewport Width
Set the viewport width for formatting the HTML content when generating a PDF. Use this to control how responsive designs render - prevent mobile styles from applying when you want desktop layout, or ensure content appears at the right width.
Specify a viewport width to control content rendering, ensuring it mimics the appearance on various devices or matches specific design requirements.
- Location:
- Basic Settings → Page Setup → Content Viewport Width
- Constraint:
-
- The value must be 'balanced', 'small', 'medium', 'large', 'extra-large', or a number in the range 96-65000px.
- Default:
medium- Allowed Values:
-
-
balanced— Adjusts the viewport width to fit the print area. -
small— Selects a narrower viewport. -
medium— Selects the default viewport width. -
large— Selects a wider viewport. -
extra-large— Selects an extra-wide viewport. -
A precise viewport width in pixels, such as
1024px, to tailor the PDF's text density to your specific requirements. The value must be in the range 96-65000px.
-
- Examples:
-
-
Plugin setting:
800px -
Shortcode:
content_viewport_width
[save_as_pdf_pdfcrowd content_viewport_width="800px"] -
PHP function:
content_viewport_width
echo create_save_as_pdf_pdfcrowd_button(array('content_viewport_width' => '800px'));
-
Plugin setting:
Content Viewport Height
Set the viewport height for formatting the HTML content when generating a PDF. Specify a viewport height to enforce loading of lazy-loaded images and affect vertical positioning of absolutely positioned elements within the content.
- Location:
- Expert Settings → Page Setup → Content Viewport Height
- Constraint:
-
- The value must be 'auto', 'large', or a number.
- Default:
auto- Allowed Values:
-
-
auto— The height of the print area is used. For most pages, this is sufficient. Use "large" or custom values for pages with extensive lazy-loaded content. -
large— Value suitable for documents with extensive lazy-loaded content. -
A specific numerical value, such as
10000px, to set as the window height, allowing precise control based on the document's requirements.
-
- Examples:
-
-
Plugin setting:
5000px -
Shortcode:
content_viewport_height
[save_as_pdf_pdfcrowd content_viewport_height="5000px"] -
PHP function:
content_viewport_height
echo create_save_as_pdf_pdfcrowd_button(array('content_viewport_height' => '5000px'));
-
Plugin setting:
Content Fit Mode
Specify the mode for fitting the HTML content to the print area by upscaling or downscaling it. Use this to prevent content from being cut off at page edges or to enable smart scaling of oversized content.
- Location:
- Expert Settings → Page Setup → Content Fit Mode
- Default:
auto- Allowed Values:
-
-
auto— Automatic mode -
smart-scaling— Smartscaling to fit more content into the print area. -
no-scaling— No scaling is performed. Content may be cut off if it exceeds page boundaries. -
viewport-width— The viewport width fits the print area width. -
content-width— The HTML content width fits the print area width. -
single-page— The entire HTML content fits the print area of a single page. -
single-page-ratio— The entire HTML content fits the print area of a single page, maintaining the aspect ratio of the page height and width.
-
- Examples:
-
-
Plugin setting:
The entire HTML content fits the print area of a single page, maintaining the aspect ratio of the page height and width. -
Shortcode:
content_fit_mode
[save_as_pdf_pdfcrowd content_fit_mode="single-page-ratio"] -
PHP function:
content_fit_mode
echo create_save_as_pdf_pdfcrowd_button(array('content_fit_mode' => 'single-page-ratio'));
-
Plugin setting:
Remove Blank Pages
Specify which blank pages to exclude from the output document to create cleaner PDFs. Use "trailing" to remove empty pages at the end caused by page break issues. Use "all" to remove blank pages throughout the document when converting content with formatting quirks. Helps eliminate unwanted white pages from the final output.
- Location:
- Expert Settings → Page Setup → Remove Blank Pages
- Default:
trailing- Allowed Values:
-
-
trailing— Trailing blank pages are removed from the document. -
all— All empty pages are removed from the document. -
none— No blank page is removed from the document.
-
- Examples:
-
-
Plugin setting:
No blank page is removed from the document. -
Shortcode:
remove_blank_pages
[save_as_pdf_pdfcrowd remove_blank_pages="none"] -
PHP function:
remove_blank_pages
echo create_save_as_pdf_pdfcrowd_button(array('remove_blank_pages' => 'none'));
-
Plugin setting:
Watermark & Background
Page Watermark
Apply the first page of a watermark PDF to every page of the output PDF. Use this to add transparent overlays like "DRAFT" stamps, security markings, or branding elements that appear on top of content. Use this to mark confidential documents.
- Location:
- Expert Settings → Watermark & Background → Page Watermark
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
Plugin setting:
/home/user/john/watermark.png -
Shortcode:
page_watermark
[save_as_pdf_pdfcrowd page_watermark="/home/user/john/watermark.png"] -
PHP function:
page_watermark
echo create_save_as_pdf_pdfcrowd_button(array('page_watermark' => '/home/user/john/watermark.png'));
-
Plugin setting:
Page Watermark URL
Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
- Location:
- Expert Settings → Watermark & Background → Page Watermark URL
- Constraint:
-
- Supported protocols are http:// and https://.
- Examples:
-
-
Plugin setting:
http://myserver.com/watermark.png -
Shortcode:
page_watermark_url
[save_as_pdf_pdfcrowd page_watermark_url="http://myserver.com/watermark.png"] -
PHP function:
page_watermark_url
echo create_save_as_pdf_pdfcrowd_button(array('page_watermark_url' => 'http://myserver.com/watermark.png'));
-
Plugin setting:
Multipage Watermark
Apply each page of a watermark PDF to the corresponding page of the output PDF. Use this for page-specific watermarks where different pages need different overlays - for example, different approval stamps per department.
If the watermark has fewer pages than the output, the last watermark page is repeated for remaining pages.
- Location:
- Expert Settings → Watermark & Background → Multipage Watermark
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
Plugin setting:
/home/user/john/watermark.png -
Shortcode:
multipage_watermark
[save_as_pdf_pdfcrowd multipage_watermark="/home/user/john/watermark.png"] -
PHP function:
multipage_watermark
echo create_save_as_pdf_pdfcrowd_button(array('multipage_watermark' => '/home/user/john/watermark.png'));
-
Plugin setting:
Multipage Watermark URL
Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
- Location:
- Expert Settings → Watermark & Background → Multipage Watermark URL
- Constraint:
-
- Supported protocols are http:// and https://.
- Examples:
-
-
Plugin setting:
http://myserver.com/watermark.png -
Shortcode:
multipage_watermark_url
[save_as_pdf_pdfcrowd multipage_watermark_url="http://myserver.com/watermark.png"] -
PHP function:
multipage_watermark_url
echo create_save_as_pdf_pdfcrowd_button(array('multipage_watermark_url' => 'http://myserver.com/watermark.png'));
-
Plugin setting:
Page Background
Apply the first page of a background PDF to every page of the output PDF. Use this to add letterheads, branded templates, or decorative backgrounds that appear behind your content. Backgrounds appear beneath content, while watermarks layer on top.
- Location:
- Expert Settings → Watermark & Background → Page Background
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
Plugin setting:
/home/user/john/background.png -
Shortcode:
page_background
[save_as_pdf_pdfcrowd page_background="/home/user/john/background.png"] -
PHP function:
page_background
echo create_save_as_pdf_pdfcrowd_button(array('page_background' => '/home/user/john/background.png'));
-
Plugin setting:
Page Background URL
Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
- Location:
- Expert Settings → Watermark & Background → Page Background URL
- Constraint:
-
- Supported protocols are http:// and https://.
- Examples:
-
-
Plugin setting:
http://myserver.com/background.png -
Shortcode:
page_background_url
[save_as_pdf_pdfcrowd page_background_url="http://myserver.com/background.png"] -
PHP function:
page_background_url
echo create_save_as_pdf_pdfcrowd_button(array('page_background_url' => 'http://myserver.com/background.png'));
-
Plugin setting:
Multipage Background
Apply each page of a background PDF to the corresponding page of the output PDF. Use this for page-specific backgrounds where each page needs a different template - for example, different letterheads for front and back pages.
If the background has fewer pages than the output, the last background page is repeated for remaining pages.
- Location:
- Expert Settings → Watermark & Background → Multipage Background
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
Plugin setting:
/home/user/john/background.png -
Shortcode:
multipage_background
[save_as_pdf_pdfcrowd multipage_background="/home/user/john/background.png"] -
PHP function:
multipage_background
echo create_save_as_pdf_pdfcrowd_button(array('multipage_background' => '/home/user/john/background.png'));
-
Plugin setting:
Multipage Background URL
Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
- Location:
- Expert Settings → Watermark & Background → Multipage Background URL
- Constraint:
-
- Supported protocols are http:// and https://.
- Examples:
-
-
Plugin setting:
http://myserver.com/background.png -
Shortcode:
multipage_background_url
[save_as_pdf_pdfcrowd multipage_background_url="http://myserver.com/background.png"] -
PHP function:
multipage_background_url
echo create_save_as_pdf_pdfcrowd_button(array('multipage_background_url' => 'http://myserver.com/background.png'));
-
Plugin setting:
Page Background Color
Set a solid background color for all pages, filling the entire page area including margins. Useful for creating branded PDFs with corporate colors, highlighting draft documents, or improving readability with off-white backgrounds.
Supports transparency with RGBA format - use semi-transparent colors for subtle effects without obscuring content. Format as RGB (FF0000) or RGBA (FF000080) hexadecimal.
- Location:
- Expert Settings → Watermark & Background → Page Background Color
- Constraint:
-
- The value must be in RRGGBB or RRGGBBAA hexadecimal format.
- Examples:
-
-
Plugin setting:
00ff0080 -
Shortcode:
page_background_color
[save_as_pdf_pdfcrowd page_background_color="00ff0080"] -
PHP function:
page_background_color
echo create_save_as_pdf_pdfcrowd_button(array('page_background_color' => '00ff0080'));
-
Plugin setting:
General Options
Use Print Media
Use the print version of the page if available via @media print CSS rules. Enable this when converting websites that have print-optimized styles. Many sites hide navigation, ads, and sidebars in print mode.
Produces cleaner PDFs by using the design the website creator intended for printing.
- Location:
- Expert Settings → General Options → Use Print Media
- Default:
false- Examples:
-
-
Shortcode:
use_print_media
[save_as_pdf_pdfcrowd use_print_media=true] -
PHP function:
use_print_media
echo create_save_as_pdf_pdfcrowd_button(array('use_print_media' => true));
-
Shortcode:
No Background
Do not print the background graphics to create printer-friendly PDFs. Use this when documents will be physically printed to save ink costs and improve readability.
Removes background colors, images, and patterns while preserving text and foreground content. Particularly useful for documents with dark backgrounds or decorative elements.
- Location:
- Expert Settings → General Options → No Background
- Default:
false- Examples:
-
-
Shortcode:
no_background
[save_as_pdf_pdfcrowd no_background=true] -
PHP function:
no_background
echo create_save_as_pdf_pdfcrowd_button(array('no_background' => true));
-
Shortcode:
Disable JavaScript
Do not execute JavaScript during conversion. Use this to improve conversion speed when JavaScript is not needed, prevent dynamic content changes, or avoid security risks from untrusted scripts.
Note that disabling JavaScript means lazy-loaded images and AJAX content will not load.
- Location:
- Expert Settings → General Options → Disable JavaScript
- Default:
false- Examples:
-
-
Shortcode:
disable_javascript
[save_as_pdf_pdfcrowd disable_javascript=true] -
PHP function:
disable_javascript
echo create_save_as_pdf_pdfcrowd_button(array('disable_javascript' => true));
-
Shortcode:
Disable Image Loading
Do not load images during conversion to create text-only PDFs. Use this to significantly speed up conversion, reduce file size, or create accessible text-focused documents.
Use this for converting documentation where images are not needed, reducing bandwidth usage, or creating lightweight PDFs for email distribution.
- Location:
- Expert Settings → General Options → Disable Image Loading
- Default:
false- Examples:
-
-
Shortcode:
disable_image_loading
[save_as_pdf_pdfcrowd disable_image_loading=true] -
PHP function:
disable_image_loading
echo create_save_as_pdf_pdfcrowd_button(array('disable_image_loading' => true));
-
Shortcode:
Disable Remote Fonts
Disable loading fonts from remote sources. Use this to speed up conversion by avoiding font download delays, ensure consistent rendering with system fonts, or work around font loading failures.
Note that text will fall back to system fonts, which may change the document's appearance.
- Location:
- Expert Settings → General Options → Disable Remote Fonts
- Default:
false- Examples:
-
-
Shortcode:
disable_remote_fonts
[save_as_pdf_pdfcrowd disable_remote_fonts=true] -
PHP function:
disable_remote_fonts
echo create_save_as_pdf_pdfcrowd_button(array('disable_remote_fonts' => true));
-
Shortcode:
Use Mobile User Agent
Use a mobile user agent when making requests to the source URL.
- Location:
- Expert Settings → General Options → Use Mobile User Agent
- Default:
false- Examples:
-
-
Shortcode:
use_mobile_user_agent
[save_as_pdf_pdfcrowd use_mobile_user_agent=true] -
PHP function:
use_mobile_user_agent
echo create_save_as_pdf_pdfcrowd_button(array('use_mobile_user_agent' => true));
-
Shortcode:
Load Iframes
Specifies how iframes are handled during conversion. Use "all" to include all embedded content (videos, maps, widgets). Use "same-origin" to include only content from the same domain for security purposes. Use "none" to exclude all iframes for faster conversion and to avoid third-party content issues.
Disabling iframes can significantly improve performance and reliability.
- Location:
- Expert Settings → General Options → Load Iframes
- Default:
all- Allowed Values:
-
-
all— All iframes are loaded. -
same-origin— Only iframes with the same origin as the main page are loaded. -
none— Iframe loading is disabled.
-
- Examples:
-
-
Plugin setting:
Iframe loading is disabled. -
Shortcode:
load_iframes
[save_as_pdf_pdfcrowd load_iframes="none"] -
PHP function:
load_iframes
echo create_save_as_pdf_pdfcrowd_button(array('load_iframes' => 'none'));
-
Plugin setting:
Block Ads
Automatically block common advertising networks and tracking scripts during conversion, producing cleaner PDFs with faster conversion times. Filters out third-party ad content, analytics beacons, and ad network resources.
Use this for converting news sites, blogs, or any ad-heavy content where ads distract from the main message. May occasionally block legitimate third-party content - disable if critical third-party resources are missing.
- Location:
- Expert Settings → General Options → Block Ads
- Default:
false- Examples:
-
-
Shortcode:
block_ads
[save_as_pdf_pdfcrowd block_ads=true] -
PHP function:
block_ads
echo create_save_as_pdf_pdfcrowd_button(array('block_ads' => true));
-
Shortcode:
Default Encoding
Specify the character encoding when the HTML lacks proper charset declaration or has incorrect encoding. Prevents garbled text for non-English content, especially legacy pages without UTF-8 encoding.
Set to "utf-8" for modern content, "iso-8859-1" for Western European legacy pages, or other encodings for specific regional content. Only needed when auto-detection fails and you see corrupted characters in the output.
- Location:
- Expert Settings → General Options → Default Encoding
- Default:
auto detect- Examples:
-
-
Plugin setting:
utf-8 -
Shortcode:
default_encoding
[save_as_pdf_pdfcrowd default_encoding="utf-8"] -
PHP function:
default_encoding
echo create_save_as_pdf_pdfcrowd_button(array('default_encoding' => 'utf-8'));
-
Plugin setting:
Locale
Set the locale for the conversion to control regional formatting of dates, times, and numbers. Use this when converting content for specific regions - for example, set to "en-US" for MM/DD/YYYY dates and comma thousand separators, or "de-DE" for DD.MM.YYYY dates and period thousand separators.
Essential for financial reports, invoices, or localized content.
- Location:
- Expert Settings → General Options → Locale
- Default:
en-US- Examples:
-
-
Plugin setting:
ja-JP -
Shortcode:
locale
[save_as_pdf_pdfcrowd locale="ja-JP"] -
PHP function:
locale
echo create_save_as_pdf_pdfcrowd_button(array('locale' => 'ja-JP'));
-
Plugin setting:
HTTP Auth User Name
Set the HTTP authentication user name. Required to access protected web pages or staging environments.
- Location:
- Expert Settings → General Options → HTTP Auth User Name
- Examples:
-
-
Plugin setting:
John -
Shortcode:
http_auth_user_name
[save_as_pdf_pdfcrowd http_auth_user_name="John"] -
PHP function:
http_auth_user_name
echo create_save_as_pdf_pdfcrowd_button(array('http_auth_user_name' => 'John'));
-
Plugin setting:
HTTP Auth Password
Set the HTTP authentication password. Required to access protected web pages or staging environments.
- Location:
- Expert Settings → General Options → HTTP Auth Password
- Examples:
-
-
Plugin setting:
123456 -
Shortcode:
http_auth_password
[save_as_pdf_pdfcrowd http_auth_password="123456"] -
PHP function:
http_auth_password
echo create_save_as_pdf_pdfcrowd_button(array('http_auth_password' => '123456'));
-
Plugin setting:
Verify SSL Certificates
Enforce SSL certificate validation for secure connections, preventing conversions from sites with invalid certificates. Enable when converting from production sites with valid certificates to ensure security.
When disabled, allows conversion from any HTTPS site regardless of certificate validity - including development servers with self-signed certificates, internal corporate sites with expired certificates, or local testing environments.
- Location:
- Expert Settings → General Options → Verify SSL Certificates
- Default:
false- Examples:
-
-
Shortcode:
verify_ssl_certificates
[save_as_pdf_pdfcrowd verify_ssl_certificates=true] -
PHP function:
verify_ssl_certificates
echo create_save_as_pdf_pdfcrowd_button(array('verify_ssl_certificates' => true));
-
Shortcode:
Fail On Main URL Error
Abort the conversion if the HTTP status code of the main URL is greater than or equal to 400 (client/server errors). Use this in automated workflows to catch broken URLs or authentication failures early rather than producing invalid PDFs. Ensures your system does not silently generate error page PDFs when source content is unavailable.
- Location:
- Expert Settings → General Options → Fail On Main URL Error
- Default:
false- Examples:
-
-
Shortcode:
fail_on_main_url_error
[save_as_pdf_pdfcrowd fail_on_main_url_error=true] -
PHP function:
fail_on_main_url_error
echo create_save_as_pdf_pdfcrowd_button(array('fail_on_main_url_error' => true));
-
Shortcode:
Fail On Any URL Error
Abort the conversion if any sub-request (images, stylesheets, scripts) fails with HTTP 400+ errors. Use this for strict quality control when all assets must load successfully.
- Location:
- Expert Settings → General Options → Fail On Any URL Error
- Default:
false- Examples:
-
-
Shortcode:
fail_on_any_url_error
[save_as_pdf_pdfcrowd fail_on_any_url_error=true] -
PHP function:
fail_on_any_url_error
echo create_save_as_pdf_pdfcrowd_button(array('fail_on_any_url_error' => true));
-
Shortcode:
No X-Pdfcrowd Header
Do not send the X-Pdfcrowd HTTP header in HTTP requests made by the converter. Use this if your target server blocks or logs requests with this header, or for privacy when you do not want sites to know you are using PDFCrowd. Some security systems may block requests with non-standard headers.
- Location:
- Expert Settings → General Options → No X-Pdfcrowd Header
- Default:
false- Examples:
-
-
Shortcode:
no_xpdfcrowd_header
[save_as_pdf_pdfcrowd no_xpdfcrowd_header=true] -
PHP function:
no_xpdfcrowd_header
echo create_save_as_pdf_pdfcrowd_button(array('no_xpdfcrowd_header' => true));
-
Shortcode:
CSS Page Rule Mode
Specifies behavior in the presence of CSS @page rules to control which settings take precedence. Use "default" to prioritize API settings over CSS rules, ensuring consistent output regardless of input HTML. Use "mode2" to respect CSS @page rules for print-optimized HTML.
This solves conflicts when CSS tries to override your API page setup.
- Location:
- Expert Settings → General Options → CSS Page Rule Mode
- Default:
default- Allowed Values:
-
-
default— The PDFCrowd API page settings are preferred. -
mode1— The converter version 18.10 mode. Use for backward compatibility with legacy conversion behavior. -
mode2— CSS @page rule is preferred. Use when your HTML has print-optimized @page rules that should override API settings.
-
- Examples:
-
-
Plugin setting:
CSS @page rule is preferred. Use when your HTML has print-optimized @page rules that should override API settings. -
Shortcode:
css_page_rule_mode
[save_as_pdf_pdfcrowd css_page_rule_mode="mode2"] -
PHP function:
css_page_rule_mode
echo create_save_as_pdf_pdfcrowd_button(array('css_page_rule_mode' => 'mode2'));
-
Plugin setting:
Custom CSS
Apply custom CSS to the input HTML document to modify the visual appearance and layout of your content dynamically. Use this to override default styles, adjust spacing, change fonts, or fix layout issues without modifying the source HTML.
Use !important in your CSS rules to prioritize and override conflicting styles.
- Location:
- Basic Settings → General Options → Custom CSS
- Examples:
-
-
Plugin setting:
nav, #ad-block { display: none !important; } -
Shortcode:
custom_css
[save_as_pdf_pdfcrowd custom_css="nav, #ad-block { display: none !important; }"] -
PHP function:
custom_css
echo create_save_as_pdf_pdfcrowd_button(array('custom_css' => 'nav, #ad-block { display: none !important; }'));
-
Plugin setting:
Custom JavaScript
Run a custom JavaScript after the document is loaded and ready to print. Use this to modify page content before conversion, remove unwanted elements, or trigger specific page states. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...).
In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
- Location:
- Basic Settings → General Options → Custom JavaScript
- Examples:
-
-
Plugin setting:
document.body.style.setProperty('background-color', 'gray', 'important') -
Shortcode:
custom_javascript
[save_as_pdf_pdfcrowd custom_javascript="document.body.style.setProperty('background-color', 'gray', 'important')"] -
PHP function:
custom_javascript
echo create_save_as_pdf_pdfcrowd_button(array('custom_javascript' => 'document.body.style.setProperty("background-color", "gray", "important")'));
-
Plugin setting:
On Load JavaScript
Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
- Location:
- Expert Settings → General Options → On Load JavaScript
- Examples:
-
-
Plugin setting:
document.body.style.setProperty('background-color', 'gray', 'important') -
Shortcode:
on_load_javascript
[save_as_pdf_pdfcrowd on_load_javascript="document.body.style.setProperty('background-color', 'gray', 'important')"] -
PHP function:
on_load_javascript
echo create_save_as_pdf_pdfcrowd_button(array('on_load_javascript' => 'document.body.style.setProperty("background-color", "gray", "important")'));
-
Plugin setting:
Custom HTTP Header
Set a custom HTTP header to be included in all requests made by the converter. Use this to pass authentication tokens to protected sites, add tracking headers for analytics, or provide API keys for accessing private content.
Essential when converting content from APIs or internal systems that require special headers for access control.
- Location:
- Expert Settings → General Options → Custom HTTP Header
- Constraint:
-
- A string containing the header name and value separated by a colon.
- Examples:
-
-
Plugin setting:
X-My-Client-ID:k2017-12345 -
Shortcode:
custom_http_header
[save_as_pdf_pdfcrowd custom_http_header="X-My-Client-ID:k2017-12345"] -
PHP function:
custom_http_header
echo create_save_as_pdf_pdfcrowd_button(array('custom_http_header' => 'X-My-Client-ID:k2017-12345'));
-
Plugin setting:
JavaScript Delay
Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Use this to ensure lazy-loaded images, AJAX content, or animations complete before conversion. Your license defines the maximum wait time by "Max Delay" parameter.
- Location:
- Expert Settings → General Options → JavaScript Delay
- Constraint:
-
- Must be a positive integer or 0.
- Default:
200- Examples:
-
-
Plugin setting:
2000 -
Shortcode:
javascript_delay
[save_as_pdf_pdfcrowd javascript_delay=2000] -
PHP function:
javascript_delay
echo create_save_as_pdf_pdfcrowd_button(array('javascript_delay' => 2000));
-
Plugin setting:
Element To Convert
Convert only the specified element from the main document and its children. Use this to extract specific portions of a page (like article content) while excluding navigation, headers, footers, or sidebars. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used.
- Location:
- Basic Settings → General Options → Element To Convert
- Examples:
-
-
Plugin setting:
div.user-panel.main p.article -
Shortcode:
element_to_convert
[save_as_pdf_pdfcrowd element_to_convert="div.user-panel.main p.article"] -
PHP function:
element_to_convert
echo create_save_as_pdf_pdfcrowd_button(array('element_to_convert' => 'div.user-panel.main p.article'));
-
Plugin setting:
Element To Convert Mode
Control how CSS styles are applied when converting only part of a page. The "cut-out" option extracts the element into a new document root, which may break CSS selectors like "body > div". The "remove-siblings" option keeps the element in its original DOM position but deletes other elements, preserving descendant selectors. The "hide-siblings" option keeps all elements but hides non-selected ones with display:none, preserving all CSS context.
- Location:
- Expert Settings → General Options → Element To Convert Mode
- Default:
cut-out- Allowed Values:
-
-
cut-out— The element and its children are cut out of the document. -
remove-siblings— All element's siblings are removed from the DOM. Keeps target element in position but may break descendant CSS selectors. -
hide-siblings— All element's siblings are hidden using display:none. Preserves CSS context while hiding non-target content.
-
- Examples:
-
-
Plugin setting:
All element's siblings are hidden using display:none. Preserves CSS context while hiding non-target content. -
Shortcode:
element_to_convert_mode
[save_as_pdf_pdfcrowd element_to_convert_mode="hide-siblings"] -
PHP function:
element_to_convert_mode
echo create_save_as_pdf_pdfcrowd_button(array('element_to_convert_mode' => 'hide-siblings'));
-
Plugin setting:
Wait For Element
Wait for the specified element in a source document. Use this when specific dynamic content must be ready before conversion, avoiding unnecessary delays from a fixed JavaScript delay. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes.
If the element is not found, the conversion fails. Your license defines the maximum wait time by the "Max Delay" parameter.
- Location:
- Expert Settings → General Options → Wait For Element
- Examples:
-
-
Plugin setting:
div.user-panel.main p.article -
Shortcode:
wait_for_element
[save_as_pdf_pdfcrowd wait_for_element="div.user-panel.main p.article"] -
PHP function:
wait_for_element
echo create_save_as_pdf_pdfcrowd_button(array('wait_for_element' => 'div.user-panel.main p.article'));
-
Plugin setting:
Auto Detect Element To Convert
The main HTML element for conversion is detected automatically. Use this when you want to extract article or main content without knowing the exact CSS selector, automatically excluding navigation and sidebars.
- Location:
- Expert Settings → General Options → Auto Detect Element To Convert
- Default:
false- Examples:
-
-
Shortcode:
auto_detect_element_to_convert
[save_as_pdf_pdfcrowd auto_detect_element_to_convert=true] -
PHP function:
auto_detect_element_to_convert
echo create_save_as_pdf_pdfcrowd_button(array('auto_detect_element_to_convert' => true));
-
Shortcode:
Readability Enhancements
Automatically enhance the input HTML to improve readability by removing clutter and reformatting content. Use this when converting web pages with excessive navigation, ads, or sidebars that distract from the main content.
Different versions (v1-v4) use progressively aggressive algorithms - start with "v1" and increase if more cleanup is needed. Use this for converting blog posts, articles, or documentation into clean PDFs.
- Location:
- Expert Settings → General Options → Readability Enhancements
- Default:
none- Allowed Values:
-
-
none— No enhancements are used. -
readability-v1— Version 1 of the enhancements is used. Basic cleanup for simple pages with moderate clutter. -
readability-v2— Version 2 of the enhancements is used. More aggressive cleanup for pages with more ads and navigation. -
readability-v3— Version 3 of the enhancements is used. Strong cleanup for heavily cluttered pages with multiple sidebars. -
readability-v4— Version 4 of the enhancements is used. Maximum cleanup for extremely cluttered pages. May remove some content.
-
- Examples:
-
-
Plugin setting:
Version 4 of the enhancements is used. Maximum cleanup for extremely cluttered pages. May remove some content. -
Shortcode:
readability_enhancements
[save_as_pdf_pdfcrowd readability_enhancements="readability-v4"] -
PHP function:
readability_enhancements
echo create_save_as_pdf_pdfcrowd_button(array('readability_enhancements' => 'readability-v4'));
-
Plugin setting:
Print Resolution
Viewport Width
Set the viewport width in pixels.
- Location:
- Expert Settings → Print Resolution → Viewport Width
- Constraint:
-
- The accepted range is 96-65000.
- Examples:
-
-
Plugin setting:
1920 -
Shortcode:
viewport_width
[save_as_pdf_pdfcrowd viewport_width=1920] -
PHP function:
viewport_width
echo create_save_as_pdf_pdfcrowd_button(array('viewport_width' => 1920));
-
Plugin setting:
Viewport Height
Set the viewport height in pixels.
- Location:
- Expert Settings → Print Resolution → Viewport Height
- Constraint:
-
- Must be a positive integer.
- Examples:
-
-
Plugin setting:
15000 -
Shortcode:
viewport_height
[save_as_pdf_pdfcrowd viewport_height=15000] -
PHP function:
viewport_height
echo create_save_as_pdf_pdfcrowd_button(array('viewport_height' => 15000));
-
Plugin setting:
Rendering Mode
Set the rendering mode of the page, allowing control over how content is displayed.
- Location:
- Expert Settings → Print Resolution → Rendering Mode
- Allowed Values:
-
-
default— The mode based on the standard browser print functionality. -
viewport— Adapts the rendering according to the specified viewport width, influencing the@media (min-width)and@media (max-width)CSS properties. Use this mode to preview different responsive designs of a web page, such as mobile or desktop views, by choosing the viewport size.
-
- Examples:
-
-
Plugin setting:
Adapts the rendering according to the specified viewport width, influencing the@media (min-width)and@media (max-width)CSS properties. Use this mode to preview different responsive designs of a web page, such as mobile or desktop views, by choosing the viewport size. -
Shortcode:
rendering_mode
[save_as_pdf_pdfcrowd rendering_mode="viewport"] -
PHP function:
rendering_mode
echo create_save_as_pdf_pdfcrowd_button(array('rendering_mode' => 'viewport'));
-
Plugin setting:
Smart Scaling Mode
Specify the scaling mode used for fitting the HTML contents to the print area.
- Location:
- Expert Settings → Print Resolution → Smart Scaling Mode
- Allowed Values:
-
-
default— The mode based on the standard browser print functionality. -
disabled— No smart scaling is performed. -
viewport-fit— The viewport width fits the print area width. -
content-fit— The HTML contents width fits the print area width. -
single-page-fit— The whole HTML contents fits the print area of a single page. -
single-page-fit-ex— The whole HTML contents fits the print area of a single page with respect to the page height/width ratio. -
mode1— Scaling mode 1 is applied. Legacy scaling behavior for backward compatibility.
-
- Examples:
-
-
Plugin setting:
Scaling mode 1 is applied. Legacy scaling behavior for backward compatibility. -
Shortcode:
smart_scaling_mode
[save_as_pdf_pdfcrowd smart_scaling_mode="mode1"] -
PHP function:
smart_scaling_mode
echo create_save_as_pdf_pdfcrowd_button(array('smart_scaling_mode' => 'mode1'));
-
Plugin setting:
Scale Factor
Set the scaling factor (zoom) for the main page area to fit content better. Use values below 100% to shrink oversized content that is getting cut off at page edges. Use values above 100% to enlarge small content for better readability.
Common use cases include shrinking wide tables to fit (70-80%), or enlarging mobile-optimized layouts for desktop PDFs (120-150%).
- Location:
- Expert Settings → Print Resolution → Scale Factor
- Constraint:
-
- The accepted range is 10-500.
- Default:
100- Examples:
-
-
Plugin setting:
50 -
Shortcode:
scale_factor
[save_as_pdf_pdfcrowd scale_factor=50] -
PHP function:
scale_factor
echo create_save_as_pdf_pdfcrowd_button(array('scale_factor' => 50));
-
Plugin setting:
JPEG Quality
Set the quality of embedded JPEG images to balance file size and visual quality. Use 100% for archival documents or when image quality is critical. Use 70-85% for web distribution to significantly reduce file size with minimal visible quality loss.
Use lower values (50-60%) only when file size is more important than image clarity.
Common artifacts below 60% include blockiness and color banding.
- Location:
- Expert Settings → Print Resolution → JPEG Quality
- Constraint:
-
- The accepted range is 1-100.
- Default:
100- Examples:
-
-
Plugin setting:
70 -
Shortcode:
jpeg_quality
[save_as_pdf_pdfcrowd jpeg_quality=70] -
PHP function:
jpeg_quality
echo create_save_as_pdf_pdfcrowd_button(array('jpeg_quality' => 70));
-
Plugin setting:
Convert Images To JPEG
Specify which image types will be converted to JPEG to reduce PDF file size. Use "opaque" to convert only non-transparent images (safe for most documents). Use "all" to convert everything including transparent images (transparent areas become white).
Use "none" to preserve original image formats.
Use this for image-heavy PDFs distributed via email or the web.
- Location:
- Expert Settings → Print Resolution → Convert Images To JPEG
- Default:
none- Allowed Values:
-
-
none— No image conversion is done. -
opaque— Only opaque images are converted to JPEG images. -
all— All images are converted to JPEG images. The JPEG format does not support transparency so the transparent color is replaced by a PDF page background color.
-
- Examples:
-
-
Plugin setting:
All images are converted to JPEG images. The JPEG format does not support transparency so the transparent color is replaced by a PDF page background color. -
Shortcode:
convert_images_to_jpeg
[save_as_pdf_pdfcrowd convert_images_to_jpeg="all"] -
PHP function:
convert_images_to_jpeg
echo create_save_as_pdf_pdfcrowd_button(array('convert_images_to_jpeg' => 'all'));
-
Plugin setting:
Image DPI
Set the DPI of images in PDF to control resolution and file size. Use 300 DPI for professional printing, 150 DPI for everyday documents, 96 DPI for screen-only viewing, or 72 DPI for web distribution.
Lower DPI creates smaller files but reduces image quality. Use 0 to preserve original image resolution.
Note that this only downscales - it will not upscale low-resolution images.
- Location:
- Expert Settings → Print Resolution → Image DPI
- Constraint:
-
- Must be a positive integer or 0.
- Examples:
-
-
Plugin setting:
300 -
Shortcode:
image_dpi
[save_as_pdf_pdfcrowd image_dpi=300] -
PHP function:
image_dpi
echo create_save_as_pdf_pdfcrowd_button(array('image_dpi' => 300));
-
Plugin setting:
PDF Format
Miscellaneous values for PDF output.
Enable PDF Forms
Convert HTML forms to fillable PDF forms that users can complete in PDF readers. Use this to create interactive PDFs from HTML forms.
Use this for fillable applications, surveys, or order forms that work offline. Details can be found in the fillable PDF forms guide.
- Location:
- Expert Settings → PDF Format → Enable PDF Forms
- Default:
false- Examples:
-
-
Shortcode:
enable_pdf_forms
[save_as_pdf_pdfcrowd enable_pdf_forms=true] -
PHP function:
enable_pdf_forms
echo create_save_as_pdf_pdfcrowd_button(array('enable_pdf_forms' => true));
-
Shortcode:
Linearize
Create linearized PDF. This is also known as Fast Web View. Use this to optimize PDFs for progressive download, allowing users to start viewing the first page while the rest downloads.
- Location:
- Expert Settings → PDF Format → Linearize
- Default:
false- Examples:
-
-
Shortcode:
linearize
[save_as_pdf_pdfcrowd linearize=true] -
PHP function:
linearize
echo create_save_as_pdf_pdfcrowd_button(array('linearize' => true));
-
Shortcode:
Encrypt
Encrypt the PDF to prevent search engines from indexing the contents and add an extra layer of security. Use this for confidential documents, internal reports, or any content you do not want appearing in search results.
Combine with a password to require authentication for viewing, or just use encryption alone to prevent indexing while keeping the PDF publicly readable.
- Location:
- Expert Settings → PDF Format → Encrypt
- Default:
false- Examples:
-
-
Shortcode:
encrypt
[save_as_pdf_pdfcrowd encrypt=true] -
PHP function:
encrypt
echo create_save_as_pdf_pdfcrowd_button(array('encrypt' => true));
-
Shortcode:
User Password
Protect the PDF with a user password to restrict who can open and view the document. Recipients must enter this password to view the PDF. Use this for confidential documents, sensitive data, or content distribution where you want to control access.
Combine with permission flags to restrict what users can do after opening.
- Location:
- Expert Settings → PDF Format → User Password
- Examples:
-
-
Plugin setting:
123456 -
Shortcode:
user_password
[save_as_pdf_pdfcrowd user_password="123456"] -
PHP function:
user_password
echo create_save_as_pdf_pdfcrowd_button(array('user_password' => '123456'));
-
Plugin setting:
Owner Password
Protect the PDF with an owner password for administrative control. This password allows changing permissions, passwords, and document restrictions - like a master key. Use different user and owner passwords to give recipients restricted access while retaining full control.
The owner password should be kept confidential and different from the user password.
- Location:
- Expert Settings → PDF Format → Owner Password
- Examples:
-
-
Plugin setting:
123456 -
Shortcode:
owner_password
[save_as_pdf_pdfcrowd owner_password="123456"] -
PHP function:
owner_password
echo create_save_as_pdf_pdfcrowd_button(array('owner_password' => '123456'));
-
Plugin setting:
No Print
Disallow printing of the output PDF to protect sensitive content. Use this for confidential documents, copyrighted materials, or preview versions you want to restrict.
- Location:
- Expert Settings → PDF Format → No Print
- Default:
false- Examples:
-
-
Shortcode:
no_print
[save_as_pdf_pdfcrowd no_print=true] -
PHP function:
no_print
echo create_save_as_pdf_pdfcrowd_button(array('no_print' => true));
-
Shortcode:
No Modify
Disallow modification of the output PDF to maintain document integrity. Use this for official documents, contracts, or records that should not be altered after creation. Prevents recipients from editing content, adding annotations, or extracting pages.
- Location:
- Expert Settings → PDF Format → No Modify
- Default:
false- Examples:
-
-
Shortcode:
no_modify
[save_as_pdf_pdfcrowd no_modify=true] -
PHP function:
no_modify
echo create_save_as_pdf_pdfcrowd_button(array('no_modify' => true));
-
Shortcode:
No Copy
Disallow text and graphics extraction from the output PDF to protect copyrighted content. Use this for ebooks, proprietary documents, or materials where you want to prevent easy copying and redistribution.
- Location:
- Expert Settings → PDF Format → No Copy
- Default:
false- Examples:
-
-
Shortcode:
no_copy
[save_as_pdf_pdfcrowd no_copy=true] -
PHP function:
no_copy
echo create_save_as_pdf_pdfcrowd_button(array('no_copy' => true));
-
Shortcode:
Title
Set the title of the PDF that appears in PDF reader title bars and document properties. Use descriptive titles for better organization and searchability in document management systems.
This metadata helps users identify documents when multiple PDFs are open and improves accessibility for screen readers.
- Location:
- Expert Settings → PDF Format → Title
- Examples:
-
-
Plugin setting:
My Resume -
Shortcode:
title
[save_as_pdf_pdfcrowd title="My Resume"] -
PHP function:
title
echo create_save_as_pdf_pdfcrowd_button(array('title' => 'My Resume'));
-
Plugin setting:
Subject
Set the subject of the PDF to categorize or summarize the document content. Use this to add searchable metadata for document management systems, improve organization in large PDF libraries, or provide context about the document's purpose.
Appears in PDF properties dialog.
- Location:
- Expert Settings → PDF Format → Subject
- Examples:
-
-
Plugin setting:
CV - Software Developer -
Shortcode:
subject
[save_as_pdf_pdfcrowd subject="CV - Software Developer"] -
PHP function:
subject
echo create_save_as_pdf_pdfcrowd_button(array('subject' => 'CV - Software Developer'));
-
Plugin setting:
Keywords
Associate keywords with the document to improve searchability in document management systems. Use relevant terms that describe the content, making it easier to find documents later.
Separate multiple keywords with commas. Particularly useful for large document repositories or DAM systems.
- Location:
- Expert Settings → PDF Format → Keywords
- Examples:
-
-
Plugin setting:
software developer, Unix, databases -
Shortcode:
keywords
[save_as_pdf_pdfcrowd keywords="software developer, Unix, databases"] -
PHP function:
keywords
echo create_save_as_pdf_pdfcrowd_button(array('keywords' => 'software developer, Unix, databases'));
-
Plugin setting:
Conformance
Produce the output PDF at the specified PDF/A conformance level. PDF/A is the ISO-standardized archival format for long-term document preservation. Can not be combined with encryption options, fillable PDF forms, or watermarks and backgrounds.
- Location:
- Expert Settings → PDF Format → Conformance
- Allowed Values:
-
-
PDF/A-2a— PDF/A-2a - accessible documents, tagged structure and Unicode text. -
PDF/A-2b— PDF/A-2b - reliable visual archiving, the most common choice. -
PDF/A-2u— PDF/A-2u - visual archiving with searchable Unicode text. -
PDF/A-3a— PDF/A-3a - PDF/A-2a plus file attachments. -
PDF/A-3b— PDF/A-3b - PDF/A-2b plus file attachments. -
PDF/A-3u— PDF/A-3u - PDF/A-2u plus file attachments. -
PDF/A-4— PDF/A-4 - the latest PDF/A, based on PDF 2.0. -
PDF/A-4e— PDF/A-4e - PDF/A-4 for engineering, allows 3D and attachments. -
PDF/A-4f— PDF/A-4f - PDF/A-4 with a mandatory file attachment.
-
- Examples:
-
-
Plugin setting:
PDF/A-4f - PDF/A-4 with a mandatory file attachment. -
Shortcode:
conformance
[save_as_pdf_pdfcrowd conformance="PDF/A-4f"] -
PHP function:
conformance
echo create_save_as_pdf_pdfcrowd_button(array('conformance' => 'PDF/A-4f'));
-
Plugin setting:
Tagged PDF
Create a tagged PDF that preserves the logical structure of the source HTML - headings, paragraphs, lists, links and reading order - as PDF structure tags. Use this to make documents accessible to screen readers and to improve text extraction and content reflow. Can not be combined with watermarks and backgrounds.
- Location:
- Expert Settings → PDF Format → Tagged PDF
- Default:
false- Examples:
-
-
Shortcode:
tagged_pdf
[save_as_pdf_pdfcrowd tagged_pdf=true] -
PHP function:
tagged_pdf
echo create_save_as_pdf_pdfcrowd_button(array('tagged_pdf' => true));
-
Shortcode:
Attachment
Embed a file as an attachment in the output PDF. Call this method repeatedly to attach several files.
- Location:
- Expert Settings → PDF Format → Attachment
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
Shortcode:
attachment -
PHP function:
attachment
-
Shortcode:
Viewer Preferences
These preferences specify how a PDF viewer should present the document. The preferences may be ignored by some PDF viewers.
Page Layout
Control how pages appear when the PDF opens in viewers that respect these preferences. "single-page" for focused reading one page at a time. "one-column" for continuous scrolling like a web page. "two-column-left" for book-like layouts with odd pages on left (international standard). "two-column-right" for magazines with odd pages on right.
- Location:
- Expert Settings → Viewer Preferences → Page Layout
- Allowed Values:
-
-
single-page— Display one page at a time. -
one-column— Display the pages in one column. -
two-column-left— Display the pages in two columns, with odd-numbered pages on the left. -
two-column-right— Display the pages in two columns, with odd-numbered pages on the right.
-
- Examples:
-
-
Plugin setting:
Display the pages in two columns, with odd-numbered pages on the right. -
Shortcode:
page_layout
[save_as_pdf_pdfcrowd page_layout="two-column-right"] -
PHP function:
page_layout
echo create_save_as_pdf_pdfcrowd_button(array('page_layout' => 'two-column-right'));
-
Plugin setting:
Page Mode
Control the initial display mode when the PDF opens. "full-screen" for presentations and kiosk displays where you want an immersive experience. "thumbnails" for long documents where visual page navigation is helpful. "outlines" for structured documents with bookmarks/table of contents.
- Location:
- Expert Settings → Viewer Preferences → Page Mode
- Allowed Values:
-
-
full-screen— Full-screen mode. -
thumbnails— Thumbnail images are visible. -
outlines— Document outline is visible.
-
- Examples:
-
-
Plugin setting:
Document outline is visible. -
Shortcode:
page_mode
[save_as_pdf_pdfcrowd page_mode="outlines"] -
PHP function:
page_mode
echo create_save_as_pdf_pdfcrowd_button(array('page_mode' => 'outlines'));
-
Plugin setting:
Initial Zoom Type
Control how the PDF is initially zoomed when opened.
- Location:
- Expert Settings → Viewer Preferences → Initial Zoom Type
- Allowed Values:
-
-
fit-width— The page content is magnified just enough to fit the entire width of the page within the window. -
fit-height— The page content is magnified just enough to fit the entire height of the page within the window. -
fit-page— The page content is magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
-
- Examples:
-
-
Plugin setting:
The page content is magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension. -
Shortcode:
initial_zoom_type
[save_as_pdf_pdfcrowd initial_zoom_type="fit-page"] -
PHP function:
initial_zoom_type
echo create_save_as_pdf_pdfcrowd_button(array('initial_zoom_type' => 'fit-page'));
-
Plugin setting:
Initial Page
Display the specified page when the document is opened.
- Location:
- Expert Settings → Viewer Preferences → Initial Page
- Constraint:
-
- Must be a positive integer.
- Examples:
-
-
Plugin setting:
2 -
Shortcode:
initial_page
[save_as_pdf_pdfcrowd initial_page=2] -
PHP function:
initial_page
echo create_save_as_pdf_pdfcrowd_button(array('initial_page' => 2));
-
Plugin setting:
Initial Zoom
Specify the initial page zoom in percents when the document is opened.
- Location:
- Expert Settings → Viewer Preferences → Initial Zoom
- Constraint:
-
- Must be a positive integer.
- Examples:
-
-
Plugin setting:
50 -
Shortcode:
initial_zoom
[save_as_pdf_pdfcrowd initial_zoom=50] -
PHP function:
initial_zoom
echo create_save_as_pdf_pdfcrowd_button(array('initial_zoom' => 50));
-
Plugin setting:
Hide Toolbar
Hide the viewer's toolbar when the PDF is opened to provide a cleaner, more focused reading experience. Use this for presentations, kiosk displays, or immersive reading where you want minimal UI distractions.
- Location:
- Expert Settings → Viewer Preferences → Hide Toolbar
- Default:
false- Examples:
-
-
Shortcode:
hide_toolbar
[save_as_pdf_pdfcrowd hide_toolbar=true] -
PHP function:
hide_toolbar
echo create_save_as_pdf_pdfcrowd_button(array('hide_toolbar' => true));
-
Shortcode:
Hide Window UI
Hide user interface elements like scroll bars and navigation controls when the PDF opens. Use this for presentation mode, digital signage, or embedded PDFs where you want the most minimal interface possible.
Combines with other UI hiding options for full-screen immersive viewing.
- Location:
- Expert Settings → Viewer Preferences → Hide Window UI
- Default:
false- Examples:
-
-
Shortcode:
hide_window_ui
[save_as_pdf_pdfcrowd hide_window_ui=true] -
PHP function:
hide_window_ui
echo create_save_as_pdf_pdfcrowd_button(array('hide_window_ui' => true));
-
Shortcode:
Fit Window
Resize the PDF viewer window to fit the size of the first displayed page when opened. Use this to ensure the PDF opens at an appropriate size rather than filling the entire screen.
Particularly useful for small documents, forms, or certificates that look better at actual size.
- Location:
- Expert Settings → Viewer Preferences → Fit Window
- Default:
false- Examples:
-
-
Shortcode:
fit_window
[save_as_pdf_pdfcrowd fit_window=true] -
PHP function:
fit_window
echo create_save_as_pdf_pdfcrowd_button(array('fit_window' => true));
-
Shortcode:
Center Window
Position the PDF viewer window in the center of the screen when opened.
- Location:
- Expert Settings → Viewer Preferences → Center Window
- Default:
false- Examples:
-
-
Shortcode:
center_window
[save_as_pdf_pdfcrowd center_window=true] -
PHP function:
center_window
echo create_save_as_pdf_pdfcrowd_button(array('center_window' => true));
-
Shortcode:
Display Title
Display the title of the HTML document in the PDF viewer's title bar instead of the filename. Use this to show more descriptive titles when PDFs are opened - particularly useful when the filename is cryptic or auto-generated.
Improves user experience by showing meaningful document names.
- Location:
- Expert Settings → Viewer Preferences → Display Title
- Default:
false- Examples:
-
-
Shortcode:
display_title
[save_as_pdf_pdfcrowd display_title=true] -
PHP function:
display_title
echo create_save_as_pdf_pdfcrowd_button(array('display_title' => true));
-
Shortcode:
Right To Left
Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up.
- Location:
- Expert Settings → Viewer Preferences → Right To Left
- Default:
false- Examples:
-
-
Shortcode:
right_to_left
[save_as_pdf_pdfcrowd right_to_left=true] -
PHP function:
right_to_left
echo create_save_as_pdf_pdfcrowd_button(array('right_to_left' => true));
-
Shortcode:
Data
Render your data into PDF or image output using Jinja2 templates. Provide your data in JSON, XML, YAML, or CSV format and create an HTML template that defines the output layout and formatting using Jinja2 syntax, e.g. .
Data String
Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
- Location:
- Expert Settings → Data → Data String
- Examples:
-
-
Plugin setting:
{"recipient": "Anna May", "sender": "John Doe"} -
Shortcode:
data_string
[save_as_pdf_pdfcrowd data_string="{'recipient': 'Anna May', 'sender': 'John Doe'}"] -
PHP function:
data_string
echo create_save_as_pdf_pdfcrowd_button(array('data_string' => '{"recipient": "Anna May", "sender": "John Doe"}'));
-
Plugin setting:
Data File
Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
- Location:
- Expert Settings → Data → Data File
- Examples:
-
-
Plugin setting:
/home/user/john/data.json -
Shortcode:
data_file
[save_as_pdf_pdfcrowd data_file="/home/user/john/data.json"] -
PHP function:
data_file
echo create_save_as_pdf_pdfcrowd_button(array('data_file' => '/home/user/john/data.json'));
-
Plugin setting:
Data Format
Specify the input data format. Use "auto" for automatic detection or explicitly set to JSON, XML, YAML, or CSV when format is known.
- Location:
- Expert Settings → Data → Data Format
- Default:
auto- Allowed Values:
-
-
auto— The data format is auto-detected. -
json -
xml -
yaml -
csv
-
- Examples:
-
-
Plugin setting:
csv -
Shortcode:
data_format
[save_as_pdf_pdfcrowd data_format="csv"] -
PHP function:
data_format
echo create_save_as_pdf_pdfcrowd_button(array('data_format' => 'csv'));
-
Plugin setting:
Data Encoding
Set the encoding of the input data file.
- Location:
- Expert Settings → Data → Data Encoding
- Default:
utf-8- Examples:
-
-
Plugin setting:
iso8859-2 -
Shortcode:
data_encoding
[save_as_pdf_pdfcrowd data_encoding="iso8859-2"] -
PHP function:
data_encoding
echo create_save_as_pdf_pdfcrowd_button(array('data_encoding' => 'iso8859-2'));
-
Plugin setting:
Data Ignore Undefined
Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
- Location:
- Expert Settings → Data → Data Ignore Undefined
- Default:
false- Examples:
-
-
Shortcode:
data_ignore_undefined
[save_as_pdf_pdfcrowd data_ignore_undefined=true] -
PHP function:
data_ignore_undefined
echo create_save_as_pdf_pdfcrowd_button(array('data_ignore_undefined' => true));
-
Shortcode:
Data Auto Escape
Auto escape HTML symbols in the input data before placing them into the output.
- Location:
- Expert Settings → Data → Data Auto Escape
- Default:
false- Examples:
-
-
Shortcode:
data_auto_escape
[save_as_pdf_pdfcrowd data_auto_escape=true] -
PHP function:
data_auto_escape
echo create_save_as_pdf_pdfcrowd_button(array('data_auto_escape' => true));
-
Shortcode:
Data Trim Blocks
Auto trim whitespace around each template command block.
- Location:
- Expert Settings → Data → Data Trim Blocks
- Default:
false- Examples:
-
-
Shortcode:
data_trim_blocks
[save_as_pdf_pdfcrowd data_trim_blocks=true] -
PHP function:
data_trim_blocks
echo create_save_as_pdf_pdfcrowd_button(array('data_trim_blocks' => true));
-
Shortcode:
Data Options
key=value pairs:csv_delimiter- The CSV data delimiter, the default is,.xml_remove_root- Remove the root XML element from the input data.data_root- The name of the root element inserted into the input data without a root node (e.g. CSV), the default isdata.
- Location:
- Expert Settings → Data → Data Options
- Examples:
-
-
Plugin setting:
xml_remove_root=1 -
Shortcode:
data_options
[save_as_pdf_pdfcrowd data_options="xml_remove_root=1"] -
PHP function:
data_options
echo create_save_as_pdf_pdfcrowd_button(array('data_options' => 'xml_remove_root=1'));
-
Plugin setting:
Miscellaneous
Debug Log
Turn on debug logging to troubleshoot conversion issues. Details about the conversion process, including resource loading, rendering steps, and error messages are stored in the debug log. Use this when conversions fail or produce unexpected results. The debug log is available in conversion statistics.
- Location:
- Expert Settings → Miscellaneous → Debug Log
- Default:
false- Examples:
-
-
Shortcode:
debug_log
[save_as_pdf_pdfcrowd debug_log=true] -
PHP function:
debug_log
echo create_save_as_pdf_pdfcrowd_button(array('debug_log' => true));
-
Shortcode:
Tag
Tag the conversion with a custom value for tracking and analytics. Use this to categorize conversions by customer ID, document type, or business unit. The tag appears in conversion statistics. A value longer than 32 characters is cut off.
- Location:
- Expert Settings → Miscellaneous → Tag
- Examples:
-
-
Plugin setting:
client-1234 -
Shortcode:
tag
[save_as_pdf_pdfcrowd tag="client-1234"] -
PHP function:
tag
echo create_save_as_pdf_pdfcrowd_button(array('tag' => 'client-1234'));
-
Plugin setting:
HTTP Proxy
A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. This can help circumvent regional restrictions or provide limited access to your intranet.
- Location:
- Expert Settings → Miscellaneous → HTTP Proxy
- Constraint:
-
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
- Examples:
-
-
Plugin setting:
113.25.84.10:33333 -
Shortcode:
http_proxy
[save_as_pdf_pdfcrowd http_proxy="113.25.84.10:33333"] -
PHP function:
http_proxy
echo create_save_as_pdf_pdfcrowd_button(array('http_proxy' => '113.25.84.10:33333'));
-
Plugin setting:
HTTPS Proxy
A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. This can help circumvent regional restrictions or provide limited access to your intranet.
- Location:
- Expert Settings → Miscellaneous → HTTPS Proxy
- Constraint:
-
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
- Examples:
-
-
Plugin setting:
113.25.84.10:44333 -
Shortcode:
https_proxy
[save_as_pdf_pdfcrowd https_proxy="113.25.84.10:44333"] -
PHP function:
https_proxy
echo create_save_as_pdf_pdfcrowd_button(array('https_proxy' => '113.25.84.10:44333'));
-
Plugin setting:
Client Certificate
A client certificate to authenticate the converter on your web server. The certificate is used for two-way SSL/TLS authentication (mutual TLS) and adds extra security. Use this when converting content from servers that require client certificate authentication for access.
- Location:
- Expert Settings → Miscellaneous → Client Certificate
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
Plugin setting:
/home/user/john/pdfcrowd.crt -
Shortcode:
client_certificate
[save_as_pdf_pdfcrowd client_certificate="/home/user/john/pdfcrowd.crt"] -
PHP function:
client_certificate
echo create_save_as_pdf_pdfcrowd_button(array('client_certificate' => '/home/user/john/pdfcrowd.crt'));
-
Plugin setting:
Client Certificate Password
A password for the PKCS12 file with a client certificate if the certificate file is password-protected.
- Location:
- Expert Settings → Miscellaneous → Client Certificate Password
- Examples:
-
-
Plugin setting:
123456 -
Shortcode:
client_certificate_password
[save_as_pdf_pdfcrowd client_certificate_password="123456"] -
PHP function:
client_certificate_password
echo create_save_as_pdf_pdfcrowd_button(array('client_certificate_password' => '123456'));
-
Plugin setting:
Tweaks
Expert options for fine-tuning output.
Layout DPI
Set the internal DPI resolution used for positioning of PDF contents. It can help in situations where there are small inaccuracies in the PDF. It is recommended to use values that are a multiple of 72, such as 288 or 360.
- Location:
- Expert Settings → Tweaks → Layout DPI
- Constraint:
-
- The accepted range is 72-600.
- Default:
300- Examples:
-
-
Plugin setting:
144 -
Shortcode:
layout_dpi
[save_as_pdf_pdfcrowd layout_dpi=144] -
PHP function:
layout_dpi
echo create_save_as_pdf_pdfcrowd_button(array('layout_dpi' => 144));
-
Plugin setting:
Content Area X
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
- Location:
- Expert Settings → Tweaks → Content Area X
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'. It may contain a negative value.
- Default:
0in- Examples:
-
-
Plugin setting:
10mm -
Shortcode:
content_area_x
[save_as_pdf_pdfcrowd content_area_x="10mm"] -
PHP function:
content_area_x
echo create_save_as_pdf_pdfcrowd_button(array('content_area_x' => '10mm'));
-
Plugin setting:
Content Area Y
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
- Location:
- Expert Settings → Tweaks → Content Area Y
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'. It may contain a negative value.
- Default:
0in- Examples:
-
-
Plugin setting:
10mm -
Shortcode:
content_area_y
[save_as_pdf_pdfcrowd content_area_y="10mm"] -
PHP function:
content_area_y
echo create_save_as_pdf_pdfcrowd_button(array('content_area_y' => '10mm'));
-
Plugin setting:
Content Area Width
Set the width of the content area. It should be at least 1 inch.
- Location:
- Expert Settings → Tweaks → Content Area Width
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
The width of the print area.- Examples:
-
-
Plugin setting:
210mm -
Shortcode:
content_area_width
[save_as_pdf_pdfcrowd content_area_width="210mm"] -
PHP function:
content_area_width
echo create_save_as_pdf_pdfcrowd_button(array('content_area_width' => '210mm'));
-
Plugin setting:
Content Area Height
Set the height of the content area. It should be at least 1 inch.
- Location:
- Expert Settings → Tweaks → Content Area Height
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Default:
The height of the print area.- Examples:
-
-
Plugin setting:
210mm -
Shortcode:
content_area_height
[save_as_pdf_pdfcrowd content_area_height="210mm"] -
PHP function:
content_area_height
echo create_save_as_pdf_pdfcrowd_button(array('content_area_height' => '210mm'));
-
Plugin setting:
Contents Matrix
A 2D transformation matrix applied to the main contents on each page. The origin [0,0] is located at the top-left corner of the contents. The resolution is 72 dpi.
- Location:
- Expert Settings → Tweaks → Contents Matrix
- Default:
1,0,0,0,1,0- Examples:
-
-
Plugin setting:
1,0,-10,0,1,-10 -
Shortcode:
contents_matrix
[save_as_pdf_pdfcrowd contents_matrix="1,0,-10,0,1,-10"] -
PHP function:
contents_matrix
echo create_save_as_pdf_pdfcrowd_button(array('contents_matrix' => '1,0,-10,0,1,-10'));
-
Plugin setting:
Header Matrix
A 2D transformation matrix applied to the page header contents. The origin [0,0] is located at the top-left corner of the header. The resolution is 72 dpi.
- Location:
- Expert Settings → Tweaks → Header Matrix
- Default:
1,0,0,0,1,0- Examples:
-
-
Plugin setting:
1,0,-10,0,1,-10 -
Shortcode:
header_matrix
[save_as_pdf_pdfcrowd header_matrix="1,0,-10,0,1,-10"] -
PHP function:
header_matrix
echo create_save_as_pdf_pdfcrowd_button(array('header_matrix' => '1,0,-10,0,1,-10'));
-
Plugin setting:
Disable Page Height Optimization
Disable automatic height adjustment that compensates for pixel to point rounding errors.
- Location:
- Expert Settings → Tweaks → Disable Page Height Optimization
- Default:
false- Examples:
-
-
Shortcode:
disable_page_height_optimization
[save_as_pdf_pdfcrowd disable_page_height_optimization=true] -
PHP function:
disable_page_height_optimization
echo create_save_as_pdf_pdfcrowd_button(array('disable_page_height_optimization' => true));
-
Shortcode:
Main Document CSS Annotation
pdfcrowd-page-X- where X is the current page numberpdfcrowd-page-odd- odd pagepdfcrowd-page-even- even page
- Location:
- Expert Settings → Tweaks → Main Document CSS Annotation
- Default:
false- Examples:
-
-
Plugin setting:
CSS styling by page number in API Playground -
Shortcode:
main_document_css_annotation
CSS styling by page number in API Playground -
PHP function:
main_document_css_annotation
CSS styling by page number in API Playground
-
Plugin setting:
Max Loading Time
Set the maximum time for loading the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.
- Location:
- Expert Settings → Tweaks → Max Loading Time
- Constraint:
-
- The accepted range is 10-30.
- Examples:
-
-
Shortcode:
max_loading_time -
PHP function:
max_loading_time
-
Shortcode:
Conversion Config
Configure conversion via JSON. The configuration defines various page settings for individual PDF pages or ranges of pages. It provides flexibility in designing each page of the PDF, giving control over each page's size, header, footer, etc. If a page or parameter is not explicitly specified, the system will use the default settings for that page or attribute. If a JSON configuration is provided, the settings in the JSON will take precedence over the global options.
The structure of the JSON must be:
- pageSetup: An array of objects where each object defines the configuration for a specific page or range of pages. The following properties can be set for each page object:
-
pages:
A comma-separated list of page numbers or ranges.
Special strings may be used, such as
odd,even, andlast. For example:- 1-: from page 1 to the end of the document
- 2: only the 2nd page
- 2,4,6: pages 2, 4, and 6
- 2-5: pages 2 through 5
- odd,2: the 2nd page and all odd pages
- pageSize: The page size (optional). Possible values: A0, A1, A2, A3, A4, A5, A6, Letter.
- pageWidth: The width of the page (optional).
- pageHeight: The height of the page (optional).
- marginLeft: Left margin (optional).
- marginRight: Right margin (optional).
- marginTop: Top margin (optional).
- marginBottom: Bottom margin (optional).
-
displayHeader: Header appearance (optional). Possible values:
- none: completely excluded
- space: only the content is excluded, the space is used
- content: the content is printed (default)
-
displayFooter: Footer appearance (optional). Possible values:
- none: completely excluded
- space: only the content is excluded, the space is used
- content: the content is printed (default)
- headerHeight: Height of the header (optional).
- footerHeight: Height of the footer (optional).
- orientation: Page orientation, such as "portrait" or "landscape" (optional).
- backgroundColor: Page background color in RRGGBB or RRGGBBAA hexadecimal format (optional).
-
pages:
A comma-separated list of page numbers or ranges.
Special strings may be used, such as
Dimensions may be empty, 0 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
- Location:
- Expert Settings → Tweaks → Conversion Config
- Examples:
-
-
Plugin setting:
{ "pageSetup": [ { "pages": "1-", "displayHeader": "none", "displayFooter": "none" }, { "pages": "1", "displayHeader": "content" }, { "pages": "last", "displayFooter": "content" } ] }
-
Plugin setting:
Conversion Config File
Configure the conversion process via JSON file. See details of the JSON string.
- Location:
- Expert Settings → Tweaks → Conversion Config File
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
Plugin setting:
/home/user/john/conv_config.json -
Shortcode:
conversion_config_file
[save_as_pdf_pdfcrowd conversion_config_file="/home/user/john/conv_config.json"] -
PHP function:
conversion_config_file
echo create_save_as_pdf_pdfcrowd_button(array('conversion_config_file' => '/home/user/john/conv_config.json'));
-
Plugin setting:
Converter User Agent
Specify the User-Agent HTTP header that will be used by the converter when a request is made to the converted web page.
- Location:
- Expert Settings → Tweaks → Converter User Agent
- Default:
latest-chrome-desktop- Allowed Values:
-
-
chrome-desktop— The user-agent for desktop chrome corresponding to the converter used. -
chrome-mobile— The user-agent for mobile chrome corresponding to the converter used. -
latest-chrome-desktop— The user-agent of the recently released Chrome browser on desktops. -
latest-chrome-mobile— The user-agent of the recently released Chrome browser on mobile devices. -
custom string— A custom string for the user agent.
-
- Examples:
-
-
Plugin setting:
Mozilla/5.0 (Macintosh; Intel Mac OS X 14_7_1) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0 Safari/605.1.15 -
Shortcode:
converter_user_agent
[save_as_pdf_pdfcrowd converter_user_agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 14_7_1) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0 Safari/605.1.15"] -
PHP function:
converter_user_agent
echo create_save_as_pdf_pdfcrowd_button(array('converter_user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14_7_1) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0 Safari/605.1.15'));
-
Plugin setting:
API Client Options
Converter Version
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
- Location:
- Expert Settings → API Client Options → Converter Version
- Default:
24.04- Allowed Values:
-
-
24.04— Version 24.04. -
20.10— Version 20.10. -
18.10— Version 18.10. -
latest— Version 20.10 is used.
-
- Examples:
-
-
Plugin setting:
Version 20.10 is used. -
Shortcode:
converter_version
[save_as_pdf_pdfcrowd converter_version="latest"] -
PHP function:
converter_version
echo create_save_as_pdf_pdfcrowd_button(array('converter_version' => 'latest'));
-
Plugin setting:
Use HTTP
Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.
- Location:
- Expert Settings → API Client Options → Use HTTP
- Default:
false- Examples:
-
-
Shortcode:
use_http
[save_as_pdf_pdfcrowd use_http=true] -
PHP function:
use_http
echo create_save_as_pdf_pdfcrowd_button(array('use_http' => true));
-
Shortcode:
Retry Count
Specify the number of automatic retries when a 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
- Location:
- Expert Settings → API Client Options → Retry Count
- Default:
1- Examples:
-
-
Plugin setting:
3 -
Shortcode:
retry_count
[save_as_pdf_pdfcrowd retry_count=3] -
PHP function:
retry_count
echo create_save_as_pdf_pdfcrowd_button(array('retry_count' => 3));
-
Plugin setting: