WP_SimplePie_Sanitize_KSES::sanitize( mixed $data, int $type, string $base = '' ): mixed
- Since
- 3.5.0
- Source
wp-includes/class-wp-simplepie-sanitize-kses.php:34
Description
Sanitizes the incoming data, to ensure that it matches the type of data expected, using KSES.
Compatibility
- WordPress
- since 3.5.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
$datamixed- The data that needs to be sanitized.
$typeint- The type of data that it's supposed to be.
$basestringoptional- The
xml:basevalue to use when converting relative URLs to absolute ones. Default empty.Default:''
Return value
mixed- Sanitized data.
Performance profile
How much work a call to WP_SimplePie_Sanitize_KSES::sanitize() 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
- Scaling
- Constant
- Instructions
- 22–47
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 55.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_SimplePie_Sanitize_KSES::sanitize() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$type | 22–30 | ::sanitize() |
| always | 24–43 | wp_kses_post() |
| always | 26–34 | base64_decode(), ::sanitize() |
$type | 28–47 | base64_decode(), wp_kses_post() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 55 | 22–47 | 5 | |
| 8.5 | 55 | 22–47 | 5 | |
| 8.4 | 55 | 22–47 | 5 | 5 fewer instructions than PHP 8.3 |
| 8.3 | 60 | 24–52 | 5 | |
| 8.2 | 60 | 24–52 | 5 | |
| 8.1 | 60 | 24–52 | 5 | |
| 7.4 | 60 | 24–52 | 5 |
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
- wp_kses_post()Sanitizes content for allowed HTML tags for post content.
- \SimplePie\Sanitize::sanitize()
Source code
public function sanitize( $data, $type, $base = '' ) { $data = trim( $data ); if ( $type & SimplePie\SimplePie::CONSTRUCT_MAYBE_HTML ) { if ( preg_match( '/(&(#(x[0-9a-fA-F]+|[0-9]+)|[a-zA-Z0-9]+)|<\/[A-Za-z][^\x09\x0A\x0B\x0C\x0D\x20\x2F\x3E]*' . SIMPLEPIE_PCRE_HTML_ATTRIBUTE . '>)/', $data ) ) { $type |= SimplePie\SimplePie::CONSTRUCT_HTML; } else { $type |= SimplePie\SimplePie::CONSTRUCT_TEXT; } } if ( $type & SimplePie\SimplePie::CONSTRUCT_BASE64 ) { $data = base64_decode( $data ); } if ( $type & ( SimplePie\SimplePie::CONSTRUCT_HTML | \SimplePie\SimplePie::CONSTRUCT_XHTML ) ) { $data = wp_kses_post( $data ); if ( 'UTF-8' !== $this->output_encoding ) { $data = $this->registry->call( 'Misc', 'change_encoding', array( $data, 'UTF-8', $this->output_encoding ) ); } return $data; } else { return parent::sanitize( $data, $type, $base ); } }Changelog
Introduced in 3.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/class-wp-simplepie-sanitize-kses.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.