wp_render_block_visibility_support( string $block_content, array $block ): string

Compatibility

Present in 3 of the 5 tracked releases, added in 7.0.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$block_contentstring

Rendered block content.

$blockarray

Block object.

Return value

string

Filtered block content.

Performance profile

How much work a call to wp_render_block_visibility_support() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Only touches the object cache, via wp_cache_get().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

12–97

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 130.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• cacheobject cachewp_cache_get()one call below wp_render_block_visibility_support()

Further down the call graph this can also reach hook. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 7 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_render_block_visibility_support() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• block_has_support()Checks whether the current block type supports the feature requested.
• wp_get_global_settings()Gets the settings resulting of merging core, theme, and user data.
• wp_style_engine_get_stylesheet_from_css_rules()Returns compiled CSS from a collection of selectors and declarations.
• WP_Block_Type_Registry::get_instance()::get_registered()
• WP_Block_Type_Registry::get_instance()Utility method to retrieve the main instance of the class.
• WP_Theme_JSON::get_viewport_media_queries()Returns CSS media queries for responsive viewport style states.
• WP_HTML_Tag_Processor::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

20function wp_render_block_visibility_support( $block_content, $block ) {21	$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );22 23	if ( ! $block_type ) {24		return $block_content;25	}26 27	$block_visibility = $block['attrs']['metadata']['blockVisibility'] ?? null;28 29	// Hide the block whenever the value is boolean false, regardless of the30	// block's current visibility support. This prevents blocks that previously31	// supported visibility from unintentionally appearing on the front end32	// after their support was disabled.33	if ( false === $block_visibility ) {34		return '';35	}36 37	if ( ! block_has_support( $block_type, 'visibility', true ) ) {38		return $block_content;39	}40 41	if ( is_array( $block_visibility ) && ! empty( $block_visibility ) ) {42		$viewport_config = $block_visibility['viewport'] ?? null;43 44		if ( ! is_array( $viewport_config ) || empty( $viewport_config ) ) {45			return $block_content;46		}47		$viewport_settings      = wp_get_global_settings( array( 'viewport' ) );48		$viewport_media_queries = WP_Theme_JSON::get_viewport_media_queries(49			$viewport_settings,50			array(51				'include_desktop' => true,52			)53		);54 55		/*56		 * Viewport media queries are keyed by style-state names (`@mobile`,57		 * `@tablet`, and `@desktop`). Block visibility metadata and generated58		 * classes use plain viewport names, so map the keys at this boundary.59		 */60		$block_visibility_media_queries = array();61		foreach ( $viewport_media_queries as $viewport_state => $media_query ) {62			$block_visibility_media_queries[ ltrim( $viewport_state, '@' ) ] = $media_query;63		}64		$viewport_media_queries = $block_visibility_media_queries;65 66		$hidden_on = array();67 68		// Collect which viewport the block is hidden on (only known viewport sizes).69		foreach ( $viewport_config as $viewport_config_size => $is_visible ) {70			if ( false === $is_visible && isset( $viewport_media_queries[ $viewport_config_size ] ) ) {71				$hidden_on[] = $viewport_config_size;72			}73		}74 75		// If no viewport sizes have visibility set to false, return unchanged.76		if ( empty( $hidden_on ) ) {77			return $block_content;78		}79 80		// Maintain consistent order of viewport sizes for class name generation.81		sort( $hidden_on );82 83		$css_rules   = array();84		$class_names = array();85 86		foreach ( $hidden_on as $hidden_viewport_size ) {87			/*88			 * If these values ever become user-defined,89			 * they should be sanitized and kebab-cased.90			 */91			$visibility_class = 'wp-block-hidden-' . $hidden_viewport_size;92			$class_names[]    = $visibility_class;93			$css_rules[]      = array(94				'selector'     => '.' . $visibility_class,95				'declarations' => array(96					'display' => 'none !important',97				),98				'rules_group'  => $viewport_media_queries[ $hidden_viewport_size ],99			);

Changelog

Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.

1. 6.9.7
2. 7.0.4
3. 7.1.0

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

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/block-supports/block-visibility.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.