Skip to content
6 changes: 6 additions & 0 deletions src/wp-includes/category.php
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,12 @@ function cat_is_ancestor_of( $cat1, $cat2 ) {
* @param object|array $category Category data.
* @param string $context Optional. Default 'display'.
* @return object|array Same type as $category with sanitized data for safe use.
*
* @phpstan-return (
* $category is WP_Term ? WP_Term : (
* $category is array ? array<string, mixed> : object
* )
* )
*/
function sanitize_category( $category, $context = 'display' ) {
return sanitize_term( $category, 'category', $context );
Expand Down
5 changes: 5 additions & 0 deletions src/wp-includes/class-wp-widget-factory.php
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,14 @@ public function WP_Widget_Factory() {
* @since 7.1.1 The key for an instance is prefixed so that it is never cast to an integer.
*
* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
*
* @phpstan-param class-string<WP_Widget>|WP_Widget $widget
*/
public function register( $widget ) {
if ( $widget instanceof WP_Widget ) {
$this->widgets[ self::INSTANCE_KEY_PREFIX . spl_object_id( $widget ) ] = $widget;
} else {
// @phpstan-ignore arguments.count (Widget classes declare their own constructor, which takes no arguments.)
$this->widgets[ $widget ] = new $widget();
}
}
Expand All @@ -87,6 +90,8 @@ public function register( $widget ) {
* @since 7.1.1 The key for an instance is prefixed so that it is never cast to an integer.
*
* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
*
* @phpstan-param class-string<WP_Widget>|WP_Widget $widget
*/
public function unregister( $widget ) {
if ( $widget instanceof WP_Widget ) {
Expand Down
10 changes: 10 additions & 0 deletions src/wp-includes/class-wp-widget.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
*
* @since 2.8.0
* @since 4.4.0 Moved to its own file from wp-includes/widgets.php
*
* @phpstan-template T of array = array<string, mixed>
Comment thread
swissspidy marked this conversation as resolved.
Resolved

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why the need for a @phpstan-template here? Instead of T in the methods' phpdoc, why not just array<string, mixed>?

*/
#[AllowDynamicProperties]
class WP_Widget {
Expand Down Expand Up @@ -109,6 +111,8 @@ class WP_Widget {
* @param array $args Display arguments including 'before_title', 'after_title',
* 'before_widget', and 'after_widget'.
* @param array $instance The settings for the particular instance of the widget.
*
* @phpstan-param T $instance
*/
public function widget( $args, $instance ) {
die( 'function WP_Widget::widget() must be overridden in a subclass.' );
Expand All @@ -127,6 +131,10 @@ public function widget( $args, $instance ) {
* WP_Widget::form().
* @param array $old_instance Old settings for this instance.
* @return array Settings to save or bool false to cancel saving.
*
* @phpstan-param array<string, mixed> $new_instance
* @phpstan-param T|array{} $old_instance
* @phpstan-return array<string, mixed>|false
*/
public function update( $new_instance, $old_instance ) {
return $new_instance;
Expand All @@ -140,6 +148,8 @@ public function update( $new_instance, $old_instance ) {
* @param array $instance The settings for the particular instance of the widget.
* @return string|void Default return is 'noform'. A subclass which echoes its own
* form returns nothing.
*
* @phpstan-param T|array{} $instance
*/
public function form( $instance ) {
echo '<p class="no-options-widget">' . __( 'There are no options for this widget.' ) . '</p>';
Expand Down
24 changes: 18 additions & 6 deletions src/wp-includes/formatting.php
Original file line number Diff line number Diff line change
Expand Up @@ -2940,8 +2940,12 @@ function stripslashes_from_strings_only( $value ) {
*
* @since 2.2.0
*
* @param mixed $value The array or string to be encoded.
* @return mixed The encoded value.
* @param mixed[]|object|scalar $value The array, object, or scalar to be encoded.
* @return mixed[]|object|string The encoded value.
*
* @phpstan-template T of mixed[]|object|scalar
* @phpstan-param T $value
* @phpstan-return (T is array ? array<key-of<T>, mixed> : (T is object ? T : string))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is the string branch proven? I see map_deep() uses mixed in the same spot. Perhaps $value should be narrowed from mixed to mixed[]|object|string?

Same goes for the following.

*/
function urlencode_deep( $value ) {
return map_deep( $value, 'urlencode' );
Expand All @@ -2952,8 +2956,12 @@ function urlencode_deep( $value ) {
*
* @since 3.4.0
*
* @param mixed $value The array or string to be encoded.
* @return mixed The encoded value.
* @param mixed[]|object|scalar $value The array, object, or scalar to be encoded.
* @return mixed[]|object|string The encoded value.
*
* @phpstan-template T of mixed[]|object|scalar
* @phpstan-param T $value
* @phpstan-return (T is array ? array<key-of<T>, mixed> : (T is object ? T : string))
*/
function rawurlencode_deep( $value ) {
return map_deep( $value, 'rawurlencode' );
Expand All @@ -2964,8 +2972,12 @@ function rawurlencode_deep( $value ) {
*
* @since 4.4.0
*
* @param mixed $value The array or string to be decoded.
* @return mixed The decoded value.
* @param mixed[]|object|scalar $value The array, object, or scalar to be decoded.
* @return mixed[]|object|string The decoded value.
*
* @phpstan-template T of mixed[]|object|scalar
* @phpstan-param T $value
* @phpstan-return (T is array ? array<key-of<T>, mixed> : (T is object ? T : string))
*/
function urldecode_deep( $value ) {
return map_deep( $value, 'urldecode' );
Expand Down
4 changes: 4 additions & 0 deletions src/wp-includes/widgets.php
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@
* @global WP_Widget_Factory $wp_widget_factory
*
* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
*
* @phpstan-param class-string<WP_Widget>|WP_Widget $widget
Comment thread
swissspidy marked this conversation as resolved.
Resolved
*/
function register_widget( $widget ) {
global $wp_widget_factory;
Expand All @@ -138,6 +140,8 @@ function register_widget( $widget ) {
* @global WP_Widget_Factory $wp_widget_factory
*
* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
*
* @phpstan-param class-string<WP_Widget>|WP_Widget $widget
*/
function unregister_widget( $widget ) {
global $wp_widget_factory;
Expand Down
2 changes: 1 addition & 1 deletion tests/phpstan/baselines/argument.type.neon
Original file line number Diff line number Diff line change
Expand Up @@ -749,7 +749,7 @@ parameters:
count: 1
path: ../../../src/wp-includes/class-wp-user.php
-
message: '#^Parameter \#1 \$number of method WP_Widget\:\:_set\(\) expects int, string given\.$#'
message: '#^Parameter \#1 \$number of method WP_Widget\<T of array \= array\<string, mixed\>\>\:\:_set\(\) expects int, string given\.$#'
identifier: argument.type
count: 1
path: ../../../src/wp-includes/class-wp-widget.php
Expand Down
2 changes: 1 addition & 1 deletion tests/phpstan/baselines/isset.property.neon
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ parameters:
count: 1
path: ../../../src/wp-includes/class-wp-user.php
-
message: '#^Property WP_Widget\:\:\$alt_option_name \(string\) in isset\(\) is not nullable\.$#'
message: '#^Property WP_Widget\<T of array \= array\<string, mixed\>\>\:\:\$alt_option_name \(string\) in isset\(\) is not nullable\.$#'
identifier: isset.property
count: 1
path: ../../../src/wp-includes/class-wp-widget.php
Expand Down
Loading