Skip to content

Better error message when theme.json styles use a duotone preset not in settings #50714

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

Merged
scruffian merged 4 commits into from
May 19, 2023
Merged

Better error message when theme.json styles use a duotone preset not in settings #50714

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ee8d435
Show a more specific error when theme.json styles use a preset not fr…
May 16, 2023
f07828d
Remove the period in the error message
May 17, 2023
c7f86db
Add gutenberg domain to translation
May 17, 2023
ef60cd5
Use _doing_it_wrong instead of trigger_error
May 19, 2023
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
9 changes: 9 additions & 0 deletions lib/class-wp-duotone-gutenberg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,6 +712,15 @@ private static function enqueue_custom_filter( $filter_id, $duotone_selector, $f
* @param string $filter_value The filter CSS value. e.g. 'url(#wp-duotone-blue-orange)' or 'unset'.
*/
private static function enqueue_global_styles_preset( $filter_id, $duotone_selector, $filter_value ) {
if ( ! array_key_exists( $filter_id, self::$global_styles_presets ) ) {
$error_message = sprintf(
/* translators: %s: duotone filter ID */
__( 'The duotone id "%s" is not registered in theme.json settings', 'gutenberg' ),
$filter_id
);
trigger_error( $error_message );
Copy link
Member

@spacedmonkey spacedmonkey May 19, 2023

Choose a reason for hiding this comment

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

Trigger error? Let's use _doing_it_wrong instead.

Copy link
Contributor Author

@ajlende ajlende May 19, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I was under the impression that _doing_it_wrong was used for developers calling functions incorrectly. The function is being called correctly, but the theme.json it's reading from has bad data. Is it still the right choice in this case?

EDIT: For reference, this is what I was basing things off of which uses trigger_error. https://github.com/WordPress/gutenberg/blob/trunk/lib/class-wp-theme-json-resolver-gutenberg.php#L501

return;
}
self::$used_global_styles_presets[ $filter_id ] = self::$global_styles_presets[ $filter_id ];
self::enqueue_custom_filter( $filter_id, $duotone_selector, $filter_value, self::$global_styles_presets[ $filter_id ] );
}
Expand Down