sanitize_category_field() WordPress Function
The sanitize_category_field() function is used to sanitize a category field. It takes three parameters: the field to sanitize, the sanitization type (e.g. 'text' or 'url'), and an optional array of options. The function returns a sanitized string.
sanitize_category_field( string $field, mixed $value, int $cat_id, string $context ) #
Sanitizes data in single category key field.
Parameters
- $field
(string)(Required)Category key to sanitize.
- $value
(mixed)(Required)Category value to sanitize.
- $cat_id
(int)(Required)Category ID.
- $context
(string)(Required)What filter to use, 'raw', 'display', etc.
Return
(mixed) Same type as $value after $value has been sanitized.
Source
File: wp-includes/category.php
function sanitize_category_field( $field, $value, $cat_id, $context ) {
return sanitize_term_field( $field, $value, $cat_id, 'category', $context );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.3.0 | Introduced. |