WordPress.org

Function Reference/wp specialchars

Description

This function is deprecated as of WordPress 2.8.0. Please use esc_html instead.

Converts a number of special characters into their HTML entities.

Differs from htmlspecialchars as existing HTML entities will not be encoded. Specifically changes: & to &, < to < and > to >.

$quotes can be set to 'single' to encode ' to ', 'double' to encode " to ", or '1' to do both. Default is 0 where no quotes are encoded.

Usage

<?php wp_specialchars( $text, $quotes ) ?>

Parameters

$text

(string) (required) The text which is to be encoded.

Default: None

$quotes

(mixed) (optional) Converts single quotes if set to 'single', double if set to 'double' or both if otherwise set.

Default: 0

Return Values

(string): The encoded text with HTML entities.

Examples

Notes

htmlspecialchars (noted in the description) is a PHP built-in function.

Change Log

Since: 1.2.2

Source File

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

WordPress.org

Codex

Function Reference/wp specialchars

Contents