Silence notices when searching for context nodes (#6)

sirreal · web-flow · commit b97aa9b75796 · 2025-07-22T12:06:43.000+02:00
diff --git a/html-api-debugger/html-api-integration.php b/html-api-debugger/html-api-integration.php
@@ -37,9 +37,11 @@ function get_normalized_html( string $html, array $options ): ?string {
 	) {
 		$context_processor = WP_HTML_Processor::create_full_parser( $options['context_html'] );
 
+		add_filter( 'doing_it_wrong_trigger_error', __NAMESPACE__ . '\filter_doing_it_wrong_trigger_error', 10, 2 );
 		while ( $context_processor->next_tag() ) {
 			$context_processor->set_bookmark( 'final_node' );
 		}
+		remove_filter( 'doing_it_wrong_trigger_error', __NAMESPACE__ . '\filter_doing_it_wrong_trigger_error', 10 );
 		if ( $context_processor->has_bookmark( 'final_node' ) ) {
 			$context_processor->seek( 'final_node' );
 			/**
@@ -119,6 +121,7 @@ function get_tree( string $html, array $options ): array {
 	) {
 		$context_processor = WP_HTML_Processor::create_full_parser( $options['context_html'] );
 
+		add_filter( 'doing_it_wrong_trigger_error', __NAMESPACE__ . '\filter_doing_it_wrong_trigger_error', 10, 2 );
 		while ( $context_processor->next_token() ) {
 			switch ( $context_processor->get_token_type() ) {
 				case '#doctype':
@@ -140,6 +143,7 @@ function get_tree( string $html, array $options ): array {
 					break;
 			}
 		}
+		remove_filter( 'doing_it_wrong_trigger_error', __NAMESPACE__ . '\filter_doing_it_wrong_trigger_error', 10 );
 
 		if ( $document_title === null ) {
 			$document_title = '';
@@ -473,6 +477,22 @@ function get_tree( string $html, array $options ): array {
 	);
 }
 
+/**
+ * Prevent set_bookmark on virtual context nodes from triggering a doing_it_wrong error.
+ * A context like `<body>` would trigger due to virtual nodes like `<head>` being created
+ * and bookmarked.
+ * Remove the noise when searching for context nodes.
+ *
+ * @param bool   $trigger_error Whether to trigger a doing_it_wrong error.
+ * @param string $function_name The name of the function being called.
+ */
+function filter_doing_it_wrong_trigger_error( $trigger_error, $function_name ) {
+	if ( $function_name === 'WP_HTML_Processor::set_bookmark' ) {
+		return false;
+	}
+	return $trigger_error;
+}
+
 const NODE_TYPE_ELEMENT                = 1;
 const NODE_TYPE_ATTRIBUTE              = 2;
 const NODE_TYPE_TEXT                   = 3;
diff --git a/html-api-debugger/readme.txt b/html-api-debugger/readme.txt
@@ -15,6 +15,9 @@ Please file issues and pull requests on the [GitHub repository](https://github.c
 
 == Changelog ==
 
+= 2.8 =
+* Silence _doing_it_wrong bookmark notices when providing from HTML context.
+
 = 2.7 =
 * Preserve attribute value line breaks in tree views.
 * Prevent plugin module from being enqueued on all pages.
