Help & Troubleshooting
| Field Type | What it Does | Common Use Case | Example Value |
|---|---|---|---|
| Text | A single-line text input field. | Short headlines, names, or titles. | My custom text field content |
| Text Area | A multi-line text input field. | Paragraphs, descriptions, or addresses. | 123 Main Street, New York, NY 10001 |
| Number | A field for numerical values. | Prices, quantities, or scores. | 150 |
| Range | A slider to select a number within a range. | Rating systems (e.g., 1-10) or product sizes. | 7 |
| A field that validates input as an email address. | Contact information or user profiles. | [email protected] | |
| URL | A field that validates input as a web address. | Linking to external websites or social media profiles. | https://example.com |
| Password | A masked input field for secure information. | Storing a password (not recommended for sensitive data). | mypassword123 |
| Image | An interface to upload or select an image. | Product images, user avatars, or featured images. Note: For product images, user avatars, or featured images, you need to upload the image in the dashboard, then copy the image ID and paste it into the field for it to work via the API. | 12(representing the image's attachment ID) |
| File | An interface to upload or select a file of any type. | Downloading a PDF brochure, spreadsheet, or document. Note: For downloading a PDF brochure, spreadsheet, or document, you need to upload the file manually on the dashboard, then copy the file ID and paste it into the field for it to work via the API. | 29 (representing the file's attachment ID) |
| WYSIWYG Editor | A rich text editor for formatted content. | Blog post content, product details, or page sections. | This is a formatted paragraph. |
| oEmbed | A field to embed media by pasting a URL. | Embedding YouTube videos, tweets, or Spotify tracks. | https://example.com |
| Select | A dropdown menu for choosing a single option from a list. | Product color options, status indicators. Note: Only predefined values configured in the dashboard should be entered in this field. | Option A |
| Checkbox | A set of options where multiple choices can be selected. | User preferences, dietary restrictions, product features. Note: Only predefined values configured in the dashboard should be entered in this field. | ["choice1", "choice2"] |
| Radio Button | A set of options where only one choice can be selected. | Product variations, Yes/No questions. Note: Only predefined values configured in the dashboard should be entered in this field. | Option A |
| Button Group | A collection of buttons where only one can be selected. | Similar to Radio Buttons with a visual style. | Option A |
| True / False | A simple toggle for a boolean value. | Availability or enabling/disabling a feature. | true |
| Link | A field to create an internal or external hyperlink. | Call-to-action buttons or navigation links. | {"url": "https://example.com", "title": "Example", "target": "_blank"} |
| Post Object | A field to select a specific post or page. | Linking to related articles or resources. | 55 |
| Page Link | A field to select a specific page. | Creating a list of internal page links. | "https://example.com/about-us/" or ["https://example.com/page-1/", "https://example.com/page-2/"] |
| Relationship | A field to select multiple posts, pages, or custom post types. | Showing related products or team members. | 55 |
| Taxonomy | A field to select one or more taxonomy terms. | Assigning categories or tags. | ["category-slug-1", "category-slug-2"] |
| User | A field to select a registered user. | Assigning a team member to a project or post. | 2 |
| Google Map | An interface to set a precise location on a map. | Displaying a business location or event venue. | { "lat": 37.7749, "lng": -122.4194, "address": "San Francisco, CA, USA" } |
| Date Picker | A calendar interface to select a date. | Event or publication dates. | 2025-08-25 |
| Date Time Picker | An interface to select a date and time. | Scheduling events or appointments. | 2025-08-25 14:30 |
| Time Picker | An interface to select a specific time. | Business hours or event times. | 15:30:00 |
| Color Picker | A tool to select a color. | Brand, button, or background colors. | #ff5733 (hex code) or rgb(255, 87, 51) |
| Message | A non-editable field to display instructions. | Providing editor guidance. | Not currently supported in the REST API. |
| Accordion | Groups fields into collapsible sections. | Cleaning up the editor UI for complex forms. | Not currently supported in the REST API. |
| Tab | Groups and organizes fields into tabs. | Creating a tabbed editing interface. | Not currently supported in the REST API. |
| Group | Groups related fields together. | Address group (street, city, state, etc.). | { "sub_field_name_1": "value_for_sub_field_1", "sub_field_name_2": "value_for_sub_field_2", "sub_field_name_3": "value_for_sub_field_3" } |
| Icon Picker | An Icon Picker lets content editors select a visual icon from a predefined set without needing to type its class name manually. | Used to add visual icons to UI elements like buttons, feature lists, or social media links. | { "value": "dashicons-dashboard", "type": "dashicons" } or { "value": "https://agreement.s2-tastewp.com/wp-content/uploads/2025/08/Oseman.jpg", "type": "url" } |