sanitize_post( object|WP_Post|array $post, string $context = 'display' ): object|WP_Post|array

Description

Compatibility

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

Parameters

$postobject|WP_Post|array

The post object or array

$contextstringoptional

How to sanitize post fields.
Accepts 'raw', 'edit', 'db', 'display', 'attribute', or 'js'. Default 'display'.Default: 'display'

Return value

object|WP_Post|array

The now sanitized post object or array (will be the same type as $post).

Performance profile

How much work a call to sanitize_post() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

7–25

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 73.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

7

7 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below sanitize_post()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

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

Uses · 1

• sanitize_post_field()Sanitizes a post field based on context.

Used by · 7

• WP_Post::filter(){@Missing Summary}
• WP_Post::get_instance()Retrieve WP_Post instance.
• _set_preview()Sets up the post object for preview based on the post autosave.
• get_attachment_fields_to_edit()Retrieves the attachment fields to edit form fields.
• get_post()Retrieves post data given a post ID or post object.
• update_post_cache()Updates posts in cache.
• wp_insert_post()Inserts or updates a post in the database.

Source code

View on Trac ↗View on GitHub ↗

2919function sanitize_post( $post, $context = 'display' ) {2920	if ( is_object( $post ) ) {2921		// Check if post already filtered for this context.2922		if ( isset( $post->filter ) && $context === $post->filter ) {2923			return $post;2924		}2925		if ( ! isset( $post->ID ) ) {2926			$post->ID = 0;2927		}2928		foreach ( array_keys( get_object_vars( $post ) ) as $field ) {2929			$post->$field = sanitize_post_field( $field, $post->$field, $post->ID, $context );2930		}2931		$post->filter = $context;2932	} elseif ( is_array( $post ) ) {2933		// Check if post already filtered for this context.2934		if ( isset( $post['filter'] ) && $context === $post['filter'] ) {2935			return $post;2936		}2937		if ( ! isset( $post['ID'] ) ) {2938			$post['ID'] = 0;2939		}2940		foreach ( array_keys( $post ) as $field ) {2941			$post[ $field ] = sanitize_post_field( $field, $post[ $field ], $post['ID'], $context );2942		}2943		$post['filter'] = $context;2944	}2945	return $post;2946}

Changelog

Introduced in 2.3.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.0.4 tag, from src/wp-includes/post.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.