Missing parameter type for `login_header()`

[desrosj]

The login_header() function's third parameter is optional and accepts a WP_Error instance. The default value, though is a string, which is missing from the inline documentation.

To prevent someone from passing a string (which would not be added to a new WP_Error), if ( empty( $wp_error ) ) {} could be changed to if ( ! is_wp_error( $wp_error ) ) {}.

[desrosj]

Thanks for the patch, @sebastien@….

The functions inline documentation also needs to be updated to indicate the $wp_error parameter could also be a string.

[desrosj]

Moving all tickets in 4.9.7 to 4.9.8.

[flixos90]

I think it makes more sense to leave the third parameter as a WP_Error only, but set its default value to null, which is the expected default value for optional object parameters. Since we create a new WP_Error if none is passed, we could adjust the documentation as follows: "Optional. The error to pass. Default is a new empty error."

[sebastien@…]

Added a new patch, hope I understood what @flixos90 said :-/

[flixos90]

@sebastien@…

Thanks for the updated patch! A few remarks:

• The documentation for the parameter should continue to only state WP_Error as type. Also its description should be changed to use "Optional. The error to pass. Default is a new empty error."
• Please remove line 41, as it introduces a parse error.
• Please avoid unnecessary blank lines like in lines 46 and 47.
• It seems your patch is not based on current trunk. Please ensure you create the diff file against the entirety and latest version of trunk. See ​https://make.wordpress.org/core/handbook/tutorials/working-with-patches/

[nikolam]

Hello, I'm coming from WCEU!

All seems good to me. Code looks good, docs updated, tests written.

I don't think that there's anything I can do on this ticket. :)

[desrosj]

None of the patches so far seem like a complete solution. The two main items here we should change to fix the original described problem:

• The default for $wp_error should be changed to null to properly reflect the functions documentation. The @param tag description should also be changed to "Optional. The error to pass. Default is a new empty error."
• The if ( empty( $wp_error ) ) conditional should be changed to check ! is_wp_error( $wp_error ) to ensure any passed value other than an instance of WP_Error is turned into one.

[ocean90]

4.9.7 has been released, moving to next milestone.

[chetan200891]

Refreshed patch.

[chetan200891]

I have added refreshed patch 44052.6.diff

[SergeyBiryukov]

In 43457:

Login and Registration: Set a better default value for $wp_error parameter in login_header().

To prevent someone from passing a string (which would not be added to a new WP_Error instance), check for is_wp_error() explicitly.

Props desrosj, chetan200891, spyderbytes, lbenicio, sebastien@…, abdullahramzan.
Fixes #44052.

[SergeyBiryukov]

In 43458:

Login and Registration: Set a better default value for $wp_error parameter in login_header().

To prevent someone from passing a string (which would not be added to a new WP_Error instance), check for is_wp_error() explicitly.

Props desrosj, chetan200891, spyderbytes, lbenicio, sebastien@…, abdullahramzan.
Merges [43457] to the 4.9 branch.
Fixes #44052.