WordPress.org

Languages: English • 日本語 (Add your language)

Description

This function makes sure that only the allowed HTML element names, attribute names and attribute values plus only sane HTML entities will occur in $string. You have to remove any slashes from PHP's magic quotes before you call this function.

Usage

 <?php wp_kses($string, $allowed_html, $allowed_protocols); ?> 

Parameters

$string

(string) (required) Content to filter through kses

Default: None

$allowed_html

(array) (required) List of allowed HTML elements

Default: None

$allowed_protocols

(array) (optional) Allow links in $string to these protocols.

Default: The default allowed protocols are http, https, ftp, mailto, news, irc, gopher, nntp, feed, and telnet. This covers all common link protocols, except for javascript, which should not be allowed for untrusted users.

Return

(string) 

Filtered string of HTML.

Examples

Allowed HTML Tags Array

This is an example of how to format an array of allowed HTML tags and attributes.

array(
    'a' => array(
        'href' => array(),
        'title' => array()
    ),
    'br' => array(),
    'em' => array(),
    'strong' => array(),
);

Notes

• KSES is a recursive acronym which stands for “KSES Strips Evil Scripts".

Change Log

• Since: 1.0.0

Source File

wp_kses() is located in wp-includes/kses.php.

Related

• Function: wp_kses()
• Function: wp_kses_post()
• Function: wp_kses_allowed_html()
• Filter Hook: pre_kses

See: Data Validation article for an in-depth discussion of input and output sanitization.