wp_kses_post() – Function | Developer.WordPress.org

wp_kses_post( string $data ): string

Sanitizes content for allowed HTML tags for post content.

Description

Post content refers to the page contents of the ‘post’ type and not $_POST data from forms.

This function expects unslashed data.

Parameters

$datastringrequired: Post content to filter.

Return

string Filtered post content with allowed HTML tags and attributes intact.

Source

function wp_kses_post( $data ) {
	return wp_kses( $data, 'post' );
}

View all references View on Trac View on GitHub

Uses	Description
wp_kses()`wp-includes/kses.php`	Filters text content and strips out disallowed HTML.

Used by	Description
_block_bindings_term_data_get_value()`wp-includes/block-bindings/term-data.php`	Gets value for Term Data source.
wp_admin_notice()`wp-includes/functions.php`	Outputs an admin notice.
WP_Site_Health::get_test_page_cache()`wp-admin/includes/class-wp-site-health.php`	Tests if a full page cache is available.
WP_Widget_Block::update()`wp-includes/widgets/class-wp-widget-block.php`	Handles updating settings for the current Block widget instance.
WP_REST_Pattern_Directory_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php`	Prepare a raw block pattern before it gets output in a REST API response.
WP_Widget_Custom_HTML::update()`wp-includes/widgets/class-wp-widget-custom-html.php`	Handles updating settings for the current Custom HTML widget instance.
install_plugin_information()`wp-admin/includes/plugin-install.php`	Displays plugin information in dialog box form.
do_settings_sections()`wp-admin/includes/template.php`	Prints out all settings sections added to a particular settings page.
wp_add_id3_tag_data()`wp-admin/includes/media.php`	Parses ID3v2, ID3v1, and getID3 comments to extract usable data.
WP_Widget_Text::update()`wp-includes/widgets/class-wp-widget-text.php`	Handles updating settings for the current Text widget instance.
WP_SimplePie_Sanitize_KSES::sanitize()`wp-includes/class-wp-simplepie-sanitize-kses.php`	WordPress SimplePie sanitization using KSES.
WP_Customize_Widgets::sanitize_widget_instance()`wp-includes/class-wp-customize-widgets.php`	Sanitizes a widget instance.

Show 7 more Show less

Changelog

Version	Description
2.9.0	Introduced.

User Contributed Notes

Skip to note 2 content

Pitabas 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -5You must log in to vote on the helpfulness of this note
Display Admin notice

The following example of basic usage of the wp_kses_post() function. We can use it to print the message in the admin screen.
```
if ( ! version_compare( PHP_VERSION, '5.6', '>=' ) ) {
	add_action( 'admin_notices', 'wpdocs_fail_php_version' );
} 

/**
 * Admin notice for minimum PHP version.
 *
 * Warning when the site doesn't have the minimum required PHP version.
 *
 * @since 1.0.0
 *
 * @return void
 */
function wpdocs_fail_php_version() {

	if ( isset( $_GET['activate'] ) ) {
		unset( $_GET['activate'] );
	}

	/* translators: %s: PHP version */
	$message      = sprintf( __( '<strong>My Custom Plugin</strong> requires PHP version %s+, plugin is currently NOT RUNNING.', 'wpdocs-text-domain' ), '5.6' );
	$html_message = sprintf( '<div class="error">%s</div>', wpautop( $message ) );
	echo wp_kses_post( $html_message );
}
```
- This is another example for a plugin when allow HTML in a textarea field. public function field_message() { $opts = $this->get_options(); ?> <textarea name="[message]" rows="3" class="large-text"> <?php } private function render_bar( $opts ) { $message = apply_filters( 'sabw_alert_message', $opts['message'], $opts ); echo ''; echo wp_kses_post( $message ); echo ''; do_action( 'sabw_rendered_alert', $opts ); }
  
  yourallyagency 7 months ago
Log in to add feedback

You must log in before being able to contribute a note or feedback.