W3cubDocs

/WordPress

wp_specialchars_decode( string $string, string|int $quote_style = ENT_NOQUOTES )

Converts a number of HTML entities into their special characters.

Description

Specifically deals with: &, <, >, ", and ‘.

$quote_style can be set to ENT_COMPAT to decode " entities, or ENT_QUOTES to do both " and ‘. Default is ENT_NOQUOTES where no quotes are decoded.

Parameters

$string

(string) (Required) The text which is to be decoded.

$quote_style

(string|int) (Optional) Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old _wp_specialchars() values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES.

Default value: ENT_NOQUOTES

Return

(string) The decoded text without HTML entities.

Source

File: wp-includes/formatting.php 

function wp_specialchars_decode( $string, $quote_style = ENT_NOQUOTES ) {
	$string = (string) $string;

	if ( 0 === strlen( $string ) ) {
		return '';
	}

	// Don't bother if there are no entities - saves a lot of processing.
	if ( strpos( $string, '&' ) === false ) {
		return $string;
	}

	// Match the previous behaviour of _wp_specialchars() when the $quote_style is not an accepted value.
	if ( empty( $quote_style ) ) {
		$quote_style = ENT_NOQUOTES;
	} elseif ( ! in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) ) {
		$quote_style = ENT_QUOTES;
	}

	// More complete than get_html_translation_table( HTML_SPECIALCHARS ).
	$single      = array(
		'&#039;' => '\'',
		'&#x27;' => '\'',
	);
	$single_preg = array(
		'/&#0*39;/'   => '&#039;',
		'/&#x0*27;/i' => '&#x27;',
	);
	$double      = array(
		'&quot;' => '"',
		'&#034;' => '"',
		'&#x22;' => '"',
	);
	$double_preg = array(
		'/&#0*34;/'   => '&#034;',
		'/&#x0*22;/i' => '&#x22;',
	);
	$others      = array(
		'&lt;'   => '<',
		'&#060;' => '<',
		'&gt;'   => '>',
		'&#062;' => '>',
		'&amp;'  => '&',
		'&#038;' => '&',
		'&#x26;' => '&',
	);
	$others_preg = array(
		'/&#0*60;/'   => '&#060;',
		'/&#0*62;/'   => '&#062;',
		'/&#0*38;/'   => '&#038;',
		'/&#x0*26;/i' => '&#x26;',
	);

	if ( ENT_QUOTES === $quote_style ) {
		$translation      = array_merge( $single, $double, $others );
		$translation_preg = array_merge( $single_preg, $double_preg, $others_preg );
	} elseif ( ENT_COMPAT === $quote_style || 'double' === $quote_style ) {
		$translation      = array_merge( $double, $others );
		$translation_preg = array_merge( $double_preg, $others_preg );
	} elseif ( 'single' === $quote_style ) {
		$translation      = array_merge( $single, $others );
		$translation_preg = array_merge( $single_preg, $others_preg );
	} elseif ( ENT_NOQUOTES === $quote_style ) {
		$translation      = $others;
		$translation_preg = $others_preg;
	}

	// Remove zero padding on numeric entities.
	$string = preg_replace( array_keys( $translation_preg ), array_values( $translation_preg ), $string );

	// Replace characters according to translation table.
	return strtr( $string, $translation );
}

Used By

Used By Description
wp-admin/includes/class-wp-automatic-updater.php: WP_Automatic_Updater::send_plugin_theme_email()

Sends an email upon the completion or failure of a plugin or theme background update.
wp-includes/class-wp-recovery-mode-email-service.php: WP_Recovery_Mode_Email_Service::send_recovery_mode_email()

Sends the Recovery Mode email to the site admin email address.
wp-includes/user.php: _wp_privacy_send_request_confirmation_notification()

Notify the site administrator via email when a request is confirmed.
wp-includes/user.php: _wp_privacy_send_erasure_fulfillment_notification()

Notify the user when their erasure request is fulfilled.
wp-includes/user.php: wp_send_user_request()

Send a confirmation request email to confirm an action.
wp-admin/includes/privacy-tools.php: wp_privacy_send_personal_data_export_email()

Send an email to the user with a link to the personal data export file
wp-includes/functions.php: wp_site_admin_email_change_notification()

Send an email to the old site admin email address when the site admin email address changes.
wp-includes/ms-functions.php: update_network_option_new_admin_email()

Send a confirmation request email when a change of network admin email address is attempted.
wp-includes/ms-functions.php: wp_network_admin_email_change_notification()

Send an email to the old network admin email address when the network admin email address changes.
wp-login.php: retrieve_password()

Handles sending password retrieval email to user.
wp-admin/includes/class-wp-automatic-updater.php: WP_Automatic_Updater::send_email()

Sends an email upon the completion or failure of a background core update.
wp-admin/includes/class-wp-automatic-updater.php: WP_Automatic_Updater::send_debug_email()

Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
wp-admin/includes/misc.php: update_option_new_admin_email()

Send a confirmation request email when a change of site admin email address is attempted.
wp-includes/user.php: send_confirmation_on_profile_email()

Send a confirmation request email when a change of user email address is attempted.
wp-admin/includes/user.php: admin_created_user_email()
wp-includes/pluggable.php: wp_password_change_notification()

Notify the blog admin of a user changing password, normally via email.
wp-includes/pluggable.php: wp_new_user_notification()

Email login credentials to a newly-registered user.
wp-includes/pluggable.php: wp_notify_postauthor()

Notify an author (and/or others) of a comment/trackback/pingback on a post.
wp-includes/pluggable.php: wp_notify_moderator()

Notifies the moderator of the site about a new comment that is awaiting approval.
wp-includes/user.php: wp_update_user()

Update a user in the database.
wp-includes/ms-functions.php: wpmu_welcome_user_notification()

Notify a user that their account activation has been successful.
wp-includes/ms-functions.php: wpmu_welcome_notification()

Notify a user that their blog activation has been successful.
wp-includes/ms-functions.php: wpmu_signup_blog_notification()

Send a confirmation request email to a user when they sign up for a new site. The new site will not become active until the confirmation link is clicked.
wp-includes/ms-functions.php: wpmu_signup_user_notification()

Send a confirmation request email to a user when they sign up for a new user account (without signing up for a site at the same time). The user account will not become active until the confirmation link is clicked.
wp-includes/nav-menu.php: wp_update_nav_menu_item()

Save the properties of a menu item or create a new one.

Changelog

Version Description
2.8.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_specialchars_decode