Add BaseSettingsRESTController for plugin-ui settings#3
Merged
Conversation
Introduces an abstract REST controller compatible with @wedevs/plugin-ui <Settings> component. Includes variant-aware validation and sanitization, permission checks with WP_Error, deep-merge persistence to wp_options, and comprehensive apply_filters/do_action hooks for extensibility. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughAdds an abstract BaseSettingsRESTController that provides a schema-driven REST API for nested plugin settings persisted in wp_options, with route registration, permission checks, validation, sanitization, deep merge persistence, and multiple filters/actions; also adds expanded developer documentation and a hooks reference for Settings. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant REST_API as REST API
participant SchemaSvc as Schema Handler
participant Options as wp_options
participant Hooks
Client->>REST_API: GET /{namespace}/{rest_base}
REST_API->>SchemaSvc: Permission check
SchemaSvc-->>REST_API: allowed/denied
REST_API->>SchemaSvc: Load schema
SchemaSvc->>Options: Read stored values
Options-->>SchemaSvc: Return values
SchemaSvc->>SchemaSvc: Merge defaults into schema
SchemaSvc->>Hooks: Apply settings_loaded_values / settings_get_response filters
Hooks-->>REST_API: Filtered response
REST_API-->>Client: 200 + schema + values
sequenceDiagram
participant Client
participant REST_API as REST API
participant Validator
participant Sanitizer
participant Options as wp_options
participant Hooks
Client->>REST_API: POST /{namespace}/{rest_base} (values)
REST_API->>Validator: Validate submitted values
Validator->>Hooks: Apply settings_validation_errors filter
Hooks-->>Validator: Validation result
alt Validation fails
Validator-->>REST_API: Errors
REST_API-->>Client: 400 + errors
else Validation passes
Validator->>Sanitizer: Field sanitization
Sanitizer->>Hooks: settings_sanitize_field filter
Hooks-->>Sanitizer: Sanitized values
REST_API->>Hooks: settings_before_save action
REST_API->>Options: Merge & persist values (option_prefix + scope_id)
Options-->>REST_API: Save complete
REST_API->>Hooks: settings_after_save action
REST_API-->>Client: 200 + merged values
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Documents BaseSettingsRESTController usage: creating a controller, defining schemas, supported field variants, translatable messages, extending settings via hooks, and the full hook reference table. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/Settings/BaseSettingsRESTController.php`:
- Line 1: Add a proper file-level docblock at the top and fix all
method/function docblocks in the BaseSettingsRESTController class so each has a
short description line followed by blank line before tags; replace any
Yoda-style conditionals (e.g., if (null === $var) or if (0 === count($x)) found
in methods of BaseSettingsRESTController) with normal ordering (if ($var ===
null), if (count($x) === 0)); and reformat the multiline function/method calls
so arguments and chained calls follow PSR-12 (put each argument or chained call
on its own indented line and ensure the closing parenthesis/semicolon alignment)
to resolve the reported violations at the top-of-file, docblocks, the Yoda
conditional, and the multiline call blocks.
- Around line 349-352: The color_picker validator currently rejects valid WP
color formats; replace the regex check in the 'color_picker' case so it uses
WordPress sanitize_hex_color() on $value and only sets $error =
$messages['color_picker'] when $value is non-empty and
sanitize_hex_color($value) returns null (invalid); ensure empty string remains
accepted and keep references to $value and $messages['color_picker'] unchanged.
- Around line 313-317: The numeric field handling accepts decimals (is_numeric
in the switch 'number') but later truncates values using intval; update the code
that currently casts/normalizes numeric settings (the place using intval around
the numeric save/normalize logic) to preserve decimal precision by using a
float-preserving conversion (e.g., floatval/cast to float or a decimal-safe
normalization) and ensure any stored/returned value retains the original decimal
when is_numeric passes; keep the existing validation message but ensure numeric
normalization uses the 'number' branch and the same error message variable
($messages['number']).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: d481576f-f7cc-4cc0-a539-1f0230411157
📒 Files selected for processing (1)
src/Settings/BaseSettingsRESTController.php
| @@ -0,0 +1,646 @@ | |||
| <?php | |||
There was a problem hiding this comment.
Resolve the current PHPCS violations in this file.
The reported failures at Line 1, Line 21, Line 27, Line 166, and Lines 200–211 should be fixed to unblock lint checks (file doc comment, docblock short descriptions, Yoda condition, multiline call formatting).
Minimal patch sketch
@@
<?php
+/**
+ * Base settings REST controller.
+ */
@@
- * wp_options key prefix (e.g. "wpkit_tasks").
+ * WP options key prefix (e.g. "wpkit_tasks").
@@
- /**
+ /**
+ * Constructor.
+ *
* `@param` string $namespace REST API namespace (e.g. "myplugin/v1").
@@
- if ( $value !== null ) {
+ if ( null !== $value ) {
$element['default'] = $value;
}
@@
- return new \WP_REST_Response( [
- 'errors' => [ 'values' => 'Invalid values format.' ],
- ], 400 );
+ return new \WP_REST_Response(
+ [
+ 'errors' => [ 'values' => 'Invalid values format.' ],
+ ],
+ 400
+ );
@@
- return new \WP_REST_Response( [
- 'errors' => [ 'scopeId' => 'Invalid scope ID.' ],
- ], 400 );
+ return new \WP_REST_Response(
+ [
+ 'errors' => [ 'scopeId' => 'Invalid scope ID.' ],
+ ],
+ 400
+ );Also applies to: 21-27, 166-166, 200-211
🧰 Tools
🪛 GitHub Check: PHPCS
[failure] 1-1:
Missing file doc comment
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/Settings/BaseSettingsRESTController.php` at line 1, Add a proper
file-level docblock at the top and fix all method/function docblocks in the
BaseSettingsRESTController class so each has a short description line followed
by blank line before tags; replace any Yoda-style conditionals (e.g., if (null
=== $var) or if (0 === count($x)) found in methods of
BaseSettingsRESTController) with normal ordering (if ($var === null), if
(count($x) === 0)); and reformat the multiline function/method calls so
arguments and chained calls follow PSR-12 (put each argument or chained call on
its own indented line and ensure the closing parenthesis/semicolon alignment) to
resolve the reported violations at the top-of-file, docblocks, the Yoda
conditional, and the multiline call blocks.
Adds project context for Claude Code, .gitattributes with export-ignore for CLAUDE.md, .claude/, tests/, docs/, and config files so consumer plugins don't receive them via composer install. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add file doc comment, fix Yoda conditions, multi-line function call formatting, short ternary usage, and missing doc comment descriptions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use floatval() for decimal numbers and intval() for integers instead of always truncating with intval(). Also remove file doc comment. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Required by PHPCS Squiz.Commenting.FileComment rule. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
BaseSettingsRESTController, an abstract REST controller for schema-driven settings management compatible with the@wedevs/plugin-ui<Settings>componentnumber,switch,select,radio_capsule,customize_radio,multicheck,color_picker,combine_input,textarea) and sanitization with proper WordPress sanitize functionsWP_Errorwith descriptive messages instead of barefalse$namespace,$rest_base, and$option_prefixto prevent misconfigurationscopeIdsanitized viasanitize_key()before use in option keyshtml,base_field_label) are skipped during saveget_permission_error_message()andget_validation_messages()for consumer text domain translationsapply_filters/do_actionhooks namespaced with{option_prefix}_:_settings_capability— customize required capability_settings_schema— modify schema before loading values_settings_get_response— modify full GET response_settings_validate_field— override per-field validation_settings_validation_errors— modify collected errors_settings_validation_messages— translate/customize error messages_settings_sanitize_field— override per-field sanitization_settings_before_save— modify values before DB write_settings_after_save— react after settings are saved_settings_loaded_values— modify loaded values with defaultsTest plan
WP_Errorfor unauthorized usershtml,base_field_label) are not saved🤖 Generated with Claude Code
Summary by CodeRabbit