WS Form variables enable you to add dynamic content to various elements of your form such as default field values and email templates.
Looking for some of our most commonly used variables? Check out our Variable Cheat Sheet!
Areas where WS Form variables can be used are accompanied by a field lookup icon. By clicking this icon, a list of the available variables will be shown below the corresponding field. Clicking on a variable will insert it into the field you are editing.
All WS Form variables start with the # character. For example:
#blog_name
Some variables take additional parameters. For example:
#field(123)
If a variable takes more than one parameter, you separate those values with a comma. For example:
#email_submission(true,true,true)
If a variable parameter contains a comma, you should encase it in double quotes. For example:
#server_date_custom("d m, Y")
WS Form Variable List
The following variables are available for use in WS Form.
- Author
- Blog
- Calculation
- Character
- Checkbox
- Client
- Conditional
- Cookies
- Data Grid Rows
- Date
- E-Commerce
- Field
- Form
- Freshdesk
- HTTP
- Hash
- InstaWP
- Local Storage
- Math
- Number
- OpenAI
- Option
- Post
- Progress
- Radio
- Random Numbers
- Random Strings
- Search
- Seconds
- Section
- Section Rows
- Select
- Server
- Session Storage
- Skin
- String
- Stripe Elements
- Submission
- Tab
- Text
- Tracking
- URL
- User
- Word
- Zendesk
Blog
| Variable | Name | Description | Usage |
|---|---|---|---|
#blog_admin_email | Admin Email | Returns the Administrator Email Address setting in WordPress Settings > General. | Actions |
#blog_charset | Character Set | Returns the site character set. | Client-side & Actions |
#blog_date | Current Date | Returns the blog time formatted according to the Time Format setting found in WordPress Settings > General. For more information about this variable, click here. | Actions |
#blog_date_custom("format", seconds_offset) | Custom Date | Returns the blog date and time in the specified format (PHP date format). For more information about this variable, click here. | Actions |
#blog_language | Language | Returns the Language setting in WordPress Settings > General. | Client-side & Actions |
#blog_name | Name | Returns the Site Title setting in WordPress Settings > General. | Client-side & Actions |
#blog_time | Current Time | Returns the blog time formatted according to the Date Format setting found in WordPress Settings > General. For more information about this variable, click here. | Actions |
#blog_url | URL | Returns the WordPress Address (URL) setting in WordPress Settings > General. | Client-side & Actions |
Calculation
| Variable | Name | Description | Usage |
|---|---|---|---|
#calc(calculation) | Calculation | Returns the calculated value. For more information about this variable, click here. | Client-side |
Character
| Variable | Name | Description | Usage |
|---|---|---|---|
#character_count | Count | Returns the total character count. For more information about this variable, click here. | |
#character_count_label | Count Label | Returns 'character' or 'characters' depending on the character count. For more information about this variable, click here. | |
#character_max | Maximum | Returns the maximum character length that you set for a field. For more information about this variable, click here. | |
#character_max_label | Maximum Label | Returns 'character' or 'characters' depending on the maximum character length. For more information about this variable, click here. | |
#character_min | Minimum | Returns the minimum character length that you set for a field. For more information about this variable, click here. | |
#character_min_label | Minimum Label | Returns 'character' or 'characters' depending on the minimum character length. For more information about this variable, click here. | |
#character_remaining | Count Remaining | If you set a maximum character length for a field, this will return the total remaining character count. For more information about this variable, click here. | |
#character_remaining_label | Count Remaining Label | If you set a maximum character length for a field, this will return the total remaining character count. For more information about this variable, click here. |
Checkbox
| Variable | Name | Description | Usage |
|---|---|---|---|
#checkbox_count(field_id, include_hidden) | Checkbox Checked Count | Use this variable to return the number of checkboxes that have been checked in a checkbox field. For example: #checkbox_count(123) where '123' is the field ID shown in the layout editor. Use #text(#checkbox_count(123)) to keep the value dynamically updated. For more information about this variable, click here. | Client-side |
#checkbox_count_total(field_id, include_hidden) | Checkbox Rows Count | Use this variable to return the total number of checkboxes in a checkbox field. For example: #checkbox_count_total(123) where '123' is the field ID shown in the layout editor. Use #text(#checkbox_count_total(123)) to keep the value dynamically updated. Set include_hidden attribute to true to include hidden checkboxes. For more information about this variable, click here. | Client-side |
#checkbox_label(field_id, "delimiter") | Checkbox Label | Use this variable to insert the label of a checkbox field on your form. For example: #checkbox_label(123) where '123' is the field ID shown in the layout editor. For more information about this variable, click here. | Client-side |
Client
| Variable | Name | Description | Usage |
|---|---|---|---|
#client_date | Current Date | Returns the users web browser local date according to the Date Format setting found in WordPress Settings > General. For more information about this variable, click here. | Client-side |
#client_date_custom("format", seconds_offset) | Custom Date | Returns the users web browser local date and time in the specified format (PHP date format). For more information about this variable, click here. | Client-side |
#client_time | Current Time | Returns the users web browser local time according to the Time Format setting found in WordPress Settings > General. For more information about this variable, click here. | Client-side |
Conditional
| Variable | Name | Description | Usage |
|---|---|---|---|
#endif | End of IF condition. | End of IF condition. For more information about this variable, click here. | Client-side & Actions |
#if("condition") | Start of IF condition. | Start of IF condition. For more information about this variable, click here. | Client-side & Actions |
Data Grid Rows
| Variable | Name | Description | Usage |
|---|---|---|---|
#data_grid_row_action_variable | Action Variable Column | Use this variable within a data grid row to insert the text found in the action variable column. For more information about this variable, click here. | |
#data_grid_row_label | Label Column | Use this variable within a data grid row to insert the text found in the label column. For more information about this variable, click here. | |
#data_grid_row_price | Price Column | Use this variable within a data grid row to insert the text found in the price column. For more information about this variable, click here. | |
#data_grid_row_price_currency | Price Column (With Currency) | Use this variable within a data grid row to insert the text found in the price column formatted using the currency settings. For more information about this variable, click here. | |
#data_grid_row_value | Value Column | Use this variable within a data grid row to insert the text found in the value column. For more information about this variable, click here. | |
#data_grid_row_woocommerce_cart | WooCommerce Cart Column | Use this variable within a data grid row to insert the text found in the WooCommerce cart column. For more information about this variable, click here. |
Date
| Variable | Name | Description | Usage |
|---|---|---|---|
#date_format("date", "format") | Format a date string | Return a date formatted according to the PHP date function. The date supplied must be in a supported format such as ISO 8601, for example: 2025-12-14T00:29:53+00:00. For field related date formatting, see: #field_date_format | Client-side & Actions |
E-Commerce
| Variable | Name | Description | Usage |
|---|---|---|---|
#ecommerce_cart_discount | Discount | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_discount_currency | Discount (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_discount_span | Discount (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_discount_span_currency | Discount (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_gift_wrap | Gift Wrap | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_gift_wrap_currency | Gift Wrap (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_gift_wrap_span | Gift Wrap (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_gift_wrap_span_currency | Gift Wrap (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_handling_fee | Handling Fee | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_handling_fee_currency | Handling Fee (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_handling_fee_span | Handling Fee (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_handling_fee_span_currency | Handling Fee (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_insurance | Insurance | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_insurance_currency | Insurance (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_insurance_span | Insurance (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_insurance_span_currency | Insurance (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_other | Other | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_other_currency | Other (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_other_span | Other (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_other_span_currency | Other (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_shipping | Shipping | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_shipping_currency | Shipping (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_shipping_discount | Shipping Discount | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_shipping_discount_currency | Shipping Discount (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_shipping_discount_span | Shipping Discount (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_shipping_discount_span_currency | Shipping Discount (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_shipping_span | Shipping (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_shipping_span_currency | Shipping (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_subtotal | Subtotal | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_subtotal_currency | Subtotal (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_subtotal_span | Subtotal (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_subtotal_span_currency | Subtotal (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_tax | Tax | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_tax_currency | Tax (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_tax_span | Tax (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_tax_span_currency | Tax (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_total | Total | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_total_currency | Total (Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_cart_total_span | Total (Span) | Excludes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_cart_total_span_currency | Total (Span Currency) | Includes currency symbol. For more information about this variable, click here. | Client-side |
#ecommerce_currency_symbol | Currency Symbol | Returns the current currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_field_price(field_id) | Field Value as Price | Use this variable to insert the value of a price field on your form. For example: #field(123) where '123' is the field ID shown in the layout editor. This variable will neatly format a currency value according to your E-Commerce settings. An example output might be: $123.00 For more information about this variable, click here. | Client-side & Actions |
#ecommerce_payment_method | Payment Method | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_price(price) | Value as Price | Convert the number input to a price that matches the configured e-commerce currency settings. An example output might be: $123.00 For more information about this variable, click here. | Client-side & Actions |
#ecommerce_status | Order Status | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
#ecommerce_transaction_id | Transaction ID | Excludes currency symbol. For more information about this variable, click here. | Client-side & Actions |
| Variable | Name | Description | Usage |
|---|---|---|---|
#email_charset | Character set | Returns the email character set. For more information about this variable, click here. | Actions |
#email_content_type | Content type | Returns the email content type. For more information about this variable, click here. | Actions |
#email_ecommerce | E-Commerce Values | Returns a list of the e-commerce transaction details such as total, transaction ID and status fields. For more information about this variable, click here. | Actions |
#email_logo | Logo | Returns the email logo specified in WS Form Settings > Variables. For more information about this variable, click here. | Actions |
#email_subject | Subject | Returns the email subject line. For more information about this variable, click here. | Actions |
#email_submission(tab_labels, section_labels, field_labels, blank_fields, static_fields) | Submitted Fields | Returns a list of the fields captured during a submission. You can either use: #email_submission or provide additional parameters to toggle tab labels, section labels, blank fields and static fields (such as text or HTML areas of your form). Specify 'true' or 'false' for each parameter, for example: #email_submission(true, true, false, true, true) For more information about this variable, click here. | Actions |
#email_tracking | Tracking data | Returns a list of all the enabled tracking data that was captured when the form was submitted. For more information about this variable, click here. | Actions |
Field
| Variable | Name | Description | Usage |
|---|---|---|---|
#field(field_id, "delimiter", "column") | Field Value | Use this variable to insert the value of a field on your form. For example: #field(123) where '123' is the field ID shown in the layout editor. If delimiter specified, fields with multiple values (e.g. checkboxes) will be separated by the specified delimiter. If column is specified it will return the value found in that data grid column. The value of column can be the column label or index (starting with 0). | Client-side & Actions |
#field_count_char(field_id, "regex_filter") | Count the Number of Characters in a Field | Use this variable to insert the number of characters in a field on your form. For example: #calc(#field_count_char(123)) where '123' is the field ID shown in the layout editor. Optionally specify a JavaScript regex to filter the characters included in the calculation. For example: #calc(#field_count_char(123, "/[^0-9a-z]/gi")). | Client-side |
#field_count_word(field_id, "regex_filter") | Count the Number of Words in a Field | Use this variable to insert the number of words in a field on your form. For example: #calc(#field_count_word(123)) where '123' is the field ID shown in the layout editor. Optionally specify a JavaScript regex to filter the characters included in the calculation. | Client-side |
#field_date_age(field_id, "period") | Field Date Age | Return the age of the provided date field. Period: y = Years (Default), m = Months, d = Days, h = Hours, n = Minutes, s = Seconds | Client-side |
#field_date_format(field_id, "format") | Field Date Formatted | Return a field formatted according to the PHP date function. | Client-side & Actions |
#field_date_offset(field_id, seconds_offset, "format") | Field Date Adjusted by Offset in Seconds | Return a date adjusted by an offset in seconds. | Client-side & Actions |
#field_float(field_id) | Field Value as Floating Point Number | Use this variable to insert the value of a field on your form as a floating point number. For example: #field(123) where '123' is the field ID shown in the layout editor. This can be used to convert prices to floating point numbers. An example output might be: 123.45 | Client-side & Actions |
#field_label(field_id) | Field Label | Returns the field label by ID. | Client-side & Actions |
#field_max_id(field_id) | Field ID with Max Value | Use this variable to return the ID of the field containing highest value. For example: #calc(#field_max_id(5, 6, 7, 8)). This would check fields IDs 5, 6, 7, and 8 and return the field ID containing the highest value. | Client-side |
#field_max_label(field_id) | Field Label with Max Value | Use this variable to return the label of the field containing highest value. For example: #calc(#field_max_id(5, 6, 7, 8)). This would check fields IDs 5, 6, 7, and 8 and return the field label containing the highest value. | Client-side |
#field_max_value(field_id) | Maximum Value of Fields | Use this variable to return the highest value for the supplied field IDs. For example: #calc(#field_max_value(5, 6, 7, 8)). This would check fields IDs 5, 6, 7, and 8 and return the highest value contained within those fields. | Client-side |
#field_min_id(field_id) | Field ID with Min Value | Use this variable to return the ID of the field containing lowest value. For example: #calc(#field_min_id(5, 6, 7, 8)). This would check fields IDs 5, 6, 7, and 8 and return the field ID containing the lowest value. | Client-side |
#field_min_label(field_id) | Field Label with Min Value | Use this variable to return the label of the field containing lowest value. For example: #calc(#field_min_id(5, 6, 7, 8)). This would check fields IDs 5, 6, 7, and 8 and return the field label containing the lowest value. | Client-side |
#field_min_value(field_id) | Minimum Value of Fields | Use this variable to return the minimum value for the supplied field IDs. For example: #calc(#field_min_value(5, 6, 7, 8)). This would check fields IDs 5, 6, 7, and 8 and return the lowest value contained within those fields. | Client-side |
Form
| Variable | Name | Description | Usage |
|---|---|---|---|
#form_checksum | Checksum | Returns the form checksum. | Client-side & Actions |
#form_framework | Framework | Returns the current framework being used to render the form. | Client-side & Actions |
#form_id | ID | Returns the ID of the form. | Client-side & Actions |
#form_instance_id | Instance ID | Returns the form instance ID. For more information about this variable, click here. | Client-side |
#form_label | Label | Returns the form label. | Client-side & Actions |
#form_obj_id | DOM Selector ID | Returns the DOM selector ID of the form element. For more information about this variable, click here. | Client-side |
Freshdesk
| Variable | Name | Description | Usage |
|---|---|---|---|
#freshdesk_ticket_id | Ticket ID | Returns the ID of the created ticket. | Actions |
#freshdesk_ticket_url | Ticket URL | Returns the URL of the created ticket in your Freshdesk account. Do not use this URL in any communications to the person submitting the ticket. | Actions |
HTTP
| Variable | Name | Description | Usage |
|---|---|---|---|
#post_var("key") | Post Key Value | Returns the value of the supplied POST key. | Actions |
#query_var("parameter", "default_value") | Query String Parameter Value | Returns the value of the supplied query string parameter. | Client-side & Actions |
#request_url | Request URL | Returns the current request URL. | Client-side & Actions |
Hash
| Variable | Name | Description | Usage |
|---|---|---|---|
#hash_md5("string") | MD5 | Returns the MD5 hash of the input string. Server-side only. | Actions |
#hash_sha256("string") | SHA-256 | Returns the SHA-256 hash of the input string. Server-side only. | Actions |
InstaWP
| Variable | Name | Description | Usage |
|---|---|---|---|
#instawp_site_id | Site ID | Returns the ID of the site created. | Actions |
#instawp_site_password | Site password | Returns the administrator password of the site created. | Actions |
#instawp_site_url | Site URL | Returns the URL of the site created. | Actions |
#instawp_site_url_auto_login | Site Auto Login URL | Returns the auto login URL of the site created. | Actions |
#instawp_site_username | Site username | Returns the administrator username of the site created. | Actions |
Local Storage
| Variable | Name | Description | Usage |
|---|---|---|---|
#local_storage_get("key") | Get local storage key value | Returns the value of a local storage key. For more information about this variable, click here. | Client-side |
Math
| Variable | Name | Description | Usage |
|---|---|---|---|
#abs(number) | Absolute | Returns the absolute value of a number. For more information about this variable, click here. | Client-side |
#acos(number) | Inverse Cosine | Returns the inverse cosine of a number in radians. For more information about this variable, click here. | Client-side |
#asin(number) | Inverse Sine | Returns the inverse sine of a number in radians. For more information about this variable, click here. | Client-side |
#atan(number) | Inverse Tangent | Returns the inverse tangent of a number in radians. For more information about this variable, click here. | Client-side |
#avg(number) | Average | Returns the average of all the input numbers. For more information about this variable, click here. | Client-side |
#ceil(number) | Ceiling | Rounds a number up to the next largest whole number. For more information about this variable, click here. | Client-side |
#cos(radians) | Cosine | Returns the cosine of a radian number. For more information about this variable, click here. | Client-side |
#exp(number) | Euler's | Returns E to the power of a number. For more information about this variable, click here. | Client-side |
#floor(number) | Floor | Returns the largest integer value that is less than or equal to a number. For more information about this variable, click here. | Client-side |
#log(number) | Logarithm | Returns the natural logarithm of a number. For more information about this variable, click here. | Client-side |
#max(number) | Maximum | Returns the maxiumum value of the supplied numbers. For more information about this variable, click here. | Client-side |
#min(number) | Minimum | Returns the lowest value of the supplied numbers. For more information about this variable, click here. | Client-side |
#negative(number) | Negative | Returns 0 if positive, or original value if negative. For more information about this variable, click here. | Client-side |
#pi | PI | Returns an approximate value of PI. For more information about this variable, click here. | Client-side |
#positive(number) | Positive | Returns 0 if negative, or original value if positive. For more information about this variable, click here. | Client-side |
#pow(base, exponent) | Base to the Exponent Power | Returns the base to the exponent power. For more information about this variable, click here. | Client-side |
#round(number, decimals) | Round | Returns the rounded value of a number. For more information about this variable, click here. | Client-side |
#sin(radians) | Sine | Returns the sine of a radian number. For more information about this variable, click here. | Client-side |
#sqrt(number) | Square Root | Returns the square root of the number. For more information about this variable, click here. | Client-side |
#tan(radians) | Tangent | Returns the tangent of a radian number. For more information about this variable, click here. | Client-side |
Number
| Variable | Name | Description | Usage |
|---|---|---|---|
#number_format(number, decimals, "decimal_separator", "thousand_separator") | Format Number | Returns a number with grouped thousands. Same as the PHP number_format function. | Client-side & Actions |
OpenAI
| Variable | Name | Description | Usage |
|---|---|---|---|
#openai_completion_tokens | Output | Returns the completion token count from OpenAI. | Actions |
#openai_input | Input | Returns the input for OpenAI. | Actions |
#openai_mode | Output | Returns the OpenAI mode. | Actions |
#openai_output | Output | Returns the output from OpenAI. | Actions |
#openai_prompt_tokens | Prompt Tokens | Returns the prompt token count from OpenAI. | Actions |
#openai_total_tokens | Output | Returns the total token count from OpenAI. | Actions |
Option
| Variable | Name | Description | Usage |
|---|---|---|---|
#option_get("option_name", "parameter/key") | Get Option | Returns an option value by option name. If the option value is an object or array you can specify the object parameter or array key to return. e.g. #option_get("my_setting_page_key", "email") | Actions |
| Variable | Name | Description | Usage |
|---|---|---|---|
#pdf_link | PDF Link (Download) | Returns a 'Download PDF' link to the PDF. | Actions |
#pdf_link_view | PDF Link (View) | Returns a 'View PDF' link to the PDF. | Actions |
#pdf_url | PDF URL (Download) | Returns the URL to the PDF. URL downloads the PDF. | Actions |
#pdf_url_view | PDF URL (View) | Returns the URL to the PDF. URL shows the PDF in the browser. | Actions |
Post
| Variable | Name | Description | Usage |
|---|---|---|---|
#post_content | Content | Returns the post content. | Actions |
#post_date | Date Created | Returns the post date according to the Date Format setting found in WordPress Settings > General. | Client-side & Actions |
#post_date_custom("format", seconds_offset) | Date / Time Created - Custom | Returns the post creation date and time in the specified format (PHP date format). For more information about this variable, click here. | Client-side & Actions |
#post_date_modified | Date Modified | Returns the post modified date according to the Date Format setting found in WordPress Settings > General. | Client-side & Actions |
#post_date_modified_custom("format", seconds_offset) | Date / Time Modified - Custom | Returns the post modified date and time in the specified format (PHP date format). For more information about this variable, click here. | Client-side & Actions |
#post_excerpt | Excerpt | Returns the post excerpt. | Actions |
#post_id | ID | Returns the post ID. | Client-side & Actions |
#post_meta("key") | Meta Value | Returns the post meta value for the key specified. | Client-side & Actions |
#post_name | Slug | Returns the post slug. | Client-side & Actions |
#post_parent | Parent ID | Returns the post parent ID. | Client-side & Actions |
#post_status | Status | Returns the post status. | Client-side & Actions |
#post_time | Time Created | Returns the post creation time according to the Time Format setting found in WordPress Settings > General. | Client-side & Actions |
#post_time_modified | Time Modified | Returns the post modified time according to the Time Format setting found in WordPress Settings > General. | Client-side & Actions |
#post_title | Title | Returns the post title. | Client-side & Actions |
#post_type | Type | Returns the post type. | Client-side & Actions |
#post_url | Public URL | Returns the post URL. | Client-side & Actions |
#post_url_edit | Admin URL | Returns the post admin URL. | Client-side & Actions |
Progress
| Variable | Name | Description | Usage |
|---|---|---|---|
#progress | Number (0 to 100) | Returns the progress as number from 0 to 100. For more information about this variable, click here. | |
#progress_percent | Percent (0% to 100%) | Returns the progress as a percentage from 0% to 100%. For more information about this variable, click here. | |
#progress_remaining | Number Remaining (100 to 0) | Returns the remainig progress as number from 0 to 100. For more information about this variable, click here. | |
#progress_remaining_percent | Percent Remaining (100% to 0%) | Returns the remaining progress as a percentage from 0% to 100%. For more information about this variable, click here. |
Radio
| Variable | Name | Description | Usage |
|---|---|---|---|
#radio_label(field_id) | Radio Label | Use this variable to insert the label of a radio field on your form. For example: #radio_label(123) where '123' is the field ID shown in the layout editor. For more information about this variable, click here. | Client-side |
Random Numbers
| Variable | Name | Description | Usage |
|---|---|---|---|
#random_number(min, max) | Random Number | Outputs an integer between the specified minimum and maximum attributes. This function does not generate cryptographically secure values, and should not be used for cryptographic purposes. For more information about this variable, click here. | Client-side & Actions |
Random Strings
| Variable | Name | Description | Usage |
|---|---|---|---|
#random_string(length, "characters") | Random String | Outputs a string of random characters. Use the length attribute to control how long the string is and use the characters attribute to control which characters are randomly selected. This function does not generate cryptographically secure values, and should not be used for cryptographic purposes. For more information about this variable, click here. | Client-side & Actions |
Search
| Variable | Name | Description | Usage |
|---|---|---|---|
#search_query | Query | Returns the search query. | Client-side & Actions |
Seconds
| Variable | Name | Description | Usage |
|---|---|---|---|
#seconds_day | Seconds in a day | Returns the number of seconds in a day. For more information about this variable, click here. | Client-side & Actions |
#seconds_epoch | Seconds since Epoch | Returns the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT). For more information about this variable, click here. | Client-side & Actions |
#seconds_epoch_midnight | Seconds since Epoch at midnight | Returns the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) to the closest previous midnight. For more information about this variable, click here. | Client-side |
#seconds_hour | Seconds in an hour | Returns the number of seconds in an hour. For more information about this variable, click here. | Client-side & Actions |
#seconds_minute | Seconds in a minute | Returns the number of seconds in a minute. For more information about this variable, click here. | Client-side & Actions |
#seconds_week | Seconds in a week | Returns the number of seconds in a week. For more information about this variable, click here. | Client-side & Actions |
#seconds_year | Seconds in a year | Returns the number of seconds in a common year. For more information about this variable, click here. | Client-side & Actions |
Section
| Variable | Name | Description | Usage |
|---|---|---|---|
#section_label("section_id") | Section Label | Returns the section label. For more information about this variable, click here. | Client-side & Actions |
#section_row_count("section_id") | Section Row Count | Returns the total number of rows in a repeatable section. For more information about this variable, click here. | Client-side |
#section_row_index | Section Row Index | Returns the row index in a repeatable section. For more information about this variable, click here. | Client-side |
#section_row_number | Section Row Number | Returns the row number in a repeatable section. For more information about this variable, click here. | Client-side |
Section Rows
| Variable | Name | Description | Usage |
|---|---|---|---|
#section_rows_end | Section Rows End | Defines the end point for looping through repeatable section rows. For more information about this variable, click here. | Client-side & Actions |
#section_rows_start("section_id") | Start Rows Start | Defines the start point for looping through repeatable section rows. For more information about this variable, click here. | Client-side & Actions |
Select
| Variable | Name | Description | Usage |
|---|---|---|---|
#select_count(field_id) | Select Count | Use this variable to return the number of options that have been selected in a select field. For example: #select_count(123) where '123' is the field ID shown in the layout editor. Use #text(#select_count(123)) to keep the value dynamically updated. For more information about this variable, click here. | Client-side |
#select_count_total(field_id) | Select Total Count | Use this variable to return the total number of options in a select field. For example: #select_count_total(123) where '123' is the field ID shown in the layout editor. Use #text(#select_count_total(123)) to keep the value dynamically updated. For more information about this variable, click here. | Client-side |
#select_option_text(field_id, "delimiter") | Select Option Text | Use this variable to insert the selected option text of a select field on your form. For example: #select_option_text(123) where '123' is the field ID shown in the layout editor. For more information about this variable, click here. | Client-side |
Server
| Variable | Name | Description | Usage |
|---|---|---|---|
#server_date | Current Date | Returns the server date according to the Date Format setting found in WordPress Settings > General. For more information about this variable, click here. | Actions |
#server_date_custom("format", seconds_offset) | Custom Date | Returns the server date and time in the specified format (PHP date format). For more information about this variable, click here. | Actions |
#server_time | Current Time | Returns the server time according to the Date Format setting found in WordPress Settings > General. For more information about this variable, click here. | Actions |
Session Storage
| Variable | Name | Description | Usage |
|---|---|---|---|
#session_storage_get("key") | Get session storage key value | Returns the value of a session storage key. For more information about this variable, click here. | Client-side |
Skin
| Variable | Name | Description | Usage |
|---|---|---|---|
#skin_border_radius | Border - Radius | For more information about this variable, click here. | Client-side & Actions |
#skin_border_style | Border - Style | For more information about this variable, click here. | Client-side & Actions |
#skin_border_width | Border - Width | For more information about this variable, click here. | Client-side & Actions |
#skin_box_shadow_width | Box Shadow - Width | For more information about this variable, click here. | Client-side & Actions |
#skin_color_danger | Color - Danger | For more information about this variable, click here. | Client-side & Actions |
#skin_color_default | Color - Default | For more information about this variable, click here. | Client-side & Actions |
#skin_color_default_inverted | Color - Default (Inverted) | For more information about this variable, click here. | Client-side & Actions |
#skin_color_default_light | Color - Default (Light) | For more information about this variable, click here. | Client-side & Actions |
#skin_color_default_lighter | Color - Default (Lighter) | For more information about this variable, click here. | Client-side & Actions |
#skin_color_default_lightest | Color - Default (Lightest) | For more information about this variable, click here. | Client-side & Actions |
#skin_color_information | Color - Information | For more information about this variable, click here. | Client-side & Actions |
#skin_color_primary | Color - Primary | For more information about this variable, click here. | Client-side & Actions |
#skin_color_secondary | Color - Secondary | For more information about this variable, click here. | Client-side & Actions |
#skin_color_success | Color - Success | For more information about this variable, click here. | Client-side & Actions |
#skin_color_warning | Color - Warning | For more information about this variable, click here. | Client-side & Actions |
#skin_font_family | Font - Family | For more information about this variable, click here. | Client-side & Actions |
#skin_font_size | Font - Size | For more information about this variable, click here. | Client-side & Actions |
#skin_font_size_large | Font - Size (Large) | For more information about this variable, click here. | Client-side & Actions |
#skin_font_size_small | Font - Size (Small) | For more information about this variable, click here. | Client-side & Actions |
#skin_font_weight | Font - Weight | For more information about this variable, click here. | Client-side & Actions |
#skin_line_height | Line Height | For more information about this variable, click here. | Client-side & Actions |
String
| Variable | Name | Description | Usage |
|---|---|---|---|
#capitalize("string") | Capitalize a string | Returns the capitalized version of an input string. For more information about this variable, click here. | Client-side & Actions |
#lower("string") | Lowercase | Returns the lowercase version of the input string. For more information about this variable, click here. | Client-side & Actions |
#name_first("string") | Return the first name | Returns the first name from a full name. For more information about this variable, click here. | Client-side & Actions |
#name_last("string") | Return the last name | Returns the last name from a full name. For more information about this variable, click here. | Client-side & Actions |
#name_middle("string") | Return the middle name | Returns the middle name from a full name. For more information about this variable, click here. | Client-side & Actions |
#name_prefix("string") | Return the name prefix | Returns the prefix from a full name. For more information about this variable, click here. | Client-side & Actions |
#name_suffix("string") | Return the name suffix | Returns the suffix from a full name. For more information about this variable, click here. | Client-side & Actions |
#sentence("string") | Sentence case a string | Returns the sentence cased version of an input string. For more information about this variable, click here. | Client-side & Actions |
#slug("string") | Convert a string to a slug | Returns the string as a slug suitable for URLs. For more information about this variable, click here. | Client-side & Actions |
#trim("string") | Trim a string | Returns the trimmed string. For more information about this variable, click here. | Client-side & Actions |
#ucfirst("string") | Uppercase first letter | Returns the uppercase first letter version of the input string. For more information about this variable, click here. | Client-side & Actions |
#ucwords("string") | Uppercase words | Returns the uppercase words version of the input string. For more information about this variable, click here. | Client-side & Actions |
#upper("string") | Uppercase | Returns the uppercase version of the input string. For more information about this variable, click here. | Client-side & Actions |
#wpautop("string") | Apply wpautop to a string | Returns the string with wpautop applied to it. For more information about this variable, click here. | Client-side & Actions |
Stripe Elements
| Variable | Name | Description | Usage |
|---|---|---|---|
#stripe_customer_id | Customer ID | Returns the customer ID used or created during the transaction. | Actions |
#stripe_subscription_id | Subscription ID | Returns the subscription ID for subscription transactions. | Actions |
#stripe_transaction_id | Transaction ID | Returns the transaction ID for one-time transactions. | Actions |
Submission
| Variable | Name | Description | Usage |
|---|---|---|---|
#submit_admin_link | Admin Link | Link to submission in WordPress admin. For more information about this variable, click here. | Actions |
#submit_admin_url | Admin URL | URL to submission in WordPress admin. For more information about this variable, click here. | Actions |
#submit_date_added | Date Added | Returns the date and time of the submission according to the Date Format setting found in WordPress Settings > General. For more information about this variable, click here. | Actions |
#submit_date_added_custom("format") | Date Added Custom | Returns the submit date and time in the specified format (PHP date format). For more information about this variable, click here. | Actions |
#submit_hash | Hash | Returns the anonymized hash ID of the submission. For more information about this variable, click here. | Actions |
#submit_id | ID | Returns the ID of the submission. For more information about this variable, click here. | Actions |
#submit_link | Link | Link to recall form with submission loaded. Used in conjunction with the 'Save' button. For more information about this variable, click here. | Actions |
#submit_status | Status | draft = In Progress, publish = Submitted, error = Error, spam = Spam, trash = Trash. For more information about this variable, click here. | Actions |
#submit_status_label | Status Label | Returns a nice version of the submission status. For more information about this variable, click here. | Actions |
#submit_url | URL | URL to recall form with submission loaded. Used in conjunction with the 'Save' button. For more information about this variable, click here. | Actions |
#submit_user_id | User ID | Returns the ID of the user who completed the form. For more information about this variable, click here. | Actions |
Tab
| Variable | Name | Description | Usage |
|---|---|---|---|
#tab_label(tab_id) | Tab Label | Returns the tab label by ID. For more information about this variable, click here. | Client-side & Actions |
Text
| Variable | Name | Description | Usage |
|---|---|---|---|
#text(content) | Text | Keep the content dynamically update. For more information about this variable, click here. | Client-side |
Tracking
| Variable | Name | Description | Usage |
|---|---|---|---|
#tracking_agent | Agent | Stores the website visitors agent (browser type). For more information about this variable, click here. | Client-side & Actions |
#tracking_duration | Duration | Stores the duration it took to complete the form in seconds. For more information about this variable, click here. | Actions |
#tracking_geo_location | Location (By browser) | If a website visitors device supports geo location (GPS) this option will prompt and request permission for that data and store the latitude and longitude to a submission. For more information about this variable, click here. | Actions |
#tracking_hash | URL Hash | Hash of the URL. For more information about this variable, click here. | Client-side & Actions |
#tracking_host | URL Hostname | Hostname of the URL. For more information about this variable, click here. | Client-side & Actions |
#tracking_ip_lookup_city | City (By IP) | If checked, WS Form will perform an IP lookup and obtain the city located closest to their approximate location. For more information about this variable, click here. | Actions |
#tracking_ip_lookup_country | Country (By IP) | If checked, WS Form will perform an IP lookup and obtain the country located closest to their approximate location. For more information about this variable, click here. | Actions |
#tracking_ip_lookup_latlon | Location (By IP) | This will obtain an approximate latitude and longitude of a website visitor by their IP address. For more information about this variable, click here. | Actions |
#tracking_ip_lookup_region | Region (By IP) | If checked, WS Form will perform an IP lookup and obtain the region located closest to their approximate location. For more information about this variable, click here. | Actions |
#tracking_ip_lookup_time_zone | Time Zone (By IP) | If checked, WS Form will perform an IP lookup and obtain the time zone closest to their approximate location. For more information about this variable, click here. | Actions |
#tracking_os | Operating System | Stores the website visitors operating system. For more information about this variable, click here. | Client-side & Actions |
#tracking_pathname | URL Pathname | Pathname of the URL. For more information about this variable, click here. | Client-side & Actions |
#tracking_query_string | URL Query String | Query string of the URL. For more information about this variable, click here. | Client-side & Actions |
#tracking_referrer | Referrer | Stores the web page address a website visitor was on prior to completing the submitted form. For more information about this variable, click here. | Client-side & Actions |
#tracking_remote_ip | Remote IP Address | Stores the website visitors remote IP address, e.g. 123.45.67.89 For more information about this variable, click here. | Actions |
#tracking_url | URL Full | Full URL. For more information about this variable, click here. | Client-side & Actions |
#tracking_utm_campaign | UTM Campaign | This can be used to store the UTM (Urchin Tracking Module) campaign parameter. For more information about this variable, click here. | Client-side & Actions |
#tracking_utm_content | UTM Content | This can be used to store the UTM (Urchin Tracking Module) content parameter. For more information about this variable, click here. | Client-side & Actions |
#tracking_utm_medium | UTM Medium | This can be used to store the UTM (Urchin Tracking Module) medium parameter. For more information about this variable, click here. | Client-side & Actions |
#tracking_utm_source | UTM Source | This can be used to store the UTM (Urchin Tracking Module) source parameter. For more information about this variable, click here. | Client-side & Actions |
#tracking_utm_term | UTM Term | This can be used to store the UTM (Urchin Tracking Module) term parameter. For more information about this variable, click here. | Client-side & Actions |
URL
| Variable | Name | Description | Usage |
|---|---|---|---|
#url_login | Login | Returns the login URL. | Actions |
#url_logout | Logout | Returns the logout URL. | Actions |
#url_lost_password | Lost Password | Returns the lost password URL. | Actions |
#url_register | Register | Returns the register URL. | Actions |
User
| Variable | Name | Description | Usage |
|---|---|---|---|
#user_admin_color | Admin Color | Returns the user admin color if logged in. | Client-side & Actions |
#user_bio | Bio | Returns the user biography if logged in. | Client-side & Actions |
#user_display_name | Display Name | Returns the user display name if logged in. | Client-side & Actions |
#user_email | Returns the user email address if logged in. | Client-side & Actions | |
#user_first_name | First Name | Returns the user first name if logged in. | Client-side & Actions |
#user_full_name | Full Name | Returns the user full name if logged in. | Client-side & Actions |
#user_id | ID | Returns the user ID if logged in. | Client-side & Actions |
#user_last_name | Last Name | Returns the user last name if logged in. | Client-side & Actions |
#user_login | Login | Returns the user ID if logged in. | Client-side & Actions |
#user_lost_password_key | Lost Password Key | Returns the user lost password key. | Client-side & Actions |
#user_lost_password_url("path") | Lost Password URL | Returns the user lost password URL. | Actions |
#user_meta("meta_key") | Meta Value | Returns the user meta value for the key specified. | Client-side & Actions |
#user_nicename | Nice Name | Returns the user nicename if logged in. | Client-side & Actions |
#user_nickname | Nickname | Returns the user nickname if logged in. | Client-side & Actions |
#user_registered | Registration Date | Returns the user registration date if logged in. | Client-side & Actions |
#user_url | URL | Returns the user URL if logged in. | Client-side & Actions |
Word
| Variable | Name | Description | Usage |
|---|---|---|---|
#word_count | Count | Returns the total word count. For more information about this variable, click here. | |
#word_count_label | Count Label | Returns 'word' or 'words' depending on the word count. For more information about this variable, click here. | |
#word_max | Maximum | Returns the maximum word length that you set for a field. For more information about this variable, click here. | |
#word_max_label | Maximum Label | Returns 'word' or 'words' depending on the maximum word length. For more information about this variable, click here. | |
#word_min | Minimum | Returns the minimum word length that you set for a field. For more information about this variable, click here. | |
#word_min_label | Minimum Label | Returns 'word' or 'words' depending on the minimum word length. For more information about this variable, click here. | |
#word_remaining | Count Remaining | If you set a maximum word length for a field, this will show the total remaining word count. For more information about this variable, click here. | |
#word_remaining_label | Count Remaining Label | If you set a maximum word length for a field, this will show the total remaining word count. For more information about this variable, click here. |
Zendesk
| Variable | Name | Description | Usage |
|---|---|---|---|
#zendesk_ticket_id | Ticket ID | Returns the ID of the created ticket. | Actions |
#zendesk_ticket_url | Ticket URL | Returns the URL of the created ticket in your Zendesk account. Do not use this URL in any communications to the person submitting the ticket. | Actions |
Keywords: merge tags