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 #555
    In the 555th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module that adds the ability to automatically convert email messages to pages, and more. Read on!
    Weekly.pw / 28 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer