$sanitizer->entitiesMarkdown() method

Entity encode while translating some markdown tags to HTML equivalents

If you specify boolean TRUE for the $options argument, full markdown is applied. Otherwise, only basic markdown allowed, as outlined in the examples.

The primary reason to use this over full-on Markdown is that it has less overhead and is faster then full-blown Markdown, for when you don't need it. It's also safer for text coming from user input since it doesn't allow any other HTML. But if you just want full markdown, then specify TRUE for the $options argument.

Basic allowed markdown currently includes:

  • **strong**
  • *emphasis*
  • [anchor-text](url)
  • ~~strikethrough~~
  • code surrounded by backticks

Example

// basic markdown
echo $sanitizer->entitiesMarkdown($str);

// full markdown
echo $sanitizer->entitiesMarkdown($str, true); 

Usage

// basic usage
$string = $sanitizer->entitiesMarkdown(string $str);

// usage with all arguments
$string = $sanitizer->entitiesMarkdown(string $str, $options = []);

Arguments

NameType(s)Description
strstring

String to apply markdown to

options (optional)array, bool, int

Options include the following, or specify boolean TRUE to apply full markdown.

  • fullMarkdown (bool): Use full markdown rather than basic? (default=false) when true, most options no longer apply. Note: A markdown flavor integer may also be supplied for the fullMarkdown option.
  • flags (int): PHP htmlentities() flags. Default is ENT_QUOTES.
  • encoding (string): PHP encoding type. Default is 'UTF-8'.
  • doubleEncode (bool): Whether to double encode (if already encoded). Default is true.
  • allow (array): Only markdown that translates to these tags will be allowed. Default is most inline HTML tags.
  • disallow (array): Specified tags (in the default allow list) that won't be allowed. Default=[] empty array. (Note: The 'disallow' is an alternative to the default 'allow'. No point in using them both.)
  • linkMarkup (string): Markup to use for links. Default=<a href="{url}" rel="nofollow" target="_blank">{text}</a>.
  • allowBrackets (bool): Allow some inline-level bracket tags, i.e. [span.detail]text[/span] ? (default=false)

Return value

string

Formatted with a flavor of markdown


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.148

Twitter updates

  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020
  • If you haven't seen it yet, be sure to check out this great infographic by @teppokoivula in ProcessWire Weekly #294— How ProcessWire professionals work—the results of our recent weekly polls summarised: weekly.pw/issue/294/#how…
    3 January 2020
  • Today we have a new master version released, 3.0.148! There are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we take a closer look at what’s new, how to upgrade, & more— More
    3 January 2020

Latest news

  • ProcessWire Weekly #297
    In the 297th issue of ProcessWire Weekly we're going to check out the latest core updates (ProcessWire 3.0.149) and introduce a new third party module called StaticWire. Read on!
    Weekly.pw / 18 January 2020
  • ProcessWire 3.0.148 new master
    Today we have a new master version released, version 3.0.148! The last master version was 3.0.123, so there are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we’ll take a closer look at what’s new, how to upgrade, and more.
    Blog / 3 January 2020
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH