safecss_filter_attr( string $css, string $deprecated = '' ): string

Parameters

$cssstring

A string of CSS rules, decoded from an HTML style attribute.

$deprecatedstringoptional

Not used.Default: ''

Return

string

Filtered string of CSS rules, needing HTML escaping before sending back to a style attribute.

Hooks fired · 2

2 hooks fire while safecss_filter_attr() runs, in this order:

1. 1
   apply_filters( safe_style_css )filterline 2669 (+21 into the body)

   Filters the list of allowed CSS attributes.

2. 2
   apply_filters( safecss_filter_attr_allow_css )filterline 3058 (+410 into the body)

   Filters the check for unsafe CSS in `safecss_filter_attr`.

Uses · 7

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• wp_kses_no_null()Removes any invalid control characters in a text string.
• wp_allowed_protocols()Retrieves a list of protocols to allow in HTML attributes.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• wp_kses_bad_protocol()Sanitizes a string and removed disallowed URL protocols.

Used by · 10

• WP_Navigation_Block_Renderer::get_overlay_inline_styles()Get overlay inline styles for the navigation block.
• WP_Style_Engine_CSS_Declarations::filter_declaration()Filters a CSS property + value pair.
• WP_Theme_JSON::is_safe_css_declaration()Checks that a declaration provided by the user is safe.
• block_core_gallery_render_dynamic_image()Renders a single `core/image` block for a Gallery block running in dynamic mode, applying the gallery-wide settings that affect how an image renders.
• get_block_core_post_featured_image_overlay_element_markup()Generate markup for the HTML element that will be used for the overlay.
• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.
• render_block_core_post_featured_image()Renders the `core/post-featured-image` block on the server.
• styles_for_block_core_search()Builds an array of inline styles for the search block.
• wp_get_layout_style()Generates the CSS corresponding to the provided layout.
• wp_kses_attr_check()Determines whether an attribute is allowed.

Source

View on Trac ↗View on GitHub ↗

2648function safecss_filter_attr( $css, $deprecated = '' ) {2649	if ( ! empty( $deprecated ) ) {2650		_deprecated_argument( __FUNCTION__, '2.8.1' ); // Never implemented.2651	}2652 2653	$css = wp_kses_no_null( $css );2654	$css = str_replace( array( "\n", "\r", "\t" ), '', $css );2655 2656	$allowed_protocols = wp_allowed_protocols();2657 2658	/** @todo Parse enough CSS to split rules without breaking on things like quoted strings. */2659	$css_array = explode( ';', trim( $css ) );2660 2661	/**2662	 * Filters the list of allowed CSS attributes.2663	 *2664	 * @since 2.8.12665	 * @since 7.1.0 Added support for SVG presentation attributes.2666	 *2667	 * @param string[] $attr Array of allowed CSS attributes.2668	 */2669	$allowed_attr = apply_filters(2670		'safe_style_css',2671		array(2672			'background',2673			'background-color',2674			'background-image',2675			'background-position',2676			'background-repeat',2677			'background-size',2678			'background-attachment',2679			'background-blend-mode',2680 2681			'border',2682			'border-radius',2683			'border-width',2684			'border-color',2685			'border-style',2686			'border-right',2687			'border-right-color',2688			'border-right-style',2689			'border-right-width',2690			'border-bottom',2691			'border-bottom-color',2692			'border-bottom-left-radius',2693			'border-bottom-right-radius',2694			'border-bottom-style',2695			'border-bottom-width',2696			'border-bottom-right-radius',2697			'border-bottom-left-radius',2698			'border-left',2699			'border-left-color',2700			'border-left-style',2701			'border-left-width',2702			'border-top',2703			'border-top-color',2704			'border-top-left-radius',2705			'border-top-right-radius',2706			'border-top-style',2707			'border-top-width',2708			'border-top-left-radius',2709			'border-top-right-radius',2710 2711			'border-spacing',2712			'border-collapse',2713			'caption-side',2714 2715			'columns',2716			'column-count',2717			'column-fill',2718			'column-gap',2719			'column-rule',2720			'column-span',2721			'column-width',2722 2723			'display',2724 2725			'color',2726			'filter',2727			'font',

History

Introduced in 2.8.1. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/kses.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.