WP_Interactivity_API::extract_directive_value() – Method

Parses and extracts the namespace and reference path from the given directive attribute value.

Description

If the value doesn’t contain an explicit namespace, it returns the default one. If the value contains a JSON object instead of a reference path, the function tries to parse it and return the resulting array. If the value contains strings that represent booleans ("true" and "false"), numbers ("1" and "1.2") or "null", the function also transform them to regular booleans, numbers and null.

Example:

extract_directive_value( 'actions.foo', 'myPlugin' )                      => array( 'myPlugin', 'actions.foo' )
extract_directive_value( 'otherPlugin::actions.foo', 'myPlugin' )         => array( 'otherPlugin', 'actions.foo' )
extract_directive_value( '{ "isOpen": false }', 'myPlugin' )              => array( 'myPlugin', array( 'isOpen' => false ) )
extract_directive_value( 'otherPlugin::{ "isOpen": false }', 'myPlugin' ) => array( 'otherPlugin', array( 'isOpen' => false ) )

Parameters

$directive_valuestring|truerequired: The directive attribute value. It can be true when it’s a boolean attribute.
$default_namespacestring|nulloptional: The default namespace if none is explicitly defined.
Default:null

Return

array An array containing the namespace in the first item and the JSON, the reference path, or null on the second item.

Source


// Checks if there is a server directive processor registered for each directive.
foreach ( $p->get_attribute_names_with_prefix( 'data-wp-' ) as $attribute_name ) {
	if ( ! preg_match(
		/*
		 * This must align with the client-side regex used by the interactivity API.
		 * @see https://github.com/WordPress/gutenberg/blob/ca616014255efbb61f34c10917d52a2d86c1c660/packages/interactivity/src/vdom.ts#L20-L32
		 */
		'/' .
		'^data-wp-' .
		// Match alphanumeric characters including hyphen-separated
		// segments. It excludes underscore intentionally to prevent confusion.
		// E.g., "custom-directive".
		'([a-z0-9]+(?:-[a-z0-9]+)*)' .
		// (Optional) Match '--' followed by any alphanumeric charachters. It
		// excludes underscore intentionally to prevent confusion, but it can
		// contain multiple hyphens. E.g., "--custom-prefix--with-more-info".
		'(?:--([a-z0-9_-]+))?$' .
		'/i',
		$attribute_name
	) ) {
		continue;

View all references View on Trac View on GitHub

Changelog

Version	Description
6.5.0	Introduced.

WP_Interactivity_API::extract_directive_value( string|true $directive_value, string|null $default_namespace = null ): array

In this article

Description

Parameters

Return

Source

Changelog

User Contributed Notes