Nimoy Prospers Mystically

    @wordpress/escape-html
    TypeScript icon, indicating that this package has built-in type declarations

    2.12.0 • Public • Published

    Escape HTML

    Escape HTML utils.

    Installation

    Install the module

    npm install @wordpress/escape-html

    This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

    API

    escapeAmpersand

    Returns a string with ampersands escaped. Note that this is an imperfect implementation, where only ampersands which do not appear as a pattern of named, decimal, or hexadecimal character references are escaped. Invalid named references (i.e. ambiguous ampersand) are are still permitted.

    Related

    Parameters

    • value string: Original string.

    Returns

    • string: Escaped string.

    escapeAttribute

    Returns an escaped attribute value.

    Related

    Note we also escape the greater than symbol, as this is used by wptexturize to split HTML strings. This is a WordPress specific fix

    Note that if a resolution for Trac#45387 comes to fruition, it is no longer necessary for __unstableEscapeGreaterThan to be used.

    See: https://core.trac.wordpress.org/ticket/45387

    Parameters

    • value string: Attribute value.

    Returns

    • string: Escaped attribute value.

    escapeEditableHTML

    Returns an escaped Editable HTML element value. This is different from escapeHTML, because for editable HTML, ALL ampersands must be escaped in order to render the content correctly on the page.

    Parameters

    • value string: Element value.

    Returns

    • string: Escaped HTML element value.

    escapeHTML

    Returns an escaped HTML element value.

    Related

    Parameters

    • value string: Element value.

    Returns

    • string: Escaped HTML element value.

    escapeLessThan

    Returns a string with less-than sign replaced.

    Parameters

    • value string: Original string.

    Returns

    • string: Escaped string.

    escapeQuotationMark

    Returns a string with quotation marks replaced.

    Parameters

    • value string: Original string.

    Returns

    • string: Escaped string.

    isValidAttributeName

    Returns true if the given attribute name is valid, or false otherwise.

    Parameters

    • name string: Attribute name to test.

    Returns

    • boolean: Whether attribute is valid.

    Contributing to this package

    This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

    To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.



    Code is Poetry.

    Install

    npm i @wordpress/escape-html

    DownloadsWeekly Downloads

    71,112

    Version

    2.12.0

    License

    GPL-2.0-or-later

    Unpacked Size

    82.2 kB

    Total Files

    21

    Last publish

    Collaborators

    • gutenbergplugin
    • mamaduka
    • ryanwelcher
    • adamziel
    • garypendergast
    • aduth
    • riad
    • adamsilverstein
    • gziolo
    • ntwb
    • noisysocks
    • kadamwhite
    • jorgefilipecosta
    • ellatrix
    • iandunn206
    • whyisjake
    • ockham
    • sirreal
    • nosolosw
    • wpisabel
    • ntsekouras
    • nerrad
    • desrosj
    • talldanwp
    • peterwilsoncc