Choose where you want the button to appear automatically.
You can also manually add the
[save_as_image_pdfcrowd]
shortcode to your page to display the button, see
details,
or add
create_save_as_image_pdfcrowd_button
the function call to your PHP code, see
details.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Show Button on
option
Home page and Posts
Hide Button in Output Image
Choose whether to show the button in the output the image.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Hide Button in Output Image
checkbox
-
Shortcode:
button_hidden_image
[save_as_image_pdfcrowd button_hidden_image=1]
-
PHP function:
button_hidden_image
echo create_save_as_image_pdfcrowd_button(array('button_hidden_image' => 1));
Choose the arrangement of icons and text within the button.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Button Display Format
option
Text on the left and icon
-
Shortcode:
button_format
[save_as_image_pdfcrowd button_format="text-image"]
-
PHP function:
button_format
echo create_save_as_image_pdfcrowd_button(array('button_format' => 'text-image'));
The text to be displayed on the button.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Button Text
option
Download Report
-
Shortcode:
button_text
[save_as_image_pdfcrowd button_text="Download Report"]
-
PHP function:
button_text
echo create_save_as_image_pdfcrowd_button(array('button_text' => 'Download Report'));
Specify whether to translate the button text.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Button Text Translation
option
Automatic - look up in your internationalization files
-
Shortcode:
button_translation
[save_as_image_pdfcrowd button_translation="auto"]
-
PHP function:
button_translation
echo create_save_as_image_pdfcrowd_button(array('button_translation' => 'auto'));
The image to be displayed on the button.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Button Image
option
choose the 3rd image in the list
-
Shortcode:
button_image
[save_as_image_pdfcrowd button_image="image3.svg"]
-
PHP function:
button_image
echo create_save_as_image_pdfcrowd_button(array('button_image' => 'image3.svg'));
The width of the image on the button.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Button Image Width
option
18
-
Shortcode:
button_image_width
[save_as_image_pdfcrowd button_image_width=18]
-
PHP function:
button_image_width
echo create_save_as_image_pdfcrowd_button(array('button_image_width' => 18));
The height of the image on the button.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Button Image Height
option
18
-
Shortcode:
button_image_height
[save_as_image_pdfcrowd button_image_height=18]
-
PHP function:
button_image_height
echo create_save_as_image_pdfcrowd_button(array('button_image_height' => 18));
The ID used for the button in HTML to be used for the custom button styling or JavaScript event handler.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Button ID
option
convert-trigger
-
Shortcode:
button_id
[save_as_image_pdfcrowd button_id="convert-trigger"]
-
PHP function:
button_id
echo create_save_as_image_pdfcrowd_button(array('button_id' => 'convert-trigger'));
Choose to hide the button on the page. It is useful together with Button ID for triggering a conversion from your JavaScript.
Examples:
-
Plugin
Expert Settings tab →
Button Look section →
Hide Button in HTML
checkbox
-
Shortcode:
button_html_hidden
[save_as_image_pdfcrowd button_html_hidden=1]
-
PHP function:
button_html_hidden
echo create_save_as_image_pdfcrowd_button(array('button_html_hidden' => 1));
The position of the button relative to the content.
Examples:
-
Plugin
Expert Settings tab →
Button Positioning section →
Destination
option
above content
-
Shortcode:
button_position
[save_as_image_pdfcrowd button_position="above"]
-
PHP function:
button_position
echo create_save_as_image_pdfcrowd_button(array('button_position' => 'above'));
The alignment of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Positioning section →
Alignment
option
end
-
Shortcode:
button_alignment
[save_as_image_pdfcrowd button_alignment="end"]
-
PHP function:
button_alignment
echo create_save_as_image_pdfcrowd_button(array('button_alignment' => 'end'));
The top margin of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Positioning section →
Margin Top
option
10
-
Shortcode:
button_margin_top
[save_as_image_pdfcrowd button_margin_top=10]
-
PHP function:
button_margin_top
echo create_save_as_image_pdfcrowd_button(array('button_margin_top' => 10));
The right margin of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Positioning section →
Margin Right
option
10
-
Shortcode:
button_margin_right
[save_as_image_pdfcrowd button_margin_right=10]
-
PHP function:
button_margin_right
echo create_save_as_image_pdfcrowd_button(array('button_margin_right' => 10));
The bottom margin of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Positioning section →
Margin Bottom
option
10
-
Shortcode:
button_margin_bottom
[save_as_image_pdfcrowd button_margin_bottom=10]
-
PHP function:
button_margin_bottom
echo create_save_as_image_pdfcrowd_button(array('button_margin_bottom' => 10));
The left margin of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Positioning section →
Margin Left
option
10
-
Shortcode:
button_margin_left
[save_as_image_pdfcrowd button_margin_left=10]
-
PHP function:
button_margin_left
echo create_save_as_image_pdfcrowd_button(array('button_margin_left' => 10));
The style can also be changed using the .save-as-image-pdfcrowd-button
CSS rule.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Styling is
option
Custom
-
Shortcode:
button_styling
[save_as_image_pdfcrowd button_styling="custom"]
-
PHP function:
button_styling
echo create_save_as_image_pdfcrowd_button(array('button_styling' => 'custom'));
The font size for the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Text Size
option
18
-
Shortcode:
button_text_size
[save_as_image_pdfcrowd button_text_size=18]
-
PHP function:
button_text_size
echo create_save_as_image_pdfcrowd_button(array('button_text_size' => 18));
The font weight for the button.
Allowed values:
-
normal
-
bold
-
bolder
-
lighter
-
100
-
200
-
300
-
400
-
500
-
600
-
700
-
800
-
900
Default: bold
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Text Weight
option
bolder
-
Shortcode:
button_text_weight
[save_as_image_pdfcrowd button_text_weight="bolder"]
-
PHP function:
button_text_weight
echo create_save_as_image_pdfcrowd_button(array('button_text_weight' => 'bolder'));
The font color for the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Text Color
option
red
-
Shortcode:
button_text_color
[save_as_image_pdfcrowd button_text_color="red"]
-
PHP function:
button_text_color
echo create_save_as_image_pdfcrowd_button(array('button_text_color' => 'red'));
The background color of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Background Color
option
red
-
Shortcode:
button_background_color
[save_as_image_pdfcrowd button_background_color="red"]
-
PHP function:
button_background_color
echo create_save_as_image_pdfcrowd_button(array('button_background_color' => 'red'));
The border color of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Border Color
option
red
-
Shortcode:
button_border_color
[save_as_image_pdfcrowd button_border_color="red"]
-
PHP function:
button_border_color
echo create_save_as_image_pdfcrowd_button(array('button_border_color' => 'red'));
The border style of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Border Style
option
hidden
-
Shortcode:
button_border_style
[save_as_image_pdfcrowd button_border_style="hidden"]
-
PHP function:
button_border_style
echo create_save_as_image_pdfcrowd_button(array('button_border_style' => 'hidden'));
The border width of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Button Border Width
option
2
-
Shortcode:
button_border_width
[save_as_image_pdfcrowd button_border_width=2]
-
PHP function:
button_border_width
echo create_save_as_image_pdfcrowd_button(array('button_border_width' => 2));
The top padding of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Padding Top
option
10
-
Shortcode:
button_padding_top
[save_as_image_pdfcrowd button_padding_top=10]
-
PHP function:
button_padding_top
echo create_save_as_image_pdfcrowd_button(array('button_padding_top' => 10));
The right padding of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Padding Right
option
10
-
Shortcode:
button_padding_right
[save_as_image_pdfcrowd button_padding_right=10]
-
PHP function:
button_padding_right
echo create_save_as_image_pdfcrowd_button(array('button_padding_right' => 10));
The bottom padding of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Padding Bottom
option
10
-
Shortcode:
button_padding_bottom
[save_as_image_pdfcrowd button_padding_bottom=10]
-
PHP function:
button_padding_bottom
echo create_save_as_image_pdfcrowd_button(array('button_padding_bottom' => 10));
The left padding of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Padding Left
option
10
-
Shortcode:
button_padding_left
[save_as_image_pdfcrowd button_padding_left=10]
-
PHP function:
button_padding_left
echo create_save_as_image_pdfcrowd_button(array('button_padding_left' => 10));
The radius of the button.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Radius
option
4
-
Shortcode:
button_radius
[save_as_image_pdfcrowd button_radius=4]
-
PHP function:
button_radius
echo create_save_as_image_pdfcrowd_button(array('button_radius' => 4));
The mouse over style may be altered by your CSS rules .save-as-image-pdfcrowd-button-hover
, .save-as-image-pdfcrowd-has-indicator-func:hover
.
Examples:
-
Plugin
Expert Settings tab →
Button Styling section →
Change on Mouse Over
checkbox
-
Shortcode:
button_hover
[save_as_image_pdfcrowd button_hover=1]
-
PHP function:
button_hover
echo create_save_as_image_pdfcrowd_button(array('button_hover' => 1));
The type of indicator that appears above the button while the conversion is in progress.
Examples:
-
Plugin
Expert Settings tab →
Conversion in Progress Button Indicator section →
Type
option
Ring
-
Shortcode:
button_indicator
[save_as_image_pdfcrowd button_indicator="ring"]
-
PHP function:
button_indicator
echo create_save_as_image_pdfcrowd_button(array('button_indicator' => 'ring'));
If the indicator remains active even after the conversion has finished, set a time limit on the conversion time of your typical document, e.g. 5 seconds. Otherwise, use the default value of 60 seconds.
Examples:
-
Plugin
Expert Settings tab →
Conversion in Progress Button Indicator section →
Indicator Timeout
option
5
-
Shortcode:
button_indicator_timeout
[save_as_image_pdfcrowd button_indicator_timeout=5]
-
PHP function:
button_indicator_timeout
echo create_save_as_image_pdfcrowd_button(array('button_indicator_timeout' => 5));
Behavior
The action that is performed when the button is clicked.
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Button Click Action
option
Open the image in the current browser tab
-
Shortcode:
button_disposition
[save_as_image_pdfcrowd button_disposition="inline"]
-
PHP function:
button_disposition
echo create_save_as_image_pdfcrowd_button(array('button_disposition' => 'inline'));
The sender email. It can be empty if specified in your mailer plugin.
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Email From
option
info@example.com
-
Shortcode:
email_from
[save_as_image_pdfcrowd email_from="info@example.com"]
-
PHP function:
email_from
echo create_save_as_image_pdfcrowd_button(array('email_from' => 'info@example.com'));
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.
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"
Default: user
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Email Recipient
option
Prompt for an email address
-
Shortcode:
email_recipient
[save_as_image_pdfcrowd email_recipient="prompt"]
-
PHP function:
email_recipient
echo create_save_as_image_pdfcrowd_button(array('email_recipient' => 'prompt'));
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.
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Email Cc
option
john@example.com
-
Shortcode:
email_cc
[save_as_image_pdfcrowd email_cc="john@example.com"]
-
PHP function:
email_cc
echo create_save_as_image_pdfcrowd_button(array('email_cc' => 'john@example.com'));
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.
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Email Bcc
option
mary@example.com
-
Shortcode:
email_bcc
[save_as_image_pdfcrowd email_bcc="mary@example.com"]
-
PHP function:
email_bcc
echo create_save_as_image_pdfcrowd_button(array('email_bcc' => 'mary@example.com'));
The email subject template. The template may contain predefined variables enclosed in {{ }}
that are dynamically expanded. Available variables are:
- site - site name
- site_url - site url
- title - current page title
Available variables for logged in user:
- 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
If you need custom variables in the template, place Save as button into your code by PHP method with the template argument.
Default: {{site}} - {{title}} Image
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Email Subject
option
{{user_name}} - Report
-
Shortcode:
email_subject
[save_as_image_pdfcrowd email_subject="{{user_name}} - Report"]
-
PHP function:
email_subject
echo create_save_as_image_pdfcrowd_button(array('email_subject' => '{{user_name}} - Report'));
The email message template. HTML tags may be used in it. The template may contain predefined variables enclosed in {{ }}
that are dynamically expanded. Available variables are:
- site - site name
- site_url - site url
- title - current page title
Available variables for logged in user:
- 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
If you need custom variables in the template, place Save as button into your code by PHP method with the template argument.
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
Expert Settings tab →
Behavior section →
Email Message
option
<p>Dear {{user_first_name}} {{user_last_name}}, ...</p>
-
Shortcode:
email_message
[save_as_image_pdfcrowd email_message="<p>Dear {{user_first_name}} {{user_last_name}}, ...</p>"]
-
PHP function:
email_message
echo create_save_as_image_pdfcrowd_button(array('email_message' => '<p>Dear {{user_first_name}} {{user_last_name}}, ...</p>'));
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.
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"
Default: modal
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Email Dialogs
option
Predefined modal dialogs
-
Shortcode:
email_dialogs
[save_as_image_pdfcrowd email_dialogs="modal"]
-
PHP function:
email_dialogs
echo create_save_as_image_pdfcrowd_button(array('email_dialogs' => 'modal'));
The name of the output file. The name may not be specified and will be automatically created according to the page URL.
Default: the name is generated automatically
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Output Name
option
report.png
-
Shortcode:
output_name
[save_as_image_pdfcrowd output_name="report.png"]
-
PHP function:
output_name
echo create_save_as_image_pdfcrowd_button(array('output_name' => 'report.png'));
Specify the name of your PHP function to be invoked
when the output image is created.
The callback function is useful for custom actions,
e.g. saving the image 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 image.
The callback must be a valid PHP function name. The function must accept 1 argument - an array with keys:
-
output - the generated image data
-
options - options used for the conversion
-
file_name - the image filename
-
error - null for a successful conversion otherwise WP_Error
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Image Created Callback
option
save_to_local
-
Shortcode:
image_created_callback
[save_as_image_pdfcrowd image_created_callback="save_to_local"]
-
PHP function:
image_created_callback
echo create_save_as_image_pdfcrowd_button(array('image_created_callback' => 'save_to_local'));
Data assigned to the button.
They are sent to the Image Created Callback method and are accessible in the callback options['custom_data'] field.
Dynamic data may be used when the button is created by shortcode or function call.
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Custom Data
option
{'post_id': 123}
-
Shortcode:
custom_data
[save_as_image_pdfcrowd custom_data="{'post_id': 123}"]
-
PHP function:
custom_data
echo create_save_as_image_pdfcrowd_button(array('custom_data' => '{"post_id": 123}'));
Webpage used when the plugin raises an error.
You can specify either a URL or a WordPress page slug name.
If left empty, the default error page will be shown.
The details about the error can be accessed via
$_GET['error-code']
,
$_GET['error-message']
and
$_GET['error-details']
.
Default: the plugin's default error page
Examples:
-
Plugin
Expert Settings tab →
Behavior section →
Error Page
option
https://mysite.com/pdfcrowd-error/
-
Shortcode:
error_page
[save_as_image_pdfcrowd error_page="https://mysite.com/pdfcrowd-error/"]
-
PHP function:
error_page
echo create_save_as_image_pdfcrowd_button(array('error_page' => 'https://mysite.com/pdfcrowd-error/'));
Mode
Specify the source for the conversion to the image.
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"
Default: url
Examples:
-
Plugin
Expert Settings tab →
Mode section →
Conversion Mode
option
Content
-
Shortcode:
conversion_mode
[save_as_image_pdfcrowd conversion_mode="content"]
-
PHP function:
conversion_mode
echo create_save_as_image_pdfcrowd_button(array('conversion_mode' => 'content'));
It allows to choose how to retrieve URLs for the Conversion Mode-URL. It is suitable for a website using different location than permalink.
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"
Default: auto
Examples:
-
Plugin
Expert Settings tab →
Mode section →
URL Lookup
option
Location
-
Shortcode:
url_lookup
[save_as_image_pdfcrowd url_lookup="location"]
-
PHP function:
url_lookup
echo create_save_as_image_pdfcrowd_button(array('url_lookup' => 'location'));
Warning:
for developers only
Diagnostics data is displayed above the button.
It helps to identify the issue with the button appearance or
the conversion process.
Examples:
-
Plugin
Expert Settings tab →
Mode section →
Diagnostics
checkbox
-
Shortcode:
diagnostics
[save_as_image_pdfcrowd diagnostics=1]
-
PHP function:
diagnostics
echo create_save_as_image_pdfcrowd_button(array('diagnostics' => 1));
The format of the output file.
Examples:
-
Plugin
Basic Settings tab →
Conversion Format section →
Output Format
option
webp
-
Shortcode:
output_format
[save_as_image_pdfcrowd output_format="webp"]
-
PHP function:
output_format
echo create_save_as_image_pdfcrowd_button(array('output_format' => 'webp'));
Image Output
Set the output image width in pixels.
Constraint:
- The accepted range is 96-65000.
Default: 1024
Examples:
-
Plugin
Basic Settings tab →
Image Output section →
Screenshot Width
option
1920
-
Shortcode:
screenshot_width
[save_as_image_pdfcrowd screenshot_width=1920]
-
PHP function:
screenshot_width
echo create_save_as_image_pdfcrowd_button(array('screenshot_width' => 1920));
Set the output image height in pixels. If it is not specified, actual document height is used.
Constraint:
- Must be a positive integer.
Examples:
-
Plugin
Basic Settings tab →
Image Output section →
Screenshot Height
option
1080
-
Shortcode:
screenshot_height
[save_as_image_pdfcrowd screenshot_height=1080]
-
PHP function:
screenshot_height
echo create_save_as_image_pdfcrowd_button(array('screenshot_height' => 1080));
Set the scaling factor (zoom) for the output image.
Constraint:
- Must be a positive integer.
Default: 100
Examples:
-
Plugin
Expert Settings tab →
Image Output section →
Scale Factor
option
50
-
Shortcode:
scale_factor
[save_as_image_pdfcrowd scale_factor=50]
-
PHP function:
scale_factor
echo create_save_as_image_pdfcrowd_button(array('scale_factor' => 50));
The output image background color.
Constraint:
- The value must be in RRGGBB or RRGGBBAA hexadecimal format.
Examples:
-
Plugin
Expert Settings tab →
Image Output section →
Background Color
option
00ff00
-
Shortcode:
background_color
[save_as_image_pdfcrowd background_color="00ff00"]
-
PHP function:
background_color
echo create_save_as_image_pdfcrowd_button(array('background_color' => '00ff00'));
General Options
Use the print version of the page if available (@media print).
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Use Print Media
checkbox
-
Shortcode:
use_print_media
[save_as_image_pdfcrowd use_print_media=true]
-
PHP function:
use_print_media
echo create_save_as_image_pdfcrowd_button(array('use_print_media' => true));
Do not print the background graphics.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
No Background
checkbox
-
Shortcode:
no_background
[save_as_image_pdfcrowd no_background=true]
-
PHP function:
no_background
echo create_save_as_image_pdfcrowd_button(array('no_background' => true));
Do not execute JavaScript.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Disable JavaScript
checkbox
-
Shortcode:
disable_javascript
[save_as_image_pdfcrowd disable_javascript=true]
-
PHP function:
disable_javascript
echo create_save_as_image_pdfcrowd_button(array('disable_javascript' => true));
Do not load images.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Disable Image Loading
checkbox
-
Shortcode:
disable_image_loading
[save_as_image_pdfcrowd disable_image_loading=true]
-
PHP function:
disable_image_loading
echo create_save_as_image_pdfcrowd_button(array('disable_image_loading' => true));
Disable loading fonts from remote sources.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Disable Remote Fonts
checkbox
-
Shortcode:
disable_remote_fonts
[save_as_image_pdfcrowd disable_remote_fonts=true]
-
PHP function:
disable_remote_fonts
echo create_save_as_image_pdfcrowd_button(array('disable_remote_fonts' => true));
Use a mobile user agent.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Use Mobile User Agent
checkbox
-
Shortcode:
use_mobile_user_agent
[save_as_image_pdfcrowd use_mobile_user_agent=true]
-
PHP function:
use_mobile_user_agent
echo create_save_as_image_pdfcrowd_button(array('use_mobile_user_agent' => true));
Specifies how iframes are handled.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Load Iframes
option
Iframe loading is disabled.
-
Shortcode:
load_iframes
[save_as_image_pdfcrowd load_iframes="none"]
-
PHP function:
load_iframes
echo create_save_as_image_pdfcrowd_button(array('load_iframes' => 'none'));
Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Block Ads
checkbox
-
Shortcode:
block_ads
[save_as_image_pdfcrowd block_ads=true]
-
PHP function:
block_ads
echo create_save_as_image_pdfcrowd_button(array('block_ads' => true));
Set the default HTML content text encoding.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Default Encoding
option
utf-8
-
Shortcode:
default_encoding
[save_as_image_pdfcrowd default_encoding="utf-8"]
-
PHP function:
default_encoding
echo create_save_as_image_pdfcrowd_button(array('default_encoding' => 'utf-8'));
Set the locale for the conversion. This may affect the output format of dates, times and numbers.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Locale
option
ja-JP
-
Shortcode:
locale
[save_as_image_pdfcrowd locale="ja-JP"]
-
PHP function:
locale
echo create_save_as_image_pdfcrowd_button(array('locale' => 'ja-JP'));
Set the HTTP authentication user name.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
HTTP Auth User Name
option
John
-
Shortcode:
http_auth_user_name
[save_as_image_pdfcrowd http_auth_user_name="John"]
-
PHP function:
http_auth_user_name
echo create_save_as_image_pdfcrowd_button(array('http_auth_user_name' => 'John'));
Set the HTTP authentication password.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
HTTP Auth Password
option
123456
-
Shortcode:
http_auth_password
[save_as_image_pdfcrowd http_auth_password="123456"]
-
PHP function:
http_auth_password
echo create_save_as_image_pdfcrowd_button(array('http_auth_password' => '123456'));
Set HTTP cookies to be included in all requests made by the converter.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Cookies
option
session=6d7184b3bf35;token=2710
-
Shortcode:
cookies
[save_as_image_pdfcrowd cookies="session=6d7184b3bf35;token=2710"]
-
PHP function:
cookies
echo create_save_as_image_pdfcrowd_button(array('cookies' => 'session=6d7184b3bf35;token=2710'));
Do not allow insecure HTTPS connections.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Verify SSL Certificates
checkbox
-
Shortcode:
verify_ssl_certificates
[save_as_image_pdfcrowd verify_ssl_certificates=true]
-
PHP function:
verify_ssl_certificates
echo create_save_as_image_pdfcrowd_button(array('verify_ssl_certificates' => true));
Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Fail On Main URL Error
checkbox
-
Shortcode:
fail_on_main_url_error
[save_as_image_pdfcrowd fail_on_main_url_error=true]
-
PHP function:
fail_on_main_url_error
echo create_save_as_image_pdfcrowd_button(array('fail_on_main_url_error' => true));
Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Fail On Any URL Error
checkbox
-
Shortcode:
fail_on_any_url_error
[save_as_image_pdfcrowd fail_on_any_url_error=true]
-
PHP function:
fail_on_any_url_error
echo create_save_as_image_pdfcrowd_button(array('fail_on_any_url_error' => true));
Do not send the X-Pdfcrowd HTTP header in PDFCrowd HTTP requests.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
No X-Pdfcrowd Header
checkbox
-
Shortcode:
no_xpdfcrowd_header
[save_as_image_pdfcrowd no_xpdfcrowd_header=true]
-
PHP function:
no_xpdfcrowd_header
echo create_save_as_image_pdfcrowd_button(array('no_xpdfcrowd_header' => true));
Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.
Examples:
-
Plugin
Basic Settings tab →
General Options section →
Custom CSS
option
nav, #ad-block { display: none !important; }
-
Shortcode:
custom_css
[save_as_image_pdfcrowd custom_css="nav, #ad-block { display: none !important; }"]
-
PHP function:
custom_css
echo create_save_as_image_pdfcrowd_button(array('custom_css' => 'nav, #ad-block { display: none !important; }'));
Run a custom JavaScript after the document is loaded and ready to print. 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.
Examples:
-
Plugin
Basic Settings tab →
General Options section →
Custom JavaScript
option
document.body.style.setProperty('background-color', 'gray', 'important')
-
Shortcode:
custom_javascript
[save_as_image_pdfcrowd custom_javascript="document.body.style.setProperty('background-color', 'gray', 'important')"]
-
PHP function:
custom_javascript
echo create_save_as_image_pdfcrowd_button(array('custom_javascript' => 'document.body.style.setProperty("background-color", "gray", "important")'));
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.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
On Load JavaScript
option
document.body.style.setProperty('background-color', 'gray', 'important')
-
Shortcode:
on_load_javascript
[save_as_image_pdfcrowd on_load_javascript="document.body.style.setProperty('background-color', 'gray', 'important')"]
-
PHP function:
on_load_javascript
echo create_save_as_image_pdfcrowd_button(array('on_load_javascript' => 'document.body.style.setProperty("background-color", "gray", "important")'));
Set a custom HTTP header to be included in all requests made by the converter.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Custom HTTP Header
option
X-My-Client-ID:k2017-12345
-
Shortcode:
custom_http_header
[save_as_image_pdfcrowd custom_http_header="X-My-Client-ID:k2017-12345"]
-
PHP function:
custom_http_header
echo create_save_as_image_pdfcrowd_button(array('custom_http_header' => 'X-My-Client-ID:k2017-12345'));
Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your license defines the maximum wait time by "Max Delay" parameter.
Constraint:
- Must be a positive integer or 0.
Default: 200
Examples:
-
Plugin
Expert Settings tab →
General Options section →
JavaScript Delay
option
2000
-
Shortcode:
javascript_delay
[save_as_image_pdfcrowd javascript_delay=2000]
-
PHP function:
javascript_delay
echo create_save_as_image_pdfcrowd_button(array('javascript_delay' => 2000));
Convert only the specified element from the main document and its children. 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.
Examples:
-
Plugin
Basic Settings tab →
General Options section →
Element To Convert
option
div.user-panel.main p.article
-
Shortcode:
element_to_convert
[save_as_image_pdfcrowd element_to_convert="div.user-panel.main p.article"]
-
PHP function:
element_to_convert
echo create_save_as_image_pdfcrowd_button(array('element_to_convert' => 'div.user-panel.main p.article'));
Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
Allowed values:
-
cut-out
The element and its children are cut out of the document.
-
remove-siblings
All element's siblings are removed.
-
hide-siblings
All element's siblings are hidden.
Default: cut-out
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Element To Convert Mode
option
All element's siblings are hidden.
-
Shortcode:
element_to_convert_mode
[save_as_image_pdfcrowd element_to_convert_mode="hide-siblings"]
-
PHP function:
element_to_convert_mode
echo create_save_as_image_pdfcrowd_button(array('element_to_convert_mode' => 'hide-siblings'));
Wait for the specified element in a source document. 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 "Max Delay" parameter.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Wait For Element
option
div.user-panel.main p.article
-
Shortcode:
wait_for_element
[save_as_image_pdfcrowd wait_for_element="div.user-panel.main p.article"]
-
PHP function:
wait_for_element
echo create_save_as_image_pdfcrowd_button(array('wait_for_element' => 'div.user-panel.main p.article'));
Auto Detect Element To Convert
The main HTML element for conversion is detected automatically.
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Auto Detect Element To Convert
checkbox
-
Shortcode:
auto_detect_element_to_convert
[save_as_image_pdfcrowd auto_detect_element_to_convert=true]
-
PHP function:
auto_detect_element_to_convert
echo create_save_as_image_pdfcrowd_button(array('auto_detect_element_to_convert' => true));
The input HTML is automatically enhanced to improve the readability.
Allowed values:
-
none
No enhancements are used.
-
readability-v1
Version 1 of the enhancements is used.
-
readability-v2
Version 2 of the enhancements is used.
-
readability-v3
Version 3 of the enhancements is used.
-
readability-v4
Version 4 of the enhancements is used.
Default: none
Examples:
-
Plugin
Expert Settings tab →
General Options section →
Readability Enhancements
option
Version 4 of the enhancements is used.
-
Shortcode:
readability_enhancements
[save_as_image_pdfcrowd readability_enhancements="readability-v4"]
-
PHP function:
readability_enhancements
echo create_save_as_image_pdfcrowd_button(array('readability_enhancements' => 'readability-v4'));
Data
Methods related to HTML template rendering.
Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
Examples:
-
Plugin
Expert Settings tab →
Data section →
Data String
option
{"recipient": "Anna May", "sender": "John Doe"}
-
Shortcode:
data_string
[save_as_image_pdfcrowd data_string="{'recipient': 'Anna May', 'sender': 'John Doe'}"]
-
PHP function:
data_string
echo create_save_as_image_pdfcrowd_button(array('data_string' => '{"recipient": "Anna May", "sender": "John Doe"}'));
Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
Examples:
-
Plugin
Expert Settings tab →
Data section →
Data File
option
/home/user/john/data.json
-
Shortcode:
data_file
[save_as_image_pdfcrowd data_file="/home/user/john/data.json"]
-
PHP function:
data_file
echo create_save_as_image_pdfcrowd_button(array('data_file' => '/home/user/john/data.json'));
Specify the input data format.
Examples:
-
Plugin
Expert Settings tab →
Data section →
Data Format
option
csv
-
Shortcode:
data_format
[save_as_image_pdfcrowd data_format="csv"]
-
PHP function:
data_format
echo create_save_as_image_pdfcrowd_button(array('data_format' => 'csv'));
Examples:
-
Plugin
Expert Settings tab →
Data section →
Data Encoding
option
iso8859-2
-
Shortcode:
data_encoding
[save_as_image_pdfcrowd data_encoding="iso8859-2"]
-
PHP function:
data_encoding
echo create_save_as_image_pdfcrowd_button(array('data_encoding' => 'iso8859-2'));
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.
Examples:
-
Plugin
Expert Settings tab →
Data section →
Data Ignore Undefined
checkbox
-
Shortcode:
data_ignore_undefined
[save_as_image_pdfcrowd data_ignore_undefined=true]
-
PHP function:
data_ignore_undefined
echo create_save_as_image_pdfcrowd_button(array('data_ignore_undefined' => true));
Auto escape HTML symbols in the input data before placing them into the output.
Examples:
-
Plugin
Expert Settings tab →
Data section →
Data Auto Escape
checkbox
-
Shortcode:
data_auto_escape
[save_as_image_pdfcrowd data_auto_escape=true]
-
PHP function:
data_auto_escape
echo create_save_as_image_pdfcrowd_button(array('data_auto_escape' => true));
Auto trim whitespace around each template command block.
Examples:
-
Plugin
Expert Settings tab →
Data section →
Data Trim Blocks
checkbox
-
Shortcode:
data_trim_blocks
[save_as_image_pdfcrowd data_trim_blocks=true]
-
PHP function:
data_trim_blocks
echo create_save_as_image_pdfcrowd_button(array('data_trim_blocks' => true));
Set the advanced data options:
- 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 is data.
Examples:
-
Plugin
Expert Settings tab →
Data section →
Data Options
option
xml_remove_root=1
-
Shortcode:
data_options
[save_as_image_pdfcrowd data_options="xml_remove_root=1"]
-
PHP function:
data_options
echo create_save_as_image_pdfcrowd_button(array('data_options' => 'xml_remove_root=1'));
Miscellaneous
Turn on the debug logging. Details about the conversion are stored in the debug log. The debug log is available in
conversion statistics.
Examples:
-
Plugin
Expert Settings tab →
Miscellaneous section →
Debug Log
checkbox
-
Shortcode:
debug_log
[save_as_image_pdfcrowd debug_log=true]
-
PHP function:
debug_log
echo create_save_as_image_pdfcrowd_button(array('debug_log' => true));
Tag the conversion with a custom value. The tag is used in
conversion statistics. A value longer than 32 characters is cut off.
Examples:
-
Plugin
Expert Settings tab →
Miscellaneous section →
Tag
option
client-1234
-
Shortcode:
tag
[save_as_image_pdfcrowd tag="client-1234"]
-
PHP function:
tag
echo create_save_as_image_pdfcrowd_button(array('tag' => 'client-1234'));
A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Constraint:
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
-
Plugin
Expert Settings tab →
Miscellaneous section →
HTTP Proxy
option
113.25.84.10:33333
-
Shortcode:
http_proxy
[save_as_image_pdfcrowd http_proxy="113.25.84.10:33333"]
-
PHP function:
http_proxy
echo create_save_as_image_pdfcrowd_button(array('http_proxy' => '113.25.84.10:33333'));
A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Constraint:
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
-
Plugin
Expert Settings tab →
Miscellaneous section →
HTTPS Proxy
option
113.25.84.10:44333
-
Shortcode:
https_proxy
[save_as_image_pdfcrowd https_proxy="113.25.84.10:44333"]
-
PHP function:
https_proxy
echo create_save_as_image_pdfcrowd_button(array('https_proxy' => '113.25.84.10:44333'));
A client certificate to authenticate the converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.
Constraint:
- The file must exist and not be empty.
Examples:
-
Plugin
Expert Settings tab →
Miscellaneous section →
Client Certificate
option
/home/user/john/pdfcrowd.crt
-
Shortcode:
client_certificate
[save_as_image_pdfcrowd client_certificate="/home/user/john/pdfcrowd.crt"]
-
PHP function:
client_certificate
echo create_save_as_image_pdfcrowd_button(array('client_certificate' => '/home/user/john/pdfcrowd.crt'));
Client Certificate Password
A password for PKCS12 file with a client certificate if it is needed.
Examples:
-
Plugin
Expert Settings tab →
Miscellaneous section →
Client Certificate Password
option
123456
-
Shortcode:
client_certificate_password
[save_as_image_pdfcrowd client_certificate_password="123456"]
-
PHP function:
client_certificate_password
echo create_save_as_image_pdfcrowd_button(array('client_certificate_password' => '123456'));
Tweaks
Expert options for fine-tuning output.
Set the maximum time to load 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.
Constraint:
- The accepted range is 10-30.
Examples:
-
Plugin
Expert Settings tab →
Tweaks section →
Max Loading Time
option
-
Shortcode:
max_loading_time
-
PHP function:
max_loading_time
Specifies the User-Agent HTTP header that will be used by the converter when a request is made to the converted web page.
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.
-
A custom string for the user agent.
Default: latest-chrome-desktop
Examples:
-
Plugin
Expert Settings tab →
Tweaks section →
Converter User Agent
option
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_image_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_image_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'));
API Client Options
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
Allowed values:
-
24.04
Version 24.04.
-
20.10
Version 20.10.
-
18.10
Version 18.10.
Default: 24.04
Examples:
-
Plugin
Expert Settings tab →
API Client Options section →
Converter Version
option
Version 20.10 is used.
-
Shortcode:
converter_version
[save_as_image_pdfcrowd converter_version="latest"]
-
PHP function:
converter_version
echo create_save_as_image_pdfcrowd_button(array('converter_version' => 'latest'));
Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.
Warning
Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
Examples:
-
Plugin
Expert Settings tab →
API Client Options section →
Use HTTP
checkbox
-
Shortcode:
use_http
[save_as_image_pdfcrowd use_http=true]
-
PHP function:
use_http
echo create_save_as_image_pdfcrowd_button(array('use_http' => true));
Specifies the number of automatic retries when the 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.
Examples:
-
Plugin
Expert Settings tab →
API Client Options section →
Retry Count
option
3
-
Shortcode:
retry_count
[save_as_image_pdfcrowd retry_count=3]
-
PHP function:
retry_count
echo create_save_as_image_pdfcrowd_button(array('retry_count' => 3));