wp_strip_all_tags()

💡 云策文档标注

概述

wp_strip_all_tags() 是 WordPress 核心函数，用于彻底移除字符串中的所有 HTML 标签，包括 'script' 和 'style' 标签及其内容。与 strip_tags() 不同，它会删除标签内的内容，确保返回纯文本字符串。

关键要点

函数签名：wp_strip_all_tags( $text, $remove_breaks = false )，其中 $text 为必需参数（字符串），$remove_breaks 为可选参数（布尔值，默认 false）。
返回处理后的字符串，如果输入非标量或 null，会触发警告并返回空字符串。
默认应用于多个过滤器，如 pre_comment_author_url、user_url 等，用于在评论、用户 URL 等场景自动清理 HTML。
内部使用正则表达式移除 'script' 和 'style' 标签内容，然后调用 strip_tags() 移除其他标签，可选移除换行和空格。

代码示例

$html = 'I am not strong';
var_dump($html);
// 输出 'I am not strong'

var_dump(wp_strip_all_tags($html));
// 输出 'I am not strong'

注意事项

不能通过简单比较原始字符串和处理后字符串来判断文本是否为 HTML，因为函数返回前会应用 trim()，可能导致误判。建议在比较前对原始字符串也进行 trim() 处理。

📄 原文内容

Properly strips all HTML tags including ‘script’ and ‘style’.

Description

This differs from strip_tags() because it removes the contents of the <script> and <style> tags. E.g. strip_tags( '<script>something</script>' ) will return ‘something’. wp_strip_all_tags() will return an empty string.

Parameters

$textstringrequired: String containing HTML tags
$remove_breaksbooloptional: Whether to remove left over line breaks and white space chars

Default:false

Return

string The processed string.

More Information

wp_strip_all_tags() is added to the following filters by default (see <a class="external text" href="https://core.trac.wordpress.org/browser/tags/5.3/src/wp-includes/default-filters.php#L0" rel="nofollow">wp-includes/default-filters.php</a>):

pre_comment_author_url
pre_user_url
pre_link_url
pre_link_image
pre_link_rss
pre_post_guid

It is also applied to these filters by default when on the administration side of the site:

user_url
link_url
link_image
link_rss
comment_url
post_guid

Source

function wp_strip_all_tags( $text, $remove_breaks = false ) {
	if ( is_null( $text ) ) {
		return '';
	}

	if ( ! is_scalar( $text ) ) {
		/*
		 * To maintain consistency with pre-PHP 8 error levels,
		 * wp_trigger_error() is used to trigger an E_USER_WARNING,
		 * rather than _doing_it_wrong(), which triggers an E_USER_NOTICE.
		 */
		wp_trigger_error(
			'',
			sprintf(
				/* translators: 1: The function name, 2: The argument number, 3: The argument name, 4: The expected type, 5: The provided type. */
				__( 'Warning: %1$s expects parameter %2$s (%3$s) to be a %4$s, %5$s given.' ),
				__FUNCTION__,
				'#1',
				'$text',
				'string',
				gettype( $text )
			),
			E_USER_WARNING
		);

		return '';
	}

	$text = preg_replace( '@<(script|style)[^>]*?>.*?<!--\1-->@si', '', $text );
	$text = strip_tags( $text );

	if ( $remove_breaks ) {
		$text = preg_replace( '/[rnt ]+/', ' ', $text );
	}

	return trim( $text );
}

View all references View on Trac View on GitHub

Uses	Description
wp_trigger_error()`wp-includes/functions.php`	Generates a user-level error/warning/notice/deprecation message.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.

Used by	Description
WP_Font_Face::generate_and_print()`wp-includes/fonts/class-wp-font-face.php`	Generates and prints the `@font-face` styles for the given fonts.
WP_Style_Engine_CSS_Declarations::filter_declaration()`wp-includes/style-engine/class-wp-style-engine-css-declarations.php`	Filters a CSS property + value pair.
WP_REST_URL_Details_Controller::prepare_metadata_for_output()`wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php`	Prepares the metadata by: – stripping all HTML tags and tag entities.
WP_Application_Passwords_List_Table::print_js_template_row()`wp-admin/includes/class-wp-application-passwords-list-table.php`	Prints the JavaScript template for the new row item.
WP_REST_Block_Directory_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-block-directory-controller.php`	Parse block metadata for a block, and prepare it for an API response.
wp_check_comment_disallowed_list()`wp-includes/comment.php`	Checks if a comment contains disallowed characters or words.
Plugin_Installer_Skin::do_overwrite()`wp-admin/includes/class-plugin-installer-skin.php`	Checks if the plugin can be overwritten and outputs the HTML for overwriting a plugin on upload.
Theme_Installer_Skin::do_overwrite()`wp-admin/includes/class-theme-installer-skin.php`	Checks if the theme can be overwritten and outputs the HTML for overwriting a theme on upload.
WP_Recovery_Mode_Email_Service::send_recovery_mode_email()`wp-includes/class-wp-recovery-mode-email-service.php`	Sends the Recovery Mode email to the site admin email address.
_sanitize_text_fields()`wp-includes/formatting.php`	Internal helper function to sanitize a string from user input or from the database.
WP_Screen::render_list_table_columns_preferences()`wp-admin/includes/class-wp-screen.php`	Renders the list table columns preferences.
WP_List_Table::single_row_columns()`wp-admin/includes/class-wp-list-table.php`	Generates the columns for a single row of the table.
WP_Users_List_Table::single_row()`wp-admin/includes/class-wp-users-list-table.php`	Generates HTML for a single row on the users.php admin panel.
media_upload_form_handler()`wp-admin/includes/media.php`	Handles form submissions for the legacy media uploader.
edit_post()`wp-admin/includes/post.php`	Updates an existing post with values provided in `$_POST`.
wp_ajax_save_attachment()`wp-admin/includes/ajax-actions.php`	Handles updating attachment attributes via AJAX.
wp_html_excerpt()`wp-includes/formatting.php`	Safely extracts not more than the first $count characters from HTML string.
wp_trim_words()`wp-includes/formatting.php`	Trims text to a certain number of words.
sanitize_user()`wp-includes/formatting.php`	Sanitizes a username, stripping out unsafe characters.
wp_admin_bar_my_account_item()`wp-includes/admin-bar.php`	Adds the “My Account” item.
wp_setup_nav_menu_item()`wp-includes/nav-menu.php`	Decorates a menu item object with the shared navigation menu item properties.

Show 16 more Show less

Changelog

Version	Description
2.9.0	Introduced.

User Contributed Notes

Skip to note 3 content

Codex

11 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Example
```
$html = '<strong>I am not strong</strong>';
var_dump($html);
//output '<strong>I am not strong</strong>'

var_dump(wp_strip_all_tags($html));
//output 'I am not strong'
```
Log in to add feedback

Skip to note 4 content

Giuseppe

2 years ago

Be aware that wp_strip_all_tags() cannot be used to check if a text is html by a simple comparison between the original string and the parsed string.
The difference is in the trim() applied to the returned value.

function wrong_is_html( $my_string ) {
    return wp_strip_all_tags( $my_string ) !== $my_string ? true : false;
}

function is_html( $my_string ) {
    return wp_strip_all_tags( $my_string ) !== trim ( $my_string ) ? true : false;
}

$a_string = 'this is a simple text string with no html tag, but with an end of line' . PHP_EOL;
if ( true === wrong_is_html( $a_string ) ) {
    echo 'Is HTML';
} else {
    echo 'Is not HTML';
}

if ( true === is_html( $a_string ) ) {
    echo 'Is HTML';
} else {
    echo 'Is not HTML';
}

// outputs 
// Is HTML
// Is not HTML

云策 WordPress 开发者社区

函数文档