wppaste
WordPress

WP_HTML_Processor::normalize( string $html ): string|null

Since
6.7.0
Source
wp-includes/html-api/class-wp-html-processor.php:1273
Normalizes an HTML fragment by serializing it.

Description

This method assumes that the given HTML snippet is found in BODY context.
For normalizing full documents or fragments found in other contexts, create a new processor using WP_HTML_Processor::create_fragment or WP_HTML_Processor::create_full_parser and call WP_HTML_Processor::serialize on the created instances.

Many aspects of an input HTML fragment may be changed during normalization.

  • Attribute values will be double-quoted.
  • Duplicate attributes will be removed.
  • Omitted tags will be added.
  • Tag and attribute name casing will be lower-cased, except for specific SVG and MathML tags or attributes.
  • Text will be re-encoded, null bytes handled, and invalid UTF-8 replaced with U+FFFD.
  • Any incomplete syntax trailing at the end will be omitted, for example, an unclosed comment opener will be removed.

Example:

echo WP_HTML_Processor::normalize( '<a href=#anchor v=5 href="/" enabled>One</a another v=5><!--' );
// <a href="#anchor" v="5" enabled>One</a>

echo WP_HTML_Processor::normalize( '<div></p>fun<table><td>cell</div>' );
// <div><p></p>fun<table><tbody><tr><td>cell</td></tr></tbody></table></div>

echo WP_HTML_Processor::normalize( '<![CDATA[invalid comment]]> syntax < <> "oddities"' );
// <!--[CDATA[invalid comment]]--> syntax &lt; &lt;&gt; &quot;oddities&quot;

Compatibility

WordPress
since 6.7.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$htmlstring
Input HTML to normalize.

Return value

string|null
Normalized output, or null if unable to normalize.

Performance profile

How much work a call to WP_HTML_Processor::normalize() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
8

Executed per call on PHP 8.5. The body compiles to 8.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_HTML_Processor::normalize() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always8::create_fragment(), ->serialize()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 8 instructions, 8 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

  • static::create_fragment($html)::serialize()
  • static::create_fragment()

Source code

View on Trac View on GitHub 

	public static function normalize( string $html ): ?string {		return static::create_fragment( $html )->serialize();	}

Changelog

Introduced in 6.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/html-api/class-wp-html-processor.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.