1449 

  1450 /**

  1451  * Accepts the serialized markup of a block and its inner blocks, and returns serialized markup of the inner blocks.

  1452  *

  1453  * @since 6.5.0

  1454  *

  1455  * @param string $serialized_block The serialized markup of a block and its inner blocks.

  1456  * @return string

  1457  */

  1458 function block_core_navigation_remove_serialized_parent_block( $serialized_block ) {

  1459 	$start = strpos( $serialized_block, '-->' ) + strlen( '-->' );

  1460 	$end   = strrpos( $serialized_block, '<!--' );

  1461 	return substr( $serialized_block, $start, $end - $start );

  1462 }

  1463 

  1464 /**

  1465  * Mock a parsed block for the Navigation block given its inner blocks and the `wp_navigation` post object.

  1466  * The `wp_navigation` post's `_wp_ignored_hooked_blocks` meta is queried to add the `metadata.ignoredHookedBlocks` attribute.

  1467  *

  1468  * @since 6.5.0

  1469  *

  1470  * @param array   $inner_blocks Parsed inner blocks of a Navigation block.

  1471  * @param WP_Post $post         `wp_navigation` post object corresponding to the block.

  1472  *

  1473  * @return array the normalized parsed blocks.

  1474  */

  1475 function block_core_navigation_mock_parsed_block( $inner_blocks, $post ) {

  1476 	$attributes = array();

  1477 

  1478 	if ( isset( $post->ID ) ) {

  1479 		$ignored_hooked_blocks = get_post_meta( $post->ID, '_wp_ignored_hooked_blocks', true );

  1480 		if ( ! empty( $ignored_hooked_blocks ) ) {

  1481 			$ignored_hooked_blocks  = json_decode( $ignored_hooked_blocks, true );

  1482 			$attributes['metadata'] = array(

  1483 				'ignoredHookedBlocks' => $ignored_hooked_blocks,

  1484 			);

  1485 		}

  1486 	}

  1487 

  1488 	$mock_anchor_parent_block = array(

  1489 		'blockName'    => 'core/navigation',

  1490 		'attrs'        => $attributes,

  1491 		'innerBlocks'  => $inner_blocks,

  1492 		'innerContent' => array_fill( 0, count( $inner_blocks ), null ),

  1493 	);

  1494 

  1495 	return $mock_anchor_parent_block;

  1496 }

  1497 

  1498 /**

  1499  * Insert hooked blocks into a Navigation block.

  1500  *

  1501  * Given a Navigation block's inner blocks and its corresponding `wp_navigation` post object,

  1502  * this function inserts hooked blocks into it, and returns the serialized inner blocks in a

  1503  * mock Navigation block wrapper.

  1504  *

  1505  * If there are any hooked blocks that need to be inserted as the Navigation block's first or last

  1506  * children, the `wp_navigation` post's `_wp_ignored_hooked_blocks` meta is checked to see if any

  1507  * of those hooked blocks should be exempted from insertion.

  1508  *

  1509  * @since 6.5.0

  1510  *

  1511  * @param array   $inner_blocks Parsed inner blocks of a Navigation block.

  1512  * @param WP_Post $post         `wp_navigation` post object corresponding to the block.

  1513  * @return string Serialized inner blocks in mock Navigation block wrapper, with hooked blocks inserted, if any.

  1514  */

  1515 function block_core_navigation_insert_hooked_blocks( $inner_blocks, $post ) {

  1516 	$mock_navigation_block = block_core_navigation_mock_parsed_block( $inner_blocks, $post );

  1517 	$hooked_blocks         = get_hooked_blocks();

  1518 	$before_block_visitor  = null;

  1519 	$after_block_visitor   = null;

  1520 

  1521 	if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {

  1522 		$before_block_visitor = make_before_block_visitor( $hooked_blocks, $post, 'insert_hooked_blocks' );

  1523 		$after_block_visitor  = make_after_block_visitor( $hooked_blocks, $post, 'insert_hooked_blocks' );

  1524 	}

  1525 

  1526 	return traverse_and_serialize_block( $mock_navigation_block, $before_block_visitor, $after_block_visitor );

  1527 }

  1528 

  1529 /**

  1530  * Insert ignoredHookedBlocks meta into the Navigation block and its inner blocks.

  1531  *

  1532  * Given a Navigation block's inner blocks and its corresponding `wp_navigation` post object,

  1533  * this function inserts ignoredHookedBlocks meta into it, and returns the serialized inner blocks in a

  1534  * mock Navigation block wrapper.

  1535  *

  1536  * @since 6.5.0

  1537  *

  1538  * @param array   $inner_blocks Parsed inner blocks of a Navigation block.

  1539  * @param WP_Post $post         `wp_navigation` post object corresponding to the block.

  1540  * @return string Serialized inner blocks in mock Navigation block wrapper, with hooked blocks inserted, if any.

  1541  */

  1542 function block_core_navigation_set_ignored_hooked_blocks_metadata( $inner_blocks, $post ) {

  1543 	$mock_navigation_block = block_core_navigation_mock_parsed_block( $inner_blocks, $post );

  1544 	$hooked_blocks         = get_hooked_blocks();

  1545 	$before_block_visitor  = null;

  1546 	$after_block_visitor   = null;

  1547 

  1548 	if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {

  1549 		$before_block_visitor = make_before_block_visitor( $hooked_blocks, $post, 'set_ignored_hooked_blocks_metadata' );

  1550 		$after_block_visitor  = make_after_block_visitor( $hooked_blocks, $post, 'set_ignored_hooked_blocks_metadata' );

  1551 	}

  1552 

  1553 	return traverse_and_serialize_block( $mock_navigation_block, $before_block_visitor, $after_block_visitor );

  1554 }

  1555 

  1556 /**

  1557  * Updates the post meta with the list of ignored hooked blocks when the navigation is created or updated via the REST API.

  1558  *

  1559  * @access private

  1560  * @since 6.5.0

  1561  *

  1562  * @param stdClass $post Post object.

  1563  * @return stdClass The updated post object.

  1564  */

  1565 function block_core_navigation_update_ignore_hooked_blocks_meta( $post ) {

  1566 	/*

  1567 	 * In this scenario the user has likely tried to create a navigation via the REST API.

  1568 	 * In which case we won't have a post ID to work with and store meta against.

  1569 	 */

  1570 	if ( empty( $post->ID ) ) {

  1571 		return $post;

  1572 	}

  1573 

  1574 	/**

  1575 	 * Skip meta generation when consumers intentionally update specific Navigation fields

  1576 	 * and omit the content update.

  1577 	 */

  1578 	if ( ! isset( $post->post_content ) ) {

  1579 		return $post;

  1580 	}

  1581 

  1582 	/*

  1583 	 * We run the Block Hooks mechanism to inject the `metadata.ignoredHookedBlocks` attribute into

  1584 	 * all anchor blocks. For the root level, we create a mock Navigation and extract them from there.

  1585 	 */

  1586 	$blocks = parse_blocks( $post->post_content );

  1587 

  1588 	/*

  1589 	 * Block Hooks logic requires a `WP_Post` object (rather than the `stdClass` with the updates that

  1590 	 * we're getting from the `rest_pre_insert_wp_navigation` filter) as its second argument (to be

  1591 	 * used as context for hooked blocks insertion).

  1592 	 * We thus have to look it up from the DB,based on `$post->ID`.

  1593 	 */

  1594 	$markup = block_core_navigation_set_ignored_hooked_blocks_metadata( $blocks, get_post( $post->ID ) );

  1595 

  1596 	$root_nav_block        = parse_blocks( $markup )[0];

  1597 	$ignored_hooked_blocks = isset( $root_nav_block['attrs']['metadata']['ignoredHookedBlocks'] )

  1598 		? $root_nav_block['attrs']['metadata']['ignoredHookedBlocks']

  1599 		: array();

  1600 

  1601 	if ( ! empty( $ignored_hooked_blocks ) ) {

  1602 		$existing_ignored_hooked_blocks = get_post_meta( $post->ID, '_wp_ignored_hooked_blocks', true );

  1603 		if ( ! empty( $existing_ignored_hooked_blocks ) ) {

  1604 			$existing_ignored_hooked_blocks = json_decode( $existing_ignored_hooked_blocks, true );

  1605 			$ignored_hooked_blocks          = array_unique( array_merge( $ignored_hooked_blocks, $existing_ignored_hooked_blocks ) );

  1606 		}

  1607 		update_post_meta( $post->ID, '_wp_ignored_hooked_blocks', json_encode( $ignored_hooked_blocks ) );

  1608 	}

  1609 

  1610 	$post->post_content = block_core_navigation_remove_serialized_parent_block( $markup );

  1611 	return $post;

  1612 }

  1613 

  1614 /*

  1615  * Before adding our filter, we verify if it's already added in Core.

  1616  * However, during the build process, Gutenberg automatically prefixes our functions with "gutenberg_".

  1617  * Therefore, we concatenate the Core's function name to circumvent this prefix for our check.

  1618  */

  1619 $rest_insert_wp_navigation_core_callback = 'block_core_navigation_' . 'update_ignore_hooked_blocks_meta'; // phpcs:ignore Generic.Strings.UnnecessaryStringConcat.Found

  1620 

  1621 /*

  1622  * Do not add the `block_core_navigation_update_ignore_hooked_blocks_meta` filter in the following cases:

  1623  * - If Core has added the `update_ignored_hooked_blocks_postmeta` filter already (WP >= 6.6);

  1624  * - or if the `set_ignored_hooked_blocks_metadata` function is unavailable (which is required for the filter to work. It was introduced by WP 6.5 but is not present in Gutenberg's WP 6.5 compatibility layer);

  1625  * - or if the `$rest_insert_wp_navigation_core_callback` filter has already been added.

  1626  */

  1627 if (

  1628 	! has_filter( 'rest_pre_insert_wp_navigation', 'update_ignored_hooked_blocks_postmeta' ) &&

  1629 	function_exists( 'set_ignored_hooked_blocks_metadata' ) &&

  1630 	! has_filter( 'rest_pre_insert_wp_navigation', $rest_insert_wp_navigation_core_callback )

  1631 ) {

  1632 	add_filter( 'rest_pre_insert_wp_navigation', 'block_core_navigation_update_ignore_hooked_blocks_meta' );

  1633 }

  1634 

  1635 /*

  1636  * Previous versions of Gutenberg were attaching the block_core_navigation_update_ignore_hooked_blocks_meta

  1637  * function to the `rest_insert_wp_navigation` _action_ (rather than the `rest_pre_insert_wp_navigation` _filter_).

  1638  * To avoid collisions, we need to remove the filter from that action if it's present.

  1639  */

  1640 if ( has_filter( 'rest_insert_wp_navigation', $rest_insert_wp_navigation_core_callback ) ) {

  1641 	remove_filter( 'rest_insert_wp_navigation', $rest_insert_wp_navigation_core_callback );

  1642 }

  1643 

  1644 /**

  1645  * Hooks into the REST API response for the core/navigation block and adds the first and last inner blocks.

  1646  *

  1647  * @since 6.5.0

  1648  *

  1649  * @param WP_REST_Response $response The response object.

  1650  * @param WP_Post          $post     Post object.

  1651  * @return WP_REST_Response The response object.

  1652  */

  1653 function block_core_navigation_insert_hooked_blocks_into_rest_response( $response, $post ) {

  1654 	if ( ! isset( $response->data['content']['raw'] ) || ! isset( $response->data['content']['rendered'] ) ) {

  1655 		return $response;

  1656 	}

  1657 	$parsed_blocks = parse_blocks( $response->data['content']['raw'] );

  1658 	$content       = block_core_navigation_insert_hooked_blocks( $parsed_blocks, $post );

  1659 

  1660 	// Remove mock Navigation block wrapper.

  1661 	$content = block_core_navigation_remove_serialized_parent_block( $content );

  1662 

  1663 	$response->data['content']['raw'] = $content;

  1664 

  1665 	/** This filter is documented in wp-includes/post-template.php */

  1666 	$response->data['content']['rendered'] = apply_filters( 'the_content', $content );

  1667 

  1668 	return $response;

  1669 }

  1670 

  1671 /*

  1672  *  Before adding our filter, we verify if it's already added in Core.

  1673  * However, during the build process, Gutenberg automatically prefixes our functions with "gutenberg_".

  1674  * Therefore, we concatenate the Core's function name to circumvent this prefix for our check.

  1675  */

  1676 $rest_prepare_wp_navigation_core_callback = 'block_core_navigation_' . 'insert_hooked_blocks_into_rest_response';

  1677 

  1678 /*

  1679  * Do not add the `block_core_navigation_insert_hooked_blocks_into_rest_response` filter in the following cases:

  1680  * - If Core has added the `insert_hooked_blocks_into_rest_response` filter already (WP >= 6.6);

  1681  * - or if the `set_ignored_hooked_blocks_metadata` function is unavailable (which is required for the filter to work. It was introduced by WP 6.5 but is not present in Gutenberg's WP 6.5 compatibility layer);

  1682  * - or if the `$rest_prepare_wp_navigation_core_callback` filter has already been added.

  1683  */

  1684 if (

  1685 	! has_filter( 'rest_prepare_wp_navigation', 'insert_hooked_blocks_into_rest_response' ) &&

  1686 	function_exists( 'set_ignored_hooked_blocks_metadata' ) &&

  1687 	! has_filter( 'rest_prepare_wp_navigation', $rest_prepare_wp_navigation_core_callback )

  1688 ) {

  1689 	add_filter( 'rest_prepare_wp_navigation', 'block_core_navigation_insert_hooked_blocks_into_rest_response', 10, 3 );

  1690 }