WYSIWYG (Visual Editor) Field

The WYSIWYG (Visual Editor) field is used for multiple line HTML content.

TinyMCE Editor
Quill Editor

The WYSIWYG (Visual Editor) field can store multi-line HTML content. It is intended for large amounts of text and can store any amount of content.

For plain text without a WYSIWYG editor or HTML, you may want to use the Paragraph Text Field.

For shorter text, you may want to use the Plain Text Field.

Quick Start

  1. Fill out the Basic Field Settings (Label, Description, and Field Name)
  2. Select Field Type: WYSIWYG (Visual Editor).
  3. Click Save New Field (or Save Field if you’re updating an existing field) to save your field configuration.

Settings

  • Editor
    The WYSIWYG editor to use. Available options are:
    • TinyMCE (WP Default)
      • Enable Media Buttons
        If using TinyMCE, you can show the Media buttons to allow embedding media more easily.
      • Editor Height
        You can choose the default height (in pixels) to use for the editor box.
    • Quill Editor
    • Note: As of Pods 2.8, CLEditor is no longer supported and if you had it selected then Quill Editor will be used instead
  • Output Options
    These options will change the way your field value will display.
    • Trim extra whitespace before/after contents
      This will remove any extra spaces before or after the field value.
    • Enable oEmbed
      Embed videos, images, tweets, and other content using Embeds.
    • Enable wptexturize
      Transforms less-beautiful text characters into stylized equivalents using wptexturize().
    • Enable convert_chars
      Converts text into valid XHTML and Unicode using convert_chars().
    • Enable wpautop
      Changes double line-breaks in the text into HTML paragraphs using wpautop().
    • Allow Shortcodes
      This will process any [shortcodes] that you may have in the field value.
    • Allow Markdown Syntax
      If you have the Pods Component “Markdown Syntax” enabled, you can allow any Markdown Syntax to be automatically converted to HTML on display.
  • Allowed HTML Tags
    This will let you specify which HTML tags to allow (default: empty), enter them without the < > tags and separated by space. Leave empty to allow all HTML tags.

How to Display

Display with a Shortcode

[pods field="my_wysiwyg_field"]

Display with PHP: pods_field_display()

<?php
echo pods_field_display( 'my_wysiwyg_field' );

Display with PHP: $pod->display()

<?php
$pod = pods();

echo $pod->display( 'my_wysiwyg_field' );

Other Helpful Documentation on Working with Fields in Pods

Avatar Field

Extends User Profile with a Gravatar field that is managed under the Media Library as opposed to using Gravatar.com

Code (Syntax Highlighting) Field

The Code (Syntax Highlighting) field is used for multiple line code content.

Color Picker Field

The Color Picker field is useful in situations where a color needs to be able to be chosen and customized.

Conditional Logic for Fields

Conditional Logic for Fields will allow you to show or hide a field based on the value of another field.

Currency Field

The Currency field is used to store numeric, integer, and float currency amounts.

Date / Time Field

The Date / Time field is used to store a date and time value with an easy to use date / time input.

Date Field

The Date field is used to store a date value with an easy to use date input.

Date time fields redirect

Email Field

The Email field allows you to store email addresses with additional validation checks.

File / Image / Video Field

The File / Image / Video field is used to store a relationship to Media attachment(s).

Heading Field

The Heading field is not a normal input field, it will output Heading text between your normal form fields to help organize the form.

HTML Content Field

The HTML Content field is not a normal input field, it will output as HTML itself between your normal form fields to help organize the form.

oEmbed Field

The oEmbed field is used to store a single URL that will use the oEmbed protocol to display remote content.

Password Field

The Password field is used to store single-line text with a basic password input form field.

Phone Field

The Phone field is used for telephone numbers in various formats.

Plain Number Field

The Plain Number field is used to store numeric, integer, and float values.

Plain Paragraph Text Field

The Plain Paragraph Text field is used for multiple line text values.

Plain Text Field

The Plain Text field is used for Simple Plain Text Values like a first name, last name, alphanumeric ID or value.

Relationship Field

The Relationship field is used to store related items on various objects in WordPress.

Settings: Advanced

Provides access to the Advanced field options when editing a field.

Settings: Field Details

Basic Field Settings (Label, Name, Description and Field Type) that apply to all Fields created in Pods.

Settings: Reserved List of Names

There are certain names you cannot use for Pod, Group, or Field names in Pods because they are reserved in WordPress or Pods for other uses.

Simple Repeatable Fields

Simple Repeatable Fields will allow you to repeat many different types of fields.

Time Field

The Time field is used to store a date value with an easy to use time input.

Website Field

The Website field is used to store a URL or Website Address or Link to a Website.

Yes / No Field

The Yes / No field offers customizable labels and display options for checkbox, radio buttons, or a drop-down input.