Argument type does not match: user.php

[subrataemfluence]

File location: wp-includes/user.php

<?php
/*
* ...
* @param int $for_user_id Optional. User ID to set up global data.
 */
function setup_userdata( $for_user_id = '' ) {
   ...
}

[SergeyBiryukov]

Hi @subrataemfluence, thanks for the ticket!

The existing type is correct, $for_user_id should be an integer, not a string.

That said, it could use a better default value, i.e. 0 instead of an empty string. Given the non-strict check a few lines below, changing it to 0 should not affect the logic.

[subrataemfluence]

I had the same initial feeling but got a kinda confused!

Now, since the default value set for $for_user_id is 0, can this be better idea to rewrite the comparison block like this?

if ( '' == $for_user_id || 0 == $for_user_id ) {
   $for_user_id = get_current_user_id();
}

$user = get_userdata( $for_user_id );

This ensures $for_user_id gets the current user id for default values.

And if fails to satisfy the above condition, rest will be executed as tNB: Ire.

And if the default value for $for_user_id is set to 0, do we really need to compare it with an empty string?

[pento]

In 44603:

Users: Correct the default value in setup_userdata().

The $for_user_id parameter is an int, not a string, so the default value should be 0, rather than an empty string.

Props subrataemfluence.
Fixes #44697.

[swissspidy]

@pento FYI we usually put the default value last, per ​https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#1-functions-class-methods

[pento]

In 44605:

Docs: Tweak the docblock for setup_userdata().

This is a followup to [44603]. The default value should be last, not somewhere in the middle.

Props swissspidy.
Fixes #44697.