inject_ignored_hooked_blocks_metadata_attributes( stdClass $changes, WP_REST_Request $deprecated = null ): stdClass|WP_Error

Description

Compatibility

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

Parameters

$changesstdClass

An object representing a template or template part prepared for inserting or updating the database.

$deprecatedWP_REST_Requestoptional

Deprecated. Not used.Default: null

Return value

stdClass|WP_Error

The updated object representing a template or template part.

Performance profile

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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

48–187

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

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

• querycontent queryget_post()called directly
• serializeserialisationjson_decode()called directly
• hookthird-party callbacksdo_action()one call below inject_ignored_hooked_blocks_metadata_attributes()
• cacheobject cachewp_cache_add()one call below inject_ignored_hooked_blocks_metadata_attributes()
• optionoption read or writeget_option()one call below inject_ignored_hooked_blocks_metadata_attributes()

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

What one call costs · 120 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 18

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• get_hooked_blocks()Retrieves block types hooked into the given block, grouped by anchor block type and the relative position.
• has_filter()Checks if any filter has been registered for a hook.
• get_post()Retrieves post data given a post ID or post object.
• wp_is_post_revision()Determines if the specified post is a revision.
• get_the_terms()Retrieves the terms of the taxonomy that are attached to the post.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• current_time()Retrieves the current time based on specified type.
• get_current_user_id()Gets the current user's ID.
• _build_block_template_object_from_post_object()Builds a block template object from a post object.
• get_post_meta()Retrieves a post meta field for the given post ID.
• get_comment_delimited_block_content()Returns the content of a block, including comment delimiters.

Source code

View on Trac ↗View on GitHub ↗

1700function inject_ignored_hooked_blocks_metadata_attributes( $changes, $deprecated = null ) {1701	if ( null !== $deprecated ) {1702		_deprecated_argument( __FUNCTION__, '6.5.3' );1703	}1704 1705	if ( ! isset( $changes->post_content ) ) {1706		return $changes;1707	}1708 1709	$hooked_blocks = get_hooked_blocks();1710	if ( empty( $hooked_blocks ) && ! has_filter( 'hooked_block_types' ) ) {1711		return $changes;1712	}1713 1714	$meta  = $changes->meta_input ?? array();1715	$terms = $changes->tax_input ?? array();1716 1717	if ( empty( $changes->ID ) ) {1718		// There's no post object for this template in the database for this template yet.1719		$post = $changes;1720	} else {1721		// Find the existing post object.1722		$post = get_post( $changes->ID );1723 1724		// If the post is a revision, use the parent post's post_name and post_type.1725		$post_id = wp_is_post_revision( $post );1726		if ( $post_id ) {1727			$parent_post     = get_post( $post_id );1728			$post->post_name = $parent_post->post_name;1729			$post->post_type = $parent_post->post_type;1730		}1731 1732		// Apply the changes to the existing post object.1733		$post = (object) array_merge( (array) $post, (array) $changes );1734 1735		$type_terms        = get_the_terms( $changes->ID, 'wp_theme' );1736		$terms['wp_theme'] = ! is_wp_error( $type_terms ) && ! empty( $type_terms ) ? $type_terms[0]->name : null;1737	}1738 1739	// Required for the WP_Block_Template. Update the post object with the current time.1740	$post->post_modified = current_time( 'mysql' );1741 1742	/*1743	 * If the post_author is empty, set it to the current user. If it arrived as1744	 * an int (e.g. from a REST controller), normalize it to a string, since the1745	 * resulting object is passed to new WP_Post().1746	 */1747	if ( empty( $post->post_author ) ) {1748		$post->post_author = (string) get_current_user_id();1749	} elseif ( is_int( $post->post_author ) ) {1750		$post->post_author = (string) $post->post_author;1751	}1752 1753	if ( 'wp_template_part' === $post->post_type && ! isset( $terms['wp_template_part_area'] ) ) {1754		$area_terms                     = get_the_terms( $changes->ID, 'wp_template_part_area' );1755		$terms['wp_template_part_area'] = ! is_wp_error( $area_terms ) && ! empty( $area_terms ) ? $area_terms[0]->name : null;1756	}1757 1758	$template = _build_block_template_object_from_post_object( new WP_Post( $post ), $terms, $meta );1759 1760	if ( is_wp_error( $template ) ) {1761		return $template;1762	}1763 1764	if ( 'wp_template_part' === $post->post_type ) {1765		$attributes                     = array();1766		$existing_ignored_hooked_blocks = isset( $post->ID ) ? get_post_meta( $post->ID, '_wp_ignored_hooked_blocks', true ) : '';1767 1768		if ( ! empty( $existing_ignored_hooked_blocks ) ) {1769			$attributes['metadata'] = array(1770				'ignoredHookedBlocks' => json_decode( $existing_ignored_hooked_blocks, true ),1771			);1772		}1773 1774		$content               = get_comment_delimited_block_content(1775			'core/template-part',1776			$attributes,1777			$changes->post_content1778		);1779		$content               = apply_block_hooks_to_content( $content, $template, 'set_ignored_hooked_blocks_metadata' );

Changelog

Introduced in 6.5.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-template-utils.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.