Support template for WP_Widget settings #160
Merged
Conversation
This file contains 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
- Support passing the shape for the widget settings. - Add type for the widget arguments registered from `register_sidebar`.
lipemat
added a commit
to lipemat/advanced-sidebar-menu
that referenced
this pull request
Feb 13, 2024
- Include basic definitions for widget settings. - Fix inconsistencies found from the new types. Note: If this pull request gets merged a bunch of ignored phpstan items can be removed. php-stubs/wordpress-stubs#160
lipemat
added a commit
to lipemat/phpstan-wordpress
that referenced
this pull request
Feb 13, 2024
Submitted a pull request but in the meantime we're going to use the template to move forward. php-stubs/wordpress-stubs#160
lipemat
added a commit
to lipemat/advanced-sidebar-menu
that referenced
this pull request
Feb 13, 2024
- Include basic definitions for widget settings. - Fix inconsistencies found from the new types. Note: If this pull request gets merged a bunch of ignored phpstan items can be removed. php-stubs/wordpress-stubs#160
|
@lipemat Are we ready to merge this PR? |
Yes. I've been adding the definitions to various projects and using/testing them there. Merging this in will allow me to cleanup the other projects. |
|
All right. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The WP_Widget class supports passing an "$instance" array around which contains the value of the current widget settings.
Without a PHPStan template, adding a type to the $instance array results in warnings like "should be contravariant with parameter" for the following methods:
Having a template available allows using @extends to pass the array shape around.
As a bonus, this pull request also includes the full shape of the
$argspassed toWP_Widget::widget