PHP's htmlentities in TypeScript

How to use

Install via yarn add locutus and import: import { htmlentities } from 'locutus/php/strings/htmlentities'.

Or with CommonJS: const { htmlentities } = require('locutus/php/strings/htmlentities')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	htmlentities('Kevin & van Zonneveld')	'Kevin & van Zonneveld'
2	htmlentities("foo'bar","ENT_QUOTES")	'foo'bar'

Notes

• function is compatible with PHP 5.2 and older

Dependencies

This function uses the following Locutus functions:

• get_html_translation_table (php/strings)

Here's what our current TypeScript equivalent to PHP's htmlentities looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { get_html_translation_table as getHtmlTranslationTable } from '../strings/get_html_translation_table.ts'

export function htmlentities(
  string: string,
  quoteStyle?: string | number,
  charset?: string,
  doubleEncode?: boolean | null,
): string {
  //      discuss at: https://locutus.io/php/htmlentities/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //     improved by: nobbler
  //     improved by: Jack
  //     improved by: Rafał Kukawski (https://blog.kukawski.pl)
  //     improved by: Dj (https://locutus.io/php/htmlentities:425#comment_134018)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //        input by: Ratheous
  //          note 1: function is compatible with PHP 5.2 and older
  //       example 1: htmlentities('Kevin & van Zonneveld')
  //       returns 1: 'Kevin & van Zonneveld'
  //       example 2: htmlentities("foo'bar","ENT_QUOTES")
  //       returns 2: 'foo'bar'

  const hashMap = getHtmlTranslationTable('HTML_ENTITIES', quoteStyle)

  const source = string === null ? '' : string + ''

  if (quoteStyle && quoteStyle === 'ENT_QUOTES') {
    hashMap["'"] = '''
  }

  const shouldDoubleEncode = doubleEncode === null || !!doubleEncode

  const regex = new RegExp(
    '&(?:#\\d+|#x[\\da-f]+|[a-zA-Z][\\da-z]*);|[' +
      Object.keys(hashMap)
        .join('')
        // replace regexp special chars
        .replace(/([()[\]{}\-.*+?^$|/\\])/g, '\\$1') +
      ']',
    'g',
  )

  return source.replace(regex, function (ent: string): string {
    if (ent.length > 1) {
      return shouldDoubleEncode ? hashMap['&'] + ent.substring(1) : ent
    }

    return hashMap[ent] ?? ent
  })
}

import { get_html_translation_table as getHtmlTranslationTable } from '../strings/get_html_translation_table.ts'

export function htmlentities(string, quoteStyle, charset, doubleEncode) {
  //      discuss at: https://locutus.io/php/htmlentities/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //     improved by: nobbler
  //     improved by: Jack
  //     improved by: Rafał Kukawski (https://blog.kukawski.pl)
  //     improved by: Dj (https://locutus.io/php/htmlentities:425#comment_134018)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //        input by: Ratheous
  //          note 1: function is compatible with PHP 5.2 and older
  //       example 1: htmlentities('Kevin & van Zonneveld')
  //       returns 1: 'Kevin & van Zonneveld'
  //       example 2: htmlentities("foo'bar","ENT_QUOTES")
  //       returns 2: 'foo'bar'

  const hashMap = getHtmlTranslationTable('HTML_ENTITIES', quoteStyle)

  const source = string === null ? '' : string + ''

  if (quoteStyle && quoteStyle === 'ENT_QUOTES') {
    hashMap["'"] = '''
  }

  const shouldDoubleEncode = doubleEncode === null || !!doubleEncode

  const regex = new RegExp(
    '&(?:#\\d+|#x[\\da-f]+|[a-zA-Z][\\da-z]*);|[' +
      Object.keys(hashMap)
        .join('')
        // replace regexp special chars
        .replace(/([()[\]{}\-.*+?^$|/\\])/g, '\\$1') +
      ']',
    'g',
  )

  return source.replace(regex, function (ent) {
    if (ent.length > 1) {
      return shouldDoubleEncode ? hashMap['&'] + ent.substring(1) : ent
    }

    return hashMap[ent] ?? ent
  })
}

// php/strings/get_html_translation_table (Locutus dependency module)
function get_html_translation_table(
  table: string | number = 'HTML_SPECIALCHARS',
  quoteStyle: string | number = 'ENT_COMPAT',
): Record<string, string> {
  //  discuss at: https://locutus.io/php/get_html_translation_table/
  // original by: Philip Peterson
  //  revised by: Kevin van Zonneveld (https://kvz.io)
  // bugfixed by: noname
  // bugfixed by: Alex
  // bugfixed by: Marco
  // bugfixed by: madipta
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: T.Wild
  // improved by: KELAN
  // improved by: Brett Zamir (https://brett-zamir.me)
  //    input by: Frank Forte
  //    input by: Ratheous
  //      note 1: It has been decided that we're not going to add global
  //      note 1: dependencies to Locutus, meaning the constants are not
  //      note 1: real constants, but strings instead. Integers are also supported if someone
  //      note 1: chooses to create the constants themselves.
  //   example 1: get_html_translation_table('HTML_SPECIALCHARS')
  //   returns 1: {'"': '&quot;', '&': '&amp;', '<': '&lt;', '>': '&gt;'}

  const entities: { [key: string]: string } = {}
  const hashMap: { [key: string]: string } = {}
  const constMappingTable: { [key: number]: string } = {}
  const constMappingQuoteStyle: { [key: number]: string } = {}
  let useTable = ''
  let useQuoteStyle = ''
  // Translate arguments
  constMappingTable[0] = 'HTML_SPECIALCHARS'
  constMappingTable[1] = 'HTML_ENTITIES'
  constMappingQuoteStyle[0] = 'ENT_NOQUOTES'
  constMappingQuoteStyle[2] = 'ENT_COMPAT'
  constMappingQuoteStyle[3] = 'ENT_QUOTES'

  useTable = !isNaN(Number(table))
    ? (constMappingTable[Number(table)] ?? 'HTML_SPECIALCHARS')
    : table
      ? String(table).toUpperCase()
      : 'HTML_SPECIALCHARS'

  useQuoteStyle = !isNaN(Number(quoteStyle))
    ? (constMappingQuoteStyle[Number(quoteStyle)] ?? 'ENT_COMPAT')
    : quoteStyle
      ? String(quoteStyle).toUpperCase()
      : 'ENT_COMPAT'

  if (useTable !== 'HTML_SPECIALCHARS' && useTable !== 'HTML_ENTITIES') {
    throw new Error('Table: ' + useTable + ' not supported')
  }

  entities['38'] = '&amp;'
  if (useTable === 'HTML_ENTITIES') {
    entities['160'] = '&nbsp;'
    entities['161'] = '&iexcl;'
    entities['162'] = '&cent;'
    entities['163'] = '&pound;'
    entities['164'] = '&curren;'
    entities['165'] = '&yen;'
    entities['166'] = '&brvbar;'
    entities['167'] = '&sect;'
    entities['168'] = '&uml;'
    entities['169'] = '&copy;'
    entities['170'] = '&ordf;'
    entities['171'] = '&laquo;'
    entities['172'] = '&not;'
    entities['173'] = '&shy;'
    entities['174'] = '&reg;'
    entities['175'] = '&macr;'
    entities['176'] = '&deg;'
    entities['177'] = '&plusmn;'
    entities['178'] = '&sup2;'
    entities['179'] = '&sup3;'
    entities['180'] = '&acute;'
    entities['181'] = '&micro;'
    entities['182'] = '&para;'
    entities['183'] = '&middot;'
    entities['184'] = '&cedil;'
    entities['185'] = '&sup1;'
    entities['186'] = '&ordm;'
    entities['187'] = '&raquo;'
    entities['188'] = '&frac14;'
    entities['189'] = '&frac12;'
    entities['190'] = '&frac34;'
    entities['191'] = '&iquest;'
    entities['192'] = '&Agrave;'
    entities['193'] = '&Aacute;'
    entities['194'] = '&Acirc;'
    entities['195'] = '&Atilde;'
    entities['196'] = '&Auml;'
    entities['197'] = '&Aring;'
    entities['198'] = '&AElig;'
    entities['199'] = '&Ccedil;'
    entities['200'] = '&Egrave;'
    entities['201'] = '&Eacute;'
    entities['202'] = '&Ecirc;'
    entities['203'] = '&Euml;'
    entities['204'] = '&Igrave;'
    entities['205'] = '&Iacute;'
    entities['206'] = '&Icirc;'
    entities['207'] = '&Iuml;'
    entities['208'] = '&ETH;'
    entities['209'] = '&Ntilde;'
    entities['210'] = '&Ograve;'
    entities['211'] = '&Oacute;'
    entities['212'] = '&Ocirc;'
    entities['213'] = '&Otilde;'
    entities['214'] = '&Ouml;'
    entities['215'] = '&times;'
    entities['216'] = '&Oslash;'
    entities['217'] = '&Ugrave;'
    entities['218'] = '&Uacute;'
    entities['219'] = '&Ucirc;'
    entities['220'] = '&Uuml;'
    entities['221'] = '&Yacute;'
    entities['222'] = '&THORN;'
    entities['223'] = '&szlig;'
    entities['224'] = '&agrave;'
    entities['225'] = '&aacute;'
    entities['226'] = '&acirc;'
    entities['227'] = '&atilde;'
    entities['228'] = '&auml;'
    entities['229'] = '&aring;'
    entities['230'] = '&aelig;'
    entities['231'] = '&ccedil;'
    entities['232'] = '&egrave;'
    entities['233'] = '&eacute;'
    entities['234'] = '&ecirc;'
    entities['235'] = '&euml;'
    entities['236'] = '&igrave;'
    entities['237'] = '&iacute;'
    entities['238'] = '&icirc;'
    entities['239'] = '&iuml;'
    entities['240'] = '&eth;'
    entities['241'] = '&ntilde;'
    entities['242'] = '&ograve;'
    entities['243'] = '&oacute;'
    entities['244'] = '&ocirc;'
    entities['245'] = '&otilde;'
    entities['246'] = '&ouml;'
    entities['247'] = '&divide;'
    entities['248'] = '&oslash;'
    entities['249'] = '&ugrave;'
    entities['250'] = '&uacute;'
    entities['251'] = '&ucirc;'
    entities['252'] = '&uuml;'
    entities['253'] = '&yacute;'
    entities['254'] = '&thorn;'
    entities['255'] = '&yuml;'
  }

  if (useQuoteStyle !== 'ENT_NOQUOTES') {
    entities['34'] = '&quot;'
  }
  if (useQuoteStyle === 'ENT_QUOTES') {
    entities['39'] = '&#39;'
  }
  entities['60'] = '&lt;'
  entities['62'] = '&gt;'

  // ascii decimals to real symbols
  for (const [decimal, entity] of Object.entries(entities)) {
    hashMap[String.fromCharCode(Number(decimal))] = entity ?? ''
  }

  return hashMap
}

// php/strings/htmlentities (target function module)
const getHtmlTranslationTable = get_html_translation_table;

function htmlentities(
  string: string,
  quoteStyle?: string | number,
  charset?: string,
  doubleEncode?: boolean | null,
): string {
  //      discuss at: https://locutus.io/php/htmlentities/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //     improved by: nobbler
  //     improved by: Jack
  //     improved by: Rafał Kukawski (https://blog.kukawski.pl)
  //     improved by: Dj (https://locutus.io/php/htmlentities:425#comment_134018)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //        input by: Ratheous
  //          note 1: function is compatible with PHP 5.2 and older
  //       example 1: htmlentities('Kevin & van Zonneveld')
  //       returns 1: 'Kevin &amp; van Zonneveld'
  //       example 2: htmlentities("foo'bar","ENT_QUOTES")
  //       returns 2: 'foo&#039;bar'

  const hashMap = getHtmlTranslationTable('HTML_ENTITIES', quoteStyle)

  const source = string === null ? '' : string + ''

  if (quoteStyle && quoteStyle === 'ENT_QUOTES') {
    hashMap["'"] = '&#039;'
  }

  const shouldDoubleEncode = doubleEncode === null || !!doubleEncode

  const regex = new RegExp(
    '&(?:#\\d+|#x[\\da-f]+|[a-zA-Z][\\da-z]*);|[' +
      Object.keys(hashMap)
        .join('')
        // replace regexp special chars
        .replace(/([()[\]{}\-.*+?^$|/\\])/g, '\\$1') +
      ']',
    'g',
  )

  return source.replace(regex, function (ent: string): string {
    if (ent.length > 1) {
      return shouldDoubleEncode ? hashMap['&'] + ent.substring(1) : ent
    }

    return hashMap[ent] ?? ent
  })
}

// php/strings/get_html_translation_table (Locutus dependency module)
function get_html_translation_table(table = 'HTML_SPECIALCHARS', quoteStyle = 'ENT_COMPAT') {
  //  discuss at: https://locutus.io/php/get_html_translation_table/
  // original by: Philip Peterson
  //  revised by: Kevin van Zonneveld (https://kvz.io)
  // bugfixed by: noname
  // bugfixed by: Alex
  // bugfixed by: Marco
  // bugfixed by: madipta
  // bugfixed by: Brett Zamir (https://brett-zamir.me)
  // bugfixed by: T.Wild
  // improved by: KELAN
  // improved by: Brett Zamir (https://brett-zamir.me)
  //    input by: Frank Forte
  //    input by: Ratheous
  //      note 1: It has been decided that we're not going to add global
  //      note 1: dependencies to Locutus, meaning the constants are not
  //      note 1: real constants, but strings instead. Integers are also supported if someone
  //      note 1: chooses to create the constants themselves.
  //   example 1: get_html_translation_table('HTML_SPECIALCHARS')
  //   returns 1: {'"': '&quot;', '&': '&amp;', '<': '&lt;', '>': '&gt;'}

  const entities = {}
  const hashMap = {}
  const constMappingTable = {}
  const constMappingQuoteStyle = {}
  let useTable = ''
  let useQuoteStyle = ''
  // Translate arguments
  constMappingTable[0] = 'HTML_SPECIALCHARS'
  constMappingTable[1] = 'HTML_ENTITIES'
  constMappingQuoteStyle[0] = 'ENT_NOQUOTES'
  constMappingQuoteStyle[2] = 'ENT_COMPAT'
  constMappingQuoteStyle[3] = 'ENT_QUOTES'

  useTable = !isNaN(Number(table))
    ? (constMappingTable[Number(table)] ?? 'HTML_SPECIALCHARS')
    : table
      ? String(table).toUpperCase()
      : 'HTML_SPECIALCHARS'

  useQuoteStyle = !isNaN(Number(quoteStyle))
    ? (constMappingQuoteStyle[Number(quoteStyle)] ?? 'ENT_COMPAT')
    : quoteStyle
      ? String(quoteStyle).toUpperCase()
      : 'ENT_COMPAT'

  if (useTable !== 'HTML_SPECIALCHARS' && useTable !== 'HTML_ENTITIES') {
    throw new Error('Table: ' + useTable + ' not supported')
  }

  entities['38'] = '&amp;'
  if (useTable === 'HTML_ENTITIES') {
    entities['160'] = '&nbsp;'
    entities['161'] = '&iexcl;'
    entities['162'] = '&cent;'
    entities['163'] = '&pound;'
    entities['164'] = '&curren;'
    entities['165'] = '&yen;'
    entities['166'] = '&brvbar;'
    entities['167'] = '&sect;'
    entities['168'] = '&uml;'
    entities['169'] = '&copy;'
    entities['170'] = '&ordf;'
    entities['171'] = '&laquo;'
    entities['172'] = '&not;'
    entities['173'] = '&shy;'
    entities['174'] = '&reg;'
    entities['175'] = '&macr;'
    entities['176'] = '&deg;'
    entities['177'] = '&plusmn;'
    entities['178'] = '&sup2;'
    entities['179'] = '&sup3;'
    entities['180'] = '&acute;'
    entities['181'] = '&micro;'
    entities['182'] = '&para;'
    entities['183'] = '&middot;'
    entities['184'] = '&cedil;'
    entities['185'] = '&sup1;'
    entities['186'] = '&ordm;'
    entities['187'] = '&raquo;'
    entities['188'] = '&frac14;'
    entities['189'] = '&frac12;'
    entities['190'] = '&frac34;'
    entities['191'] = '&iquest;'
    entities['192'] = '&Agrave;'
    entities['193'] = '&Aacute;'
    entities['194'] = '&Acirc;'
    entities['195'] = '&Atilde;'
    entities['196'] = '&Auml;'
    entities['197'] = '&Aring;'
    entities['198'] = '&AElig;'
    entities['199'] = '&Ccedil;'
    entities['200'] = '&Egrave;'
    entities['201'] = '&Eacute;'
    entities['202'] = '&Ecirc;'
    entities['203'] = '&Euml;'
    entities['204'] = '&Igrave;'
    entities['205'] = '&Iacute;'
    entities['206'] = '&Icirc;'
    entities['207'] = '&Iuml;'
    entities['208'] = '&ETH;'
    entities['209'] = '&Ntilde;'
    entities['210'] = '&Ograve;'
    entities['211'] = '&Oacute;'
    entities['212'] = '&Ocirc;'
    entities['213'] = '&Otilde;'
    entities['214'] = '&Ouml;'
    entities['215'] = '&times;'
    entities['216'] = '&Oslash;'
    entities['217'] = '&Ugrave;'
    entities['218'] = '&Uacute;'
    entities['219'] = '&Ucirc;'
    entities['220'] = '&Uuml;'
    entities['221'] = '&Yacute;'
    entities['222'] = '&THORN;'
    entities['223'] = '&szlig;'
    entities['224'] = '&agrave;'
    entities['225'] = '&aacute;'
    entities['226'] = '&acirc;'
    entities['227'] = '&atilde;'
    entities['228'] = '&auml;'
    entities['229'] = '&aring;'
    entities['230'] = '&aelig;'
    entities['231'] = '&ccedil;'
    entities['232'] = '&egrave;'
    entities['233'] = '&eacute;'
    entities['234'] = '&ecirc;'
    entities['235'] = '&euml;'
    entities['236'] = '&igrave;'
    entities['237'] = '&iacute;'
    entities['238'] = '&icirc;'
    entities['239'] = '&iuml;'
    entities['240'] = '&eth;'
    entities['241'] = '&ntilde;'
    entities['242'] = '&ograve;'
    entities['243'] = '&oacute;'
    entities['244'] = '&ocirc;'
    entities['245'] = '&otilde;'
    entities['246'] = '&ouml;'
    entities['247'] = '&divide;'
    entities['248'] = '&oslash;'
    entities['249'] = '&ugrave;'
    entities['250'] = '&uacute;'
    entities['251'] = '&ucirc;'
    entities['252'] = '&uuml;'
    entities['253'] = '&yacute;'
    entities['254'] = '&thorn;'
    entities['255'] = '&yuml;'
  }

  if (useQuoteStyle !== 'ENT_NOQUOTES') {
    entities['34'] = '&quot;'
  }
  if (useQuoteStyle === 'ENT_QUOTES') {
    entities['39'] = '&#39;'
  }
  entities['60'] = '&lt;'
  entities['62'] = '&gt;'

  // ascii decimals to real symbols
  for (const [decimal, entity] of Object.entries(entities)) {
    hashMap[String.fromCharCode(Number(decimal))] = entity ?? ''
  }

  return hashMap
}

// php/strings/htmlentities (target function module)
const getHtmlTranslationTable = get_html_translation_table

function htmlentities(string, quoteStyle, charset, doubleEncode) {
  //      discuss at: https://locutus.io/php/htmlentities/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //      revised by: Kevin van Zonneveld (https://kvz.io)
  //     improved by: nobbler
  //     improved by: Jack
  //     improved by: Rafał Kukawski (https://blog.kukawski.pl)
  //     improved by: Dj (https://locutus.io/php/htmlentities:425#comment_134018)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //        input by: Ratheous
  //          note 1: function is compatible with PHP 5.2 and older
  //       example 1: htmlentities('Kevin & van Zonneveld')
  //       returns 1: 'Kevin &amp; van Zonneveld'
  //       example 2: htmlentities("foo'bar","ENT_QUOTES")
  //       returns 2: 'foo&#039;bar'

  const hashMap = getHtmlTranslationTable('HTML_ENTITIES', quoteStyle)

  const source = string === null ? '' : string + ''

  if (quoteStyle && quoteStyle === 'ENT_QUOTES') {
    hashMap["'"] = '&#039;'
  }

  const shouldDoubleEncode = doubleEncode === null || !!doubleEncode

  const regex = new RegExp(
    '&(?:#\\d+|#x[\\da-f]+|[a-zA-Z][\\da-z]*);|[' +
      Object.keys(hashMap)
        .join('')
        // replace regexp special chars
        .replace(/([()[\]{}\-.*+?^$|/\\])/g, '\\$1') +
      ']',
    'g',
  )

  return source.replace(regex, function (ent) {
    if (ent.length > 1) {
      return shouldDoubleEncode ? hashMap['&'] + ent.substring(1) : ent
    }

    return hashMap[ent] ?? ent
  })
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

« More PHP strings functions

Star