Variables Reference

WS Form variables enable you to add dynamic content to various elements of your form such as default field values and email templates.

Areas where WS Form variables can be used are normally accompanied by a field lookup icon [TO DO: Insert hamburger icon]. By clicking this icon, a list of the available variables will be shown below the corresponding field. Click 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("dddd, mmmm dS, yyyy, h:MM:ss TT")

WS Form Variable List

The following variables are available for use in WS Form.

Name / VariableAdditional Information
ACF: Repeater Field
#acf_repeater_field(parent_field, sub_field)
Used to obtain an ACF repeater field. Server side only. You can separate parent_fields with commas to access deep variables.
Author: Display Name
#author_display_name
Author: Email
#author_email
Author: First Name
#author_first_name
Author: ID
#author_id
Author: Last Name
#author_last_name
Author: Nickname
#author_nickname
Blog: Admin Email
#blog_admin_email
Blog: Character Set
#blog_charset
Blog: Language
#blog_language
Blog: Name
#blog_name
Blog: URL
#blog_url
Character: 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.
Character: 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.
Character: 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.
Character: 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.
Character: 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.
Character: 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.
Character: 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.
Character: 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.
Client: 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 facing areas.
Client: 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 facing areas.
Client: Custom Date
#client_date_custom(format)
Returns the users web browser local date and time in a specified format. For more information about this variable, click here. This variable can only be used in client facing areas.
Ecommerce: Currency Symbol
#ecommerce_currency_symbol
Use this variable to show the current currency symbol.
Ecommerce: Field Value as Price
#ecommerce_field_price(id)
Use this variable to pull back the value of a price field on your form. For example: #field(123) where '123' is the field ID shown in the form editor. This variable will neatly format a currency value according to your E-Commerce settings. An example output might be: 123.00
Email: Character set
#email_charset
For more information about this variable, click here. This variable can only be used in the Send Email action.
Email: Content type
#email_content_type
For more information about this variable, click here. This variable can only be used in the Send Email action.
Email: Logo
#email_logo
For more information about this variable, click here. This variable can only be used in the Send Email action.
Email: Pixel
#email_pixel
Outputs a transparent gif. We use this to avoid Mac Mail going into dark mode when viewing emails.
Email: Subject
#email_subject
For more information about this variable, click here. This variable can only be used in the Send Email action.
Email: Submitted Fields
#email_submission(tab_labels, section_labels, blank_fields, static_fields)
This variable outputs a neat 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) For more information about this variable, click here. This variable can only be used in the Send Email action.
Email: Tracking data
#email_tracking
For more information about this variable, click here. This variable can only be used in the Send Email action.
Field: Field Value
#field(id)
Use this variable to pull back the value of a field on your form. For example: #field(123) where '123' is the field ID shown in the form editor.
Form: Checksum
#form_checksum
Form: DOM Selector ID
#form_obj_id
Form: Framework
#form_framework
Form: ID
#form_id
Form: Instance ID
#form_instance_id
Form: Label
#form_label
Form: Session ID
#form_hash
Post: Date
#post_date
Post: ID
#post_id
Post: Meta Value
#post_meta(key)
Post: Post Custom Date
#post_date_custom(format)
For more information about this variable, click here.
Post: Time
#post_time
Post: Title
#post_title
Post: Type
#post_type
Post: URL
#post_url
Progress: 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.
Progress: 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.
Progress: 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.
Progress: 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 String: Variable
#query_var(variable)
Server: Current Date
#server_date
Returns the server date in the format configured in WordPress.
Server: Current Time
#server_time
Returns the server time in the format configured in WordPress.
Server: Custom Date
#server_date_custom(format)
Returns the server date and time in a specified format. For more information about this variable, click here.
Skin: Border - Style
#skin_border_radius
For more information about this variable, click here.
Skin: Border - Style
#skin_border_style
For more information about this variable, click here.
Skin: Border - Width
#skin_border_width
For more information about this variable, click here.
Skin: Color - Danger
#skin_color_danger
For more information about this variable, click here.
Skin: Color - Default
#skin_color_default
For more information about this variable, click here.
Skin: Color - Default (Inverted)
#skin_color_default_inverted
For more information about this variable, click here.
Skin: Color - Default (Light)
#skin_color_default_light
For more information about this variable, click here.
Skin: Color - Default (Lighter)
#skin_color_default_lighter
For more information about this variable, click here.
Skin: Color - Default (Lightest)
#skin_color_default_lightest
For more information about this variable, click here.
Skin: Color - Information
#skin_color_information
For more information about this variable, click here.
Skin: Color - Primary
#skin_color_primary
For more information about this variable, click here.
Skin: Color - Secondary
#skin_color_secondary
For more information about this variable, click here.
Skin: Color - Success
#skin_color_success
For more information about this variable, click here.
Skin: Color - Warning
#skin_color_warning
For more information about this variable, click here.
Skin: Font - Family
#skin_font_family
For more information about this variable, click here.
Skin: Font - Size
#skin_font_size
For more information about this variable, click here.
Skin: Font - Size (Large)
#skin_font_size_large
For more information about this variable, click here.
Skin: Font - Size (Small)
#skin_font_size_small
For more information about this variable, click here.
Skin: Line Height
#skin_line_height
For more information about this variable, click here.
Skin: Unit Of Measurement (e.g. px)
#skin_unit_of_measurement
For more information about this variable, click here.
Submission: Hash
#submit_hash
Submission: ID
#submit_id
Submission: Link to submission in WordPress admin
#submit_admin_url
Submission: User ID
#submit_user_id
Tracking: Agent
#tracking_agent
Stores the website visitors agent (browser type).
Tracking: City (By IP)
#tracking_ip_lookup_city
When enabled, WS Form PRO will perform an IP lookup and obtain the city located closest to their approximate location.
Tracking: Country (By IP)
#tracking_ip_lookup_country
When enabled, WS Form PRO will perform an IP lookup and obtain the country located closest to their approximate location.
Tracking: Hostname
#tracking_host
Stores the website visitors host.
Tracking: Location (By IP)
#tracking_ip_lookup_latlon
This will obtain an approximate latitude and longitude of a website visitor by their IP address.
Tracking: 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.
Tracking: Operating System
#tracking_os
Stores the website visitors operating system.
Tracking: Referrer
#tracking_referrer
Stores the web page address a website visitor was on prior to completing the submitted form.
Tracking: Region (By IP)
#tracking_ip_lookup_region
When enabled, WS Form PRO will perform an IP lookup and obtain the region located closest to their approximate location.
Tracking: Remote IP Address
#tracking_remote_ip
Stores the website visitors remote IP address, e.g. 123.45.56.789
Tracking: UTM Campaign
#tracking_utm_campaign
This can be used to store the UTM (Urchin Tracking Module) campaign parameter.
Tracking: UTM Content
#tracking_utm_content
This can be used to store the UTM (Urchin Tracking Module) content parameter.
Tracking: UTM Medium
#tracking_utm_medium
This can be used to store the UTM (Urchin Tracking Module) medium parameter.
Tracking: UTM Source
#tracking_utm_source
This can be used to store the UTM (Urchin Tracking Module) source parameter.
Tracking: UTM Term
#tracking_utm_term
This can be used to store the UTM (Urchin Tracking Module) term parameter.
URL: Login
#url_lost_password
URL: Login
#url_login
URL: Logout
#url_logout
URL: Register
#url_register
User: Bio
#user_bio
This variable can only be used if a user is currently signed in.
User: Display Name
#user_display_name
This variable can only be used if a user is currently signed in.
User: Email
#user_email
This variable can only be used if a user is currently signed in.
User: First Name
#user_first_name
This variable can only be used if a user is currently signed in.
User: ID
#user_id
This variable can only be used if a user is currently signed in.
User: Last Name
#user_last_name
This variable can only be used if a user is currently signed in.
User: Login
#user_login
This variable can only be used if a user is currently signed in.
User: Lost Password Key
#user_lost_password_key
This variable can only be used if a user is currently signed in.
User: Lost Password URL
#user_lost_password_url(path)
This variable can only be used if a user is currently signed in.
User: Meta Value
#user_meta(key)
User: Nice Name
#user_nicename
This variable can only be used if a user is currently signed in.
User: Nickname
#user_nickname
This variable can only be used if a user is currently signed in.
User: Registration Date
#user_registered
This variable can only be used if a user is currently signed in.
User: URL
#user_url
This variable can only be used if a user is currently signed in.
Word: 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.
Word: 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.
Word: 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.
Word: 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.
Word: 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.
Word: 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.
Word: 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.
Word: 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.