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.

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

Conversation

sirreal
Copy link
Member

@sirreal sirreal commented Dec 10, 2024

Remove nullable from the WP_HTML_Processor::get_breadcrumbs() return function signature and PHPDoc types.

The return type of breadcrumbs has not be nullable since [58713] HTML API: Simplify breadcrumb accounting.

Trac ticket: https://core.trac.wordpress.org/ticket/62674


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

This method is a getter for the breadcrumbs property, an array value.
This comment mentions using a generator for breadcrumbs,
but breadcrumbs are no longer calculated on the fly, so
the comment is outdated.
Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@sirreal sirreal changed the title HTML API: Update non-nullable get_breadcrumbs return HTML API: Remove nullable from get_breadcrumbs return type Dec 10, 2024
@sirreal sirreal marked this pull request as ready for review December 10, 2024 10:18
Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props jonsurrell.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@gziolo
Copy link
Member

gziolo commented Dec 10, 2024

Committed with https://core.trac.wordpress.org/changeset/59503.

@gziolo gziolo closed this Dec 10, 2024
@sirreal sirreal deleted the html-api/fix-get_breadcrumbs-return branch December 10, 2024 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants