wpseek.com
A WordPress-centric search engine for devs and theme authors



sanitize_post › WordPress Function

Since2.3.0
Deprecatedn/a
sanitize_post ( $post, $context = 'display' )
Parameters: (2)
  • (object|WP_Post|array) $post The post object or array
    Required: Yes
  • (string) $context Optional. How to sanitize post fields. Accepts 'raw', 'edit', 'db', 'display', 'attribute', or 'js'. Default 'display'.
    Required: No
    Default: 'display'
See:
Returns:
  • (object|WP_Post|array) The now sanitized post object or array (will be the same type as `$post`).
Defined at:
Codex:

Sanitizes every post field.

If the context is 'raw', then the post object or array will get minimal sanitization of the integer fields.


Source

function sanitize_post( $post, $context = 'display' ) {
	if ( is_object( $post ) ) {
		// Check if post already filtered for this context.
		if ( isset( $post->filter ) && $context == $post->filter ) {
			return $post;
		}
		if ( ! isset( $post->ID ) ) {
			$post->ID = 0;
		}
		foreach ( array_keys( get_object_vars( $post ) ) as $field ) {
			$post->$field = sanitize_post_field( $field, $post->$field, $post->ID, $context );
		}
		$post->filter = $context;
	} elseif ( is_array( $post ) ) {
		// Check if post already filtered for this context.
		if ( isset( $post['filter'] ) && $context == $post['filter'] ) {
			return $post;
		}
		if ( ! isset( $post['ID'] ) ) {
			$post['ID'] = 0;
		}
		foreach ( array_keys( $post ) as $field ) {
			$post[ $field ] = sanitize_post_field( $field, $post[ $field ], $post['ID'], $context );
		}
		$post['filter'] = $context;
	}
	return $post;
}