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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

12–88

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

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 one call costs · 6 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 · 5

• block_has_support()Checks whether the current block type supports the feature requested.
• 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_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		/*48		 * Viewport size definitions are in several places in WordPress packages.49		 * The following are taken from: https://github.com/WordPress/gutenberg/blob/trunk/packages/base-styles/_breakpoints.scss50		 * The array is in a future, potential JSON format, and will be centralized51		 * as the feature is developed.52		 *53		 * Viewport sizes as array items are defined sequentially. The first item's size is the max value.54		 * Each subsequent item starts after the previous size (using > operator), and its size is the max.55		 * The last item starts after the previous size (using > operator), and it has no max.56		 */57		$viewport_sizes = array(58			array(59				'name' => 'Mobile',60				'slug' => 'mobile',61				'size' => '480px',62			),63			array(64				'name' => 'Tablet',65				'slug' => 'tablet',66				'size' => '782px',67			),68			array(69				'name' => 'Desktop',70				'slug' => 'desktop',71				/*72				 * Note: the last item in the $viewport_sizes array does not technically require a 'size' key,73				 * as the last item's media query is calculated using `width > previous size`.74				 * The last item is present for validating the attribute values, and in order to indicate75				 * that this is the final viewport size, and to calculate the previous media query accordingly.76				 */77			),78		);79 80		/*81		 * Build media queries from viewport size definitions using the CSS range syntax.82		 * Could be absorbed into the style engine,83		 * as well as classname building, and declaration of the display property, if required.84		 */85		$viewport_media_queries = array();86		$previous_size          = null;87		foreach ( $viewport_sizes as $index => $viewport_size ) {88			// First item: width <= size.89			if ( 0 === $index ) {90				$viewport_media_queries[ $viewport_size['slug'] ] = "@media (width <= {$viewport_size['size']})";91			} elseif ( count( $viewport_sizes ) - 1 === $index && $previous_size ) {92				// Last item: width > previous size.93				$viewport_media_queries[ $viewport_size['slug'] ] = "@media (width > $previous_size)";94			} else {95				// Middle items: previous size < width <= size.96				$viewport_media_queries[ $viewport_size['slug'] ] = "@media ({$previous_size} < width <= {$viewport_size['size']})";97			}98 99			$previous_size = $viewport_size['size'] ?? null;

Changelog

Introduced in 6.9.0. Unchanged from 6.9.10 through 7.1.3.

1. 6.9.10
2. 7.0.7
3. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 7.0.7 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.