wppaste
WordPress

wp_has_border_feature_support( WP_Block_Type $block_type, string $feature, mixed $default_value = false ): bool

Since
5.8.0
Source
wp-includes/block-supports/border.php:153
Checks whether the current block type supports the border feature requested.

Description

If the __experimentalBorder support flag is a boolean true all border support features are available. Otherwise, the specific feature's support flag nested under experimentalBorder must be enabled for the feature to be opted into.

Compatibility

WordPress
since 5.8.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$block_typeWP_Block_Type
Block type to check for support.
$featurestring
Name of the feature to check support for.
$default_valuemixedoptional
Fallback value for feature support, defaults to false.Default: false

Return value

bool
Whether the feature is supported.

Performance profile

How much work a call to wp_has_border_feature_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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
12–20

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

2 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
$block_type instanceof && $block_type_supports_border === true12–13none
always13–20__experimentalBorder()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 21 instructions, 12–20 executed per call, 3 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Used by · 2

  • wp_apply_border_support()Adds CSS classes and inline styles for border styles to the incoming attributes array. This will be applied to the block markup in the front-end.
  • wp_register_border_support()Registers the style attribute used by the border feature if needed for block types that support borders.

Source code

function wp_has_border_feature_support( $block_type, $feature, $default_value = false ) {	// Check if all border support features have been opted into via `"__experimentalBorder": true`.	if ( $block_type instanceof WP_Block_Type ) {		$block_type_supports_border = $block_type->supports['__experimentalBorder'] ?? $default_value;		if ( true === $block_type_supports_border ) {			return true;		}	} 	// Check if the specific feature has been opted into individually	// via nested flag under `__experimentalBorder`.	return block_has_support( $block_type, array( '__experimentalBorder', $feature ), $default_value );}

Changelog

Introduced in 5.8.0. 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/block-supports/border.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.