Function Reference/sanitize key

This page redirects to an external site: https://developer.wordpress.org/reference/functions/sanitize_key/

1 Description
2 Usage
3 Parameters
4 Return Values
5 Examples
6 Notes
- 6.1 Filters
7 Change Log
8 Source File
9 Related
- 9.1 Functions
- 9.2 Filters

Description

Sanitize a string key. Keys are used as internal identifiers.

Lowercase alphanumeric characters, dashes and underscores are allowed. Uppercase characters will be converted to lowercase. After sanitize_key() has done its work, it passes the sanitized key through the sanitize_key filter.

Usage

<code style="color: #000000"><span style="color: #0000BB"><?php sanitize_key</span><span style="color: #007700">( </span><span style="color: #0000BB">$key </span><span style="color: #007700">); </span><span style="color: #0000BB">?></span></code>

Parameters

$key

(string) (required) String key

Default: None

Return Values

(string): Sanitized key

Examples

Notes

Filters

'sanitize_key':
apply_filters( 'sanitize_key', $key, $raw_key )

Change Log

Since: 3.0.0

Source File

sanitize_key() is located in /wp-includes/formatting.php.

Functions

sanitize_key() is in a class of functions that help you sanitize potentially unsafe data which allow you to pass an arbitrary variable and receive the clean version based on data type. Others include:

Codex