sanitize_post_field( string $field, mixed $value, int $post_id, string $context = 'display' ): mixed

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

$fieldstring

The Post Object field name.

$valuemixed

The Post Object value.

$post_idint

Post ID.

$contextstringoptional

How to sanitize the field. Possible values are 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. Default 'display'.Default: 'display'

Return value

mixed

Sanitized value.

Performance profile

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

11–53

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

Plugin surface

9 hooks

Third-party callbacks on 'edit_{$field}', '{$field_no_prefix}_edit_pre', 'edit_post_{$field}' run inside this call, and their cost is not bounded by anything here.

Called by

5

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

What it touches

• hookthird-party callbacksapply_filters()called directly

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 · 11 distinct outcomes

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

Hooks and filters fired · 9

9 hooks fire while sanitize_post_field() runs, in this order:

1. 1
   apply_filters( edit_{$field} )filterline 3020 (+55 into the body)

   Filters the value of a specific post field to edit.

2. 2
   apply_filters( {$field_no_prefix}_edit_pre )filterline 3051 (+86 into the body)

   Filters the value of a specific post field to edit.

3. 3
   apply_filters( edit_post_{$field} )filterline 3075 (+110 into the body)

   Filters the value of a specific post field to edit.

4. 4
   apply_filters( pre_{$field} )filterline 3118 (+153 into the body)

   Filters the value of a specific post field before saving.

5. 5
   apply_filters( {$field_no_prefix}_save_pre )filterline 3148 (+183 into the body)

   Filters the value of a specific field before saving.

6. 6
   apply_filters( pre_post_{$field} )filterline 3171 (+206 into the body)

   Filters the value of a specific field before saving.

7. 7
   apply_filters( {$field}_pre )filterline 3194 (+229 into the body)

   Filters the value of a specific post field before saving.

8. 8
   apply_filters( {$field} )filterline 3233 (+268 into the body)

   Filters the value of a specific post field for display.

9. 9
   apply_filters( post_{$field} )filterline 3260 (+295 into the body)

   Filters the value of a specific post field for display.

Uses · 6

• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• format_to_edit()Acts on text which is about to be edited.
• user_can_richedit()Determines whether the user can access the visual editor.
• esc_attr()Escaping for HTML attributes.
• esc_js()Escapes single quotes, `"`, ``, `&`, and fixes line endings.

Used by · 5

• WP_Post::__get()Getter.
• get_post_field()Retrieves data from a post field based on Post ID.
• post_exists()Determines if a post exists based on title, content, date and type.
• sanitize_post()Sanitizes every post field.
• set_post_type()Updates the post type for the post ID.

Source code

View on Trac ↗View on GitHub ↗

2965function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {2966	$int_fields = array( 'ID', 'post_parent', 'menu_order' );2967	if ( in_array( $field, $int_fields, true ) ) {2968		$value = (int) $value;2969	}2970 2971	// Fields which contain arrays of integers.2972	$array_int_fields = array( 'ancestors' );2973	if ( in_array( $field, $array_int_fields, true ) ) {2974		$value = array_map( 'absint', $value );2975		return $value;2976	}2977 2978	if ( 'raw' === $context ) {2979		return $value;2980	}2981 2982	$prefixed = false;2983	if ( str_contains( $field, 'post_' ) ) {2984		$prefixed        = true;2985		$field_no_prefix = str_replace( 'post_', '', $field );2986	}2987 2988	if ( 'edit' === $context ) {2989		$format_to_edit = array( 'post_content', 'post_excerpt', 'post_title', 'post_password' );2990 2991		if ( $prefixed ) {2992 2993			/**2994			 * Filters the value of a specific post field to edit.2995			 *2996			 * The dynamic portion of the hook name, `$field`, refers to the post2997			 * field name. Possible filter names include:2998			 *2999			 *  - `edit_post_author`3000			 *  - `edit_post_date`3001			 *  - `edit_post_date_gmt`3002			 *  - `edit_post_content`3003			 *  - `edit_post_title`3004			 *  - `edit_post_excerpt`3005			 *  - `edit_post_status`3006			 *  - `edit_post_password`3007			 *  - `edit_post_name`3008			 *  - `edit_post_modified`3009			 *  - `edit_post_modified_gmt`3010			 *  - `edit_post_content_filtered`3011			 *  - `edit_post_parent`3012			 *  - `edit_post_type`3013			 *  - `edit_post_mime_type`3014			 *3015			 * @since 2.3.03016			 *3017			 * @param mixed $value   Value of the post field.3018			 * @param int   $post_id Post ID.3019			 */3020			$value = apply_filters( "edit_{$field}", $value, $post_id );3021 3022			/**3023			 * Filters the value of a specific post field to edit.3024			 *3025			 * Only applied to post fields with a name which is prefixed with `post_`.3026			 *3027			 * The dynamic portion of the hook name, `$field_no_prefix`, refers to the3028			 * post field name minus the `post_` prefix. Possible filter names include:3029			 *3030			 *  - `author_edit_pre`3031			 *  - `date_edit_pre`3032			 *  - `date_gmt_edit_pre`3033			 *  - `content_edit_pre`3034			 *  - `title_edit_pre`3035			 *  - `excerpt_edit_pre`3036			 *  - `status_edit_pre`3037			 *  - `password_edit_pre`3038			 *  - `name_edit_pre`3039			 *  - `modified_edit_pre`3040			 *  - `modified_gmt_edit_pre`3041			 *  - `content_filtered_edit_pre`3042			 *  - `parent_edit_pre`3043			 *  - `type_edit_pre`3044			 *  - `mime_type_edit_pre`

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.