Skip to content

Improve AI Client error handling#11265

Closed
felixarntz wants to merge 4 commits intoWordPress:trunkfrom
felixarntz:better-ai-client-errors
Closed

Improve AI Client error handling#11265
felixarntz wants to merge 4 commits intoWordPress:trunkfrom
felixarntz:better-ai-client-errors

Conversation

@felixarntz
Copy link
Copy Markdown
Member

@felixarntz felixarntz commented Mar 16, 2026 •
edited by gziolo
Loading

Trac ticket description for what this PR does:

The WP_AI_Client_Prompt_Builder currently relies on very generic WP_Error objects, without a lot of context. This leads to two problems:

Much of the granular context that the PHP AI Client exceptions provide is lost.
The WP_Error objects are not very useful in HTTP context, e.g. in REST API responses.
We should enhance the logic in the class to leverage the PHP AI Client exception classes more granularly, and include a status in data for the HTTP status code, so that these WP_Error objects are ready to use as e.g. REST responses.

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

Use of AI Tools

Claude Opus was used to help with tests.

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.

@felixarntz felixarntz requested a review from gziolo March 16, 2026 14:35
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 16, 2026 •
edited
Loading

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 flixos90, gziolo.

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

@felixarntz felixarntz changed the title Better ai client errors Improve AI Client error handling Mar 16, 2026
felixarntz
felixarntz commented Mar 16, 2026
View reviewed changes
src/wp-includes/ai-client/class-wp-ai-client-prompt-builder.php
'prompt_prevented',
__( 'Prompt execution was prevented by a filter.' ),
array(
'exception_class' => 'WP_AI_Client_Prompt_Prevented',
Copy link
Copy Markdown
Member Author

@felixarntz felixarntz Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note for reviewers: This class doesn't exist, it was pointless and confusing to include this reference here just for consistency. Unlike the other WP_Error objects, this one is not based on an exception.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 16, 2026

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

  • 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.

gziolo
gziolo approved these changes Mar 17, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@gziolo gziolo left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good refactor. A few notes:

The prompt_builder_error code is now only the fallback for unrecognized exceptions — a semantic shift worth noting explicitly, since any caller currently checking for prompt_builder_error to detect all builder failures will silently miss the new specific codes.

Also worth noting that once this lands, PR #10915 directly benefits: returning the builder's WP_Error from the REST controller becomes correct because all errors now carry a status key. Without this PR, those REST responses would default to 500 regardless of the actual exception type.

@WordPress WordPress deleted a comment from gclapps0612-cmd Mar 17, 2026
@felixarntz
Copy link
Copy Markdown
Member Author

felixarntz commented Mar 17, 2026

Thanks @gziolo!

The prompt_builder_error code is now only the fallback for unrecognized exceptions — a semantic shift worth noting explicitly, since any caller currently checking for prompt_builder_error to detect all builder failures will silently miss the new specific codes.

This shouldn't be a problem since it's very specific and we don't need to worry about backward compat with previous betas at this stage where 7.0 stable isn't out yet.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 17, 2026

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 62037
GitHub commit: d9aa07e

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions bot closed this Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gziolo gziolo gziolo approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@felixarntz @gziolo