sanitize_user_field( string $field, mixed $value, int $user_id, string $context ): 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 user Object field name.

$valuemixed

The user Object value.

$user_idint

User ID.

$contextstring

How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display', 'attribute' and 'js'.

Return value

mixed

Sanitized value.

Performance profile

How much work a call to sanitize_user_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

9–52

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

Plugin surface

6 hooks

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

Called by

2

2 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 · 18 distinct outcomes

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

Hooks and filters fired · 6

6 hooks fire while sanitize_user_field() runs, in this order:

1. 1
   apply_filters( edit_{$field} )filterline 1918 (+20 into the body)

   Filters the value of a specific post field to edit.

2. 2
   apply_filters( edit_user_{$field} )filterline 1932 (+34 into the body)

   Filters a user field value in the 'edit' context.

3. 3
   apply_filters( pre_{$field} )filterline 1943 (+45 into the body)

   Filters the value of a specific post field before saving.

4. 4
   apply_filters( pre_user_{$field} )filterline 1956 (+58 into the body)

   Filters the value of a user field in the 'db' context.

5. 5
   apply_filters( {$field} )filterline 1963 (+65 into the body)

   Filters the value of a specific post field for display.

6. 6
   apply_filters( user_{$field} )filterline 1978 (+80 into the body)

   Filters the value of a user field in a standard context.

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.
• esc_html()Escaping for HTML blocks.
• esc_attr()Escaping for HTML attributes.
• esc_url()Checks and cleans a URL.
• esc_js()Escapes single quotes, `"`, ``, `&`, and fixes line endings.

Used by · 2

• WP_User::__get()Magic method for accessing custom fields.
• sanitize_user_object()Sanitize every user field.

Source code

View on Trac ↗View on GitHub ↗

1898function sanitize_user_field( $field, $value, $user_id, $context ) {1899	$int_fields = array( 'ID' );1900	if ( in_array( $field, $int_fields, true ) ) {1901		$value = (int) $value;1902	}1903 1904	if ( 'raw' === $context ) {1905		return $value;1906	}1907 1908	if ( ! is_string( $value ) && ! is_numeric( $value ) ) {1909		return $value;1910	}1911 1912	$prefixed = str_contains( $field, 'user_' );1913 1914	if ( 'edit' === $context ) {1915		if ( $prefixed ) {1916 1917			/** This filter is documented in wp-includes/post.php */1918			$value = apply_filters( "edit_{$field}", $value, $user_id );1919		} else {1920 1921			/**1922			 * Filters a user field value in the 'edit' context.1923			 *1924			 * The dynamic portion of the hook name, `$field`, refers to the prefixed user1925			 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.1926			 *1927			 * @since 2.9.01928			 *1929			 * @param mixed $value   Value of the prefixed user field.1930			 * @param int   $user_id User ID.1931			 */1932			$value = apply_filters( "edit_user_{$field}", $value, $user_id );1933		}1934 1935		if ( 'description' === $field ) {1936			$value = esc_html( $value ); // textarea_escaped?1937		} else {1938			$value = esc_attr( $value );1939		}1940	} elseif ( 'db' === $context ) {1941		if ( $prefixed ) {1942			/** This filter is documented in wp-includes/post.php */1943			$value = apply_filters( "pre_{$field}", $value );1944		} else {1945 1946			/**1947			 * Filters the value of a user field in the 'db' context.1948			 *1949			 * The dynamic portion of the hook name, `$field`, refers to the prefixed user1950			 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.1951			 *1952			 * @since 2.9.01953			 *1954			 * @param mixed $value Value of the prefixed user field.1955			 */1956			$value = apply_filters( "pre_user_{$field}", $value );1957		}1958	} else {1959		// Use display filters by default.1960		if ( $prefixed ) {1961 1962			/** This filter is documented in wp-includes/post.php */1963			$value = apply_filters( "{$field}", $value, $user_id, $context );1964		} else {1965 1966			/**1967			 * Filters the value of a user field in a standard context.1968			 *1969			 * The dynamic portion of the hook name, `$field`, refers to the prefixed user1970			 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.1971			 *1972			 * @since 2.9.01973			 *1974			 * @param mixed  $value   The user object value to sanitize.1975			 * @param int    $user_id User ID.1976			 * @param string $context The context to filter within.1977			 */

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.1.0 tag, from src/wp-includes/user.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.