Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HTML API: Remove nullable from get_breadcrumbs return type #7984

Closed
wants to merge 2 commits into from
+3 −7
Closed

HTML API: Remove nullable from get_breadcrumbs return type #7984

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
329df9b
Update non-nullable return type on get_breadcrumbs
sirreal Dec 10, 2024
3ad6269
Remove stale todo comment
sirreal Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions src/wp-includes/html-api/class-wp-html-processor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1141,21 +1141,17 @@ public function step( $node_to_process = self::PROCESS_NEXT_NODE ): bool {
* Breadcrumbs start at the outermost parent and descend toward the matched element.
* They always include the entire path from the root HTML node to the matched element.
*
* @todo It could be more efficient to expose a generator-based version of this function
sirreal marked this conversation as resolved.
Show resolved Hide resolved
* to avoid creating the array copy on tag iteration. If this is done, it would likely
* be more useful to walk up the stack when yielding instead of starting at the top.
*
* Example
* Example:
*
* $processor = WP_HTML_Processor::create_fragment( '<p><strong><em><img></em></strong></p>' );
* $processor->next_tag( 'IMG' );
* $processor->get_breadcrumbs() === array( 'HTML', 'BODY', 'P', 'STRONG', 'EM', 'IMG' );
*
* @since 6.4.0
*
* @return string[]|null Array of tag names representing path to matched node, if matched, otherwise NULL.
* @return string[] Array of tag names representing path to matched node.
*/
public function get_breadcrumbs(): ?array {
public function get_breadcrumbs(): array {
return $this->breadcrumbs;
}

Expand Down
Loading