wp_html_custom_data_attribute_name( string $js_dataset_name ): string|null

Description

'data-post-id' === wp_html_custom_data_attribute_name( 'postId' );
'data--before' === wp_html_custom_data_attribute_name( 'Before' );
'data---one---two---' === wp_html_custom_data_attribute_name( '-One--Two---' );

// Not every attribute name will be interpreted as a custom data attribute.
null === wp_html_custom_data_attribute_name( '/not-an-attribute/' );
null === wp_html_custom_data_attribute_name( 'no spaces' );

// Some very surprising names will; for example, a property whose name is the empty string.
'data-' === wp_html_custom_data_attribute_name( '' );

Compatibility

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

Parameters

$js_dataset_namestring

Name of JS dataset property to transform.

Return value

string|null

Corresponding name of an HTML custom data attribute for the given dataset name, if possible to represent in HTML, otherwise null.

Performance profile

How much work a call to wp_html_custom_data_attribute_name() 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

5–32

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

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 · 5 distinct outcomes

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

Source code

View on Trac ↗View on GitHub ↗

4153function wp_html_custom_data_attribute_name( string $js_dataset_name ): ?string {4154	$end = strlen( $js_dataset_name );4155	if ( 0 === $end ) {4156		return 'data-';4157	}4158 4159	/*4160	 * If it contains characters which would end the attribute name parsing then4161	 * something it’s not possible to represent this in HTML.4162	 */4163	if ( strcspn( $js_dataset_name, "=/> \t\f\r\n" ) !== $end ) {4164		return null;4165	}4166 4167	$html_name = 'data-';4168	$at        = 0;4169	$was_at    = $at;4170 4171	while ( $at < $end ) {4172		$next_upper_after = strcspn( $js_dataset_name, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', $at );4173		$next_upper_at    = $at + $next_upper_after;4174		if ( $next_upper_at >= $end ) {4175			break;4176		}4177 4178		$prefix     = substr( $js_dataset_name, $was_at, $next_upper_at - $was_at );4179		$html_name .= strtolower( $prefix );4180		$html_name .= '-' . strtolower( $js_dataset_name[ $next_upper_at ] );4181		$at         = $next_upper_at + 1;4182		$was_at     = $at;4183	}4184 4185	if ( $was_at < $end ) {4186		$html_name .= strtolower( substr( $js_dataset_name, $was_at ) );4187	}4188 4189	return $html_name;4190}

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/script-loader.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.