Inputfield::entityEncode() method

Entity encode a string with optional Markdown support.

  • Markdown support provided with second argument.
  • If string is already entity-encoded it will first be decoded.

Usage

// basic usage
$string = $inputfield->entityEncode(string $str);

// usage with all arguments
$string = $inputfield->entityEncode(string $str, $markdown = false);

Arguments

NameType(s)Description
strstring

String to encode

markdown (optional)bool, int

Optionally specify one of the following:

  • true (boolean): To allow Markdown using default "textFormat" setting (which is basic Markdown by default).
  • false (boolean): To disallow Markdown support (this is the default when $markdown argument omitted).
  • Inputfield::textFormatNone (constant): Disallow Markdown support (default).
  • Inputfield::textFormatBasic (constant): To support basic/inline Markdown.
  • Inputfield::textFormatMarkdown (constant): To support full Markdown and HTML.

Return value

string

Entity encoded string or HTML string


Inputfield methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #530
    In the 530th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, highlight some recent forum posts and third-party ProcessWire modules, and more. Read on!
    Weekly.pw / 6 July 2024
  • Page List Custom Children module
    This simple module gives you the ability to customize the parent/child relationship as it appears in the admin page list, enabling child pages to appear under more than one parent.
    Blog / 28 June 2024
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull