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
- E-Commerce
- Field
- Form
- Freshdesk
- InstaWP
- Local Storage
- Math
- Number
- OpenAI
- Post
- Post Variable (POST request)
- Progress
- Query Variable (GET request)
- Radio
- Random Numbers
- Random Strings
- Request
- Search
- Seconds
- Section
- Section Rows
- Select
- Server
- Session Storage
- Skin
- String
- Stripe Elements
- Submission
- Tab
- Text
- Tracking
- URL
- User
- Word
- Zendesk
Blog
Name / Variable | Additional Information |
---|---|
Admin Email#blog_admin_email | |
Character Set#blog_charset | |
Current Date#blog_date | Returns the blog date in the format configured in WordPress. |
Current Time#blog_time | Returns the blog time in the format configured in WordPress. |
Custom Date#blog_date_custom(format, seconds_offset) | Returns the blog date and time in a specified format (PHP date format). For more information about this variable, click here. |
Language#blog_language | |
Name#blog_name | |
URL#blog_url |
Calculation
Name / Variable | Additional Information |
---|---|
Calculation#calc(calculation) | Calculated value. |
Character
Name / Variable | Additional Information |
---|---|
Count#character_count | The total character count. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Count Label#character_count_label | Shows 'character' or 'characters' depending on the character count. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Count Remaining#character_remaining | If you set a maximum character length for a field, this will show the total remaining character count. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Count Remaining Label#character_remaining_label | If you set a maximum character length for a field, this will show the total remaining character count. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Maximum#character_max | Shows the maximum character length that you set for a field. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Maximum Label#character_max_label | Shows 'character' or 'characters' depending on the maximum character length. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Minimum#character_min | Shows the minimum character length that you set for a field. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Minimum Label#character_min_label | Shows 'character' or 'characters' depending on the minimum character length. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Checkbox
Name / Variable | Additional Information |
---|---|
Checkbox Count#checkbox_count(id) | Use this variable to return the number of checkboxes that have been checked for a field. For example: #checkbox_count(123) where '123' is the field ID shown in the layout editor. This variable can only be used in client-side. |
Checkbox Label#checkbox_label(id, delimiter) | 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. This variable can only be used in client-side. |
Client
Name / Variable | Additional Information |
---|---|
Current Date#client_date | Returns the users web browser local date in the format configured in WordPress. This variable can only be used in client-side. |
Current Time#client_time | Returns the users web browser local time in the format configured in WordPress. This variable can only be used in client-side. |
Custom Date#client_date_custom(format, seconds_offset) | Returns the users web browser local date and time in a specified format (PHP date format). For more information about this variable, click here. This variable can only be used in client-side. |
Conditional
Name / Variable | Additional Information |
---|---|
End of IF condition.#endif | |
Start of IF condition.#if(condition) |
Data Grid Rows
Name / Variable | Additional Information |
---|---|
Action Variable Column#data_grid_row_action_variable | Use this variable within a data grid row to insert the text found in the action variable column. This variable can only be used within a data grid row. |
Label Column#data_grid_row_label | Use this variable within a data grid row to insert the text found in the label column. This variable can only be used within a data grid row. |
Price Column#data_grid_row_price | Use this variable within a data grid row to insert the text found in the price column. This variable can only be used within a data grid row. |
Price Column (With Currency)#data_grid_row_price_currency | Use this variable within a data grid row to insert the text found in the price column formatted using the currency settings. This variable can only be used within a data grid row. |
Value Column#data_grid_row_value | Use this variable within a data grid row to insert the text found in the value column. This variable can only be used within a data grid row. |
WooCommerce Cart Column#data_grid_row_wocommerce_Cart | Use this variable within a data grid row to insert the text found in the WooCommerce cart column. This variable can only be used within a data grid row. |
E-Commerce
Name / Variable | Additional Information |
---|---|
Currency Symbol#ecommerce_currency_symbol | Use this variable to show the current currency symbol. |
Discount#ecommerce_cart_discount | Excludes currency symbol. Use this in conditional logic or email templates. |
Discount (Currency)#ecommerce_cart_discount_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Discount (Span Currency)#ecommerce_cart_discount_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Discount (Span)#ecommerce_cart_discount_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Field Value as Price#ecommerce_field_price(id) | 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 |
Gift Wrap#ecommerce_cart_gift_wrap | Excludes currency symbol. Use this in conditional logic or email templates. |
Gift Wrap (Currency)#ecommerce_cart_gift_wrap_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Gift Wrap (Span Currency)#ecommerce_cart_gift_wrap_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Gift Wrap (Span)#ecommerce_cart_gift_wrap_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Handling Fee#ecommerce_cart_handling_fee | Excludes currency symbol. Use this in conditional logic or email templates. |
Handling Fee (Currency)#ecommerce_cart_handling_fee_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Handling Fee (Span Currency)#ecommerce_cart_handling_fee_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Handling Fee (Span)#ecommerce_cart_handling_fee_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Insurance#ecommerce_cart_insurance | Excludes currency symbol. Use this in conditional logic or email templates. |
Insurance (Currency)#ecommerce_cart_insurance_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Insurance (Span Currency)#ecommerce_cart_insurance_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Insurance (Span)#ecommerce_cart_insurance_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Order Status#ecommerce_status | Excludes currency symbol. Use this in conditional logic or email templates. |
Other#ecommerce_cart_other | Excludes currency symbol. Use this in conditional logic or email templates. |
Other (Currency)#ecommerce_cart_other_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Other (Span Currency)#ecommerce_cart_other_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Other (Span)#ecommerce_cart_other_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Payment Method#ecommerce_payment_method | Excludes currency symbol. Use this in conditional logic or email templates. |
Shipping#ecommerce_cart_shipping | Excludes currency symbol. Use this in conditional logic or email templates. |
Shipping (Currency)#ecommerce_cart_shipping_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Shipping (Span Currency)#ecommerce_cart_shipping_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Shipping (Span)#ecommerce_cart_shipping_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Shipping Discount#ecommerce_cart_shipping_discount | Excludes currency symbol. Use this in conditional logic or email templates. |
Shipping Discount (Currency)#ecommerce_cart_shipping_discount_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Shipping Discount (Span Currency)#ecommerce_cart_shipping_discount_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Shipping Discount (Span)#ecommerce_cart_shipping_discount_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Subtotal#ecommerce_cart_subtotal | Excludes currency symbol. Use this in conditional logic or email templates. |
Subtotal (Currency)#ecommerce_cart_subtotal_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Subtotal (Span Currency)#ecommerce_cart_subtotal_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Subtotal (Span)#ecommerce_cart_subtotal_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Tax#ecommerce_cart_tax | Excludes currency symbol. Use this in conditional logic or email templates. |
Tax (Currency)#ecommerce_cart_tax_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Tax (Span Currency)#ecommerce_cart_tax_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Tax (Span)#ecommerce_cart_tax_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Total#ecommerce_cart_total | Excludes currency symbol. Use this in conditional logic or email templates. |
Total (Currency)#ecommerce_cart_total_currency | Includes currency symbol. Use this in conditional logic or email templates. |
Total (Span Currency)#ecommerce_cart_total_span_currency | Includes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Total (Span)#ecommerce_cart_total_span | Excludes currency symbol. This variable outputs a span that can be used in Text Editor or HTML fields. |
Transaction ID#ecommerce_transaction_id | Excludes currency symbol. Use this in conditional logic or email templates. |
Value as Price#ecommerce_price(number) | Convert the number input to a price that matches the configured e-commerce currency settings. An example output might be: $123.00 |
Name / Variable | Additional Information |
---|---|
Character set#email_charset | For more information about this variable, click here. This variable can only be used in the Send Email action. |
Content type#email_content_type | For more information about this variable, click here. This variable can only be used in the Send Email action. |
E-Commerce Values#email_ecommerce | This variable outputs a list of the e-commerce transaction details such as total, transaction ID and status fields. For more information about this variable, click here. This variable can only be used in the Send Email action. |
Logo#email_logo | For more information about this variable, click here. This variable can only be used in the Send Email action. |
Subject#email_subject | For more information about this variable, click here. This variable can only be used in the Send Email action. |
Submitted Fields#email_submission(tab_labels, section_labels, field_labels, blank_fields, static_fields) | This variable outputs 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. This variable can only be used in the Send Email action. |
Tracking data#email_tracking | For more information about this variable, click here. This variable can only be used in the Send Email action. |
Field
Name / Variable | Additional Information |
---|---|
Field Date Adjusted by Offset in Seconds#field_date_offset(id, seconds_offset, format) | Return a date adjusted by an offset in seconds. |
Field Date Formatted#field_date_format(id, format) | Return a field formatted according to the PHP date function. This variable can only be used in client-side. |
Field Label#field_label(id) | Returns the field label by ID. |
Field Value#field(id, delimiter, column) | 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). |
Field Value as Floating Point Number#field_float(id) | 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 |
Form
Name / Variable | Additional Information |
---|---|
Checksum#form_checksum | |
DOM Selector ID#form_obj_id | |
Framework#form_framework | |
ID#form_id | |
Instance ID#form_instance_id | |
Label#form_label |
Freshdesk
Name / Variable | Additional Information |
---|---|
Ticket ID#freshdesk_ticket_id | Returns the ID of the created ticket. |
Ticket URL#freshdesk_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. |
InstaWP
Name / Variable | Additional Information |
---|---|
Site Auto Login URL#instawp_site_url_auto_login | Returns the auto login URL of the site created. |
Site ID#instawp_site_id | Returns the ID of the site created. |
Site URL#instawp_site_url | Returns the URL of the site created. |
Site password#instawp_site_password | Returns the administrator password of the site created. |
Site username#instawp_site_username | Returns the administrator username of the site created. |
Local Storage
Name / Variable | Additional Information |
---|---|
Get local storage key value#local_storage_get(key) | Returns the value of a local storage key. |
Math
Name / Variable | Additional Information |
---|---|
Absolute#abs(number) | Returns the absolute value of a number. |
Average#avg(number) | Returns the average of all the input numbers. |
Base to the Exponent Power#pow(base, exponent) | Returns the base to the exponent power. |
Ceiling#ceil(number) | Rounds a number up to the next largest whole number. |
Cosine#cos(radians) | Returns the cosine of a radian number. |
Euler's#exp(number) | Returns E to the power of a number. |
Floor#floor(number) | Returns the largest integer value that is less than or equal to a number. |
Logarithm#log(number) | Returns the natural logarithm of a number. |
Maximum#max(number) | Returns the maxiumum value of the supplied numbers. |
Minimum#min(number) | Returns the lowest value of the supplied numbers. |
Negative#negative(number) | Returns 0 if positive, or original value if negative. |
PI#pi | Returns an approximate value of PI. |
Positive#positive(number) | Returns 0 if negative, or original value if positive. |
Round#round(number, decimals) | Returns the rounded value of a number. |
Sine#sin(radians) | Returns the sine of a radian number. |
Square Root#sqrt(number) | Returns the square root of the number. |
Tangent#tan(radians) | Returns the tangent of a radian number. |
Number
Name / Variable | Additional Information |
---|---|
Format Number#number_format(number, decimals, decimal_separator, thousand_separator) | Returns a number with grouped thousands. Same as the PHP number_format function. |
OpenAI
Name / Variable | Additional Information |
---|---|
Input#openai_input | Returns the input to OpenAI. |
Output#openai_mode | Returns the OpenAI mode. |
Output#openai_output | Returns the output from OpenAI. |
Output#openai_completion_tokens | Returns the completion token count from OpenAI. |
Output#openai_total_tokens | Returns the total token count from OpenAI. |
Prompt Tokens#openai_prompt_tokens | Returns the prompt token count from OpenAI. |
Name / Variable | Additional Information |
---|---|
PDF Link (Download)#pdf_link | Returns a 'Download PDF' link to the PDF. |
PDF Link (View)#pdf_link_view | Returns a 'View PDF' link to the PDF. |
PDF URL (Download)#pdf_url | Returns the URL to the PDF. URL downloads the PDF. |
PDF URL (View)#pdf_url_view | Returns the URL to the PDF. URL shows the PDF in the browser. |
Post
Name / Variable | Additional Information |
---|---|
Admin URL#post_url_edit | |
Content#post_content | |
Date#post_date | |
Excerpt#post_excerpt | |
ID#post_id | |
Meta Value#post_meta(key) | Returns the post meta value for the key specified. |
Post Custom Date#post_date_custom(format, seconds_offset) | For more information about this variable, click here. |
Public URL#post_url | |
Slug#post_name | |
Status#post_status | |
Time#post_time | |
Title#post_title | |
Type#post_type |
Post Variable (POST request)
Name / Variable | Additional Information |
---|---|
Post Variable#post_var(variable) |
Progress
Name / Variable | Additional Information |
---|---|
Number (0 to 100)#progress | For more information about this variable, click here. This variable can only be used in the Help setting for Progress fields. |
Number Remaining (100 to 0)#progress_remaining | For more information about this variable, click here. This variable can only be used in the Help setting for Progress fields. |
Percent (0% to 100%)#progress_percent | For more information about this variable, click here. This variable can only be used in the Help setting for Progress fields. |
Percent Remaining (100% to 0%)#progress_remaining_percent | For more information about this variable, click here. This variable can only be used in the Help setting for Progress fields. |
Query Variable (GET request)
Name / Variable | Additional Information |
---|---|
Query Variable#query_var(variable) |
Radio
Name / Variable | Additional Information |
---|---|
Radio Label#radio_label(id, delimiter) | 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. This variable can only be used in client-side. |
Random Numbers
Name / Variable | Additional Information |
---|---|
Random Number#random_number(min, max) | 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. |
Random Strings
Name / Variable | Additional Information |
---|---|
Random String#random_string(length, characters) | 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. |
Request
Name / Variable | Additional Information |
---|---|
Request URL#request_url |
Search
Name / Variable | Additional Information |
---|---|
Query#search_query |
Seconds
Name / Variable | Additional Information |
---|---|
Seconds in a day#seconds_day | Returns the number of seconds in a day. |
Seconds in a minute#seconds_minute | Returns the number of seconds in a minute. |
Seconds in a week#seconds_week | Returns the number of seconds in a week. |
Seconds in a year#seconds_year | Returns the number of seconds in a common year. |
Seconds in an hour#seconds_hour | Returns the number of seconds in an hour. |
Seconds since Epoch#seconds_epoch | Returns the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT). |
Seconds since Epoch at midnight#seconds_epoch_midnight | Returns the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) to the closest previous midnight. This variable can only be used in client-side. |
Section
Name / Variable | Additional Information |
---|---|
Section Label#section_label(id) | Returns the section label by ID. |
Section Row Count#section_row_count(id) | This variable returns the total number of rows in a repeatable section. |
Section Row Index#section_row_index | This variable returns the row index in a repeatable section. |
Section Row Number#section_row_number | This variable returns the row number in a repeatable section. |
Section Rows
Name / Variable | Additional Information |
---|---|
Section Rows End#section_rows_end | Define the end point for looping through repeatable section rows. |
Start Rows Start#section_rows_start(id) | Define the start point for looping through repeatable section rows. |
Select
Name / Variable | Additional Information |
---|---|
Select Count#select_count(id) | Use this variable to return the number of options that have been selected for a field. For example: #select_count(123) where '123' is the field ID shown in the layout editor. This variable can only be used in client-side. |
Select Option Text#select_option_text(id, delimiter) | 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. This variable can only be used in client-side. |
Server
Name / Variable | Additional Information |
---|---|
Current Date#server_date | Returns the server date in the format configured in WordPress. |
Current Time#server_time | Returns the server time in the format configured in WordPress. |
Custom Date#server_date_custom(format, seconds_offset) | Returns the server date and time in a specified format (PHP date format). For more information about this variable, click here. |
Session Storage
Name / Variable | Additional Information |
---|---|
Get session storage key value#session_storage_get(key) | Returns the value of a session storage key. |
Skin
Name / Variable | Additional Information |
---|---|
Border - Radius#skin_border_radius | For more information about this variable, click here. |
Border - Style#skin_border_style | For more information about this variable, click here. |
Border - Width#skin_border_width | For more information about this variable, click here. |
Box Shadow - Width#skin_box_shadow_width | For more information about this variable, click here. |
Color - Danger#skin_color_danger | For more information about this variable, click here. |
Color - Default#skin_color_default | For more information about this variable, click here. |
Color - Default (Inverted)#skin_color_default_inverted | For more information about this variable, click here. |
Color - Default (Light)#skin_color_default_light | For more information about this variable, click here. |
Color - Default (Lighter)#skin_color_default_lighter | For more information about this variable, click here. |
Color - Default (Lightest)#skin_color_default_lightest | For more information about this variable, click here. |
Color - Information#skin_color_information | For more information about this variable, click here. |
Color - Primary#skin_color_primary | For more information about this variable, click here. |
Color - Secondary#skin_color_secondary | For more information about this variable, click here. |
Color - Success#skin_color_success | For more information about this variable, click here. |
Color - Warning#skin_color_warning | For more information about this variable, click here. |
Font - Family#skin_font_family | For more information about this variable, click here. |
Font - Size#skin_font_size | For more information about this variable, click here. |
Font - Size (Large)#skin_font_size_large | For more information about this variable, click here. |
Font - Size (Small)#skin_font_size_small | For more information about this variable, click here. |
Font - Weight#skin_font_weight | For more information about this variable, click here. |
Line Height#skin_line_height | For more information about this variable, click here. |
String
Name / Variable | Additional Information |
---|---|
Apply wpautop to a string#wpautop(string) | Returns the string with wpautop applied to it. |
Capitalize a string#capitalize(string) | Returns the capitalized version of an input string. |
Lowercase#lower(string) | Returns the lowercase version of the input string. |
Sentence case a string#sentence(string) | Returns the sentence cased version of an input string. |
Trim a string#trim(string) | Returns the trimmed string. |
Uppercase#upper(string) | Returns the uppercase version of the input string. |
Uppercase first letter#ucfirst(string) | Returns the uppercase first letter version of the input string. |
Uppercase words#ucwords(string) | Returns the uppercase words version of the input string. |
Stripe Elements
Name / Variable | Additional Information |
---|---|
Customer ID#stripe_customer_id | Returns the customer ID used or created during the transaction. |
Subscription ID#stripe_subscription_id | Returns the subscription ID for subscription transactions. |
Transaction ID#stripe_transaction_id | Returns the transaction ID for one-time transactions. |
Submission
Name / Variable | Additional Information |
---|---|
Admin Link#submit_admin_link | Link to submission in WordPress admin. |
Admin URL#submit_admin_url | URL to submission in WordPress admin. |
Hash#submit_hash | Returns the anonymized hash ID of the submission. |
ID#submit_id | Returns the numeric ID of the submission. |
Link#submit_link | Link to recall form with submission loaded. Used in conjunction with the 'Save' button. |
Status#submit_status | draft = In Progress, publish = Submitted, error = Error, spam = Spam, trash = Trash. |
Status Label#submit_status_label | Returns a nice version of the submission status. |
URL#submit_url | URL to recall form with submission loaded. Used in conjunction with the 'Save' button. |
User ID#submit_user_id | Returns the ID of the user who completed the form. |
Tab
Name / Variable | Additional Information |
---|---|
Tab Label#tab_label(id) | Returns the tab label by ID. |
Text
Name / Variable | Additional Information |
---|---|
Text#text(text) | Keep the content of this variable updated. |
Tracking
Name / Variable | Additional Information |
---|---|
Agent#tracking_agent | Stores the website visitors agent (browser type). |
City (By IP)#tracking_ip_lookup_city | If checked, WS Form will perform an IP lookup and obtain the city located closest to their approximate location. |
Country (By IP)#tracking_ip_lookup_country | If checked, WS Form will perform an IP lookup and obtain the country located closest to their approximate location. |
Hostname#tracking_host | Stores the server hostname. |
Location (By IP)#tracking_ip_lookup_latlon | This will obtain an approximate latitude and longitude of a website visitor by their IP address. |
Location (By browser)#tracking_geo_location | 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. |
Operating System#tracking_os | Stores the website visitors operating system. |
Pathname#tracking_pathname | Pathname of the URL. |
Query String#tracking_query_string | Query string of the URL. |
Referrer#tracking_referrer | Stores the web page address a website visitor was on prior to completing the submitted form. |
Region (By IP)#tracking_ip_lookup_region | If checked, WS Form will perform an IP lookup and obtain the region located closest to their approximate location. |
Remote IP Address#tracking_remote_ip | Stores the website visitors remote IP address, e.g. 123.45.56.789 |
Time Zone (By IP)#tracking_ip_lookup_time_zone | If checked, WS Form will perform an IP lookup and obtain the time zone closest to their approximate location. |
UTM Campaign#tracking_utm_campaign | This can be used to store the UTM (Urchin Tracking Module) campaign parameter. |
UTM Content#tracking_utm_content | This can be used to store the UTM (Urchin Tracking Module) content parameter. |
UTM Medium#tracking_utm_medium | This can be used to store the UTM (Urchin Tracking Module) medium parameter. |
UTM Source#tracking_utm_source | This can be used to store the UTM (Urchin Tracking Module) source parameter. |
UTM Term#tracking_utm_term | This can be used to store the UTM (Urchin Tracking Module) term parameter. |
URL
Name / Variable | Additional Information |
---|---|
Login#url_login | |
Logout#url_logout | |
Lost Password#url_lost_password | |
Register#url_register |
User
Name / Variable | Additional Information |
---|---|
Admin Color#user_admin_color | This variable can only be used if a user is currently signed in. |
Bio#user_bio | This variable can only be used if a user is currently signed in. |
Display Name#user_display_name | This variable can only be used if a user is currently signed in. |
Email#user_email | This variable can only be used if a user is currently signed in. |
First Name#user_first_name | This variable can only be used if a user is currently signed in. |
ID#user_id | This variable can only be used if a user is currently signed in. |
Last Name#user_last_name | This variable can only be used if a user is currently signed in. |
Login#user_login | This variable can only be used if a user is currently signed in. |
Lost Password Key#user_lost_password_key | This variable can only be used if a user is currently signed in. |
Lost Password URL#user_lost_password_url(path) | This variable can only be used if a user is currently signed in. |
Meta Value#user_meta(key) | Returns the user meta value for the key specified. |
Nice Name#user_nicename | This variable can only be used if a user is currently signed in. |
Nickname#user_nickname | This variable can only be used if a user is currently signed in. |
Registration Date#user_registered | This variable can only be used if a user is currently signed in. |
URL#user_url | This variable can only be used if a user is currently signed in. |
Word
Name / Variable | Additional Information |
---|---|
Count#word_count | The total word count. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Count Label#word_count_label | Shows 'word' or 'words' depending on the word count. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Count Remaining#word_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. This variable can only be used in the Help setting for text based Fields. |
Count Remaining Label#word_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. This variable can only be used in the Help setting for text based Fields. |
Maximum#word_max | Shows the maximum word length that you set for a field. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Maximum Label#word_max_label | Shows 'word' or 'words' depending on the maximum word length. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Minimum#word_min | Shows the minimum word length that you set for a field. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Minimum Label#word_min_label | Shows 'word' or 'words' depending on the minimum word length. For more information about this variable, click here. This variable can only be used in the Help setting for text based Fields. |
Zendesk
Name / Variable | Additional Information |
---|---|
Ticket ID#zendesk_ticket_id | Returns the ID of the created ticket. |
Ticket URL#zendesk_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. |