$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.130

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits