Argument type mismatch

[subrataemfluence]

File: wp-includes/author-template-patch.php

Doc blocks of the following functions have incorrect argument type declarations.

the_author( $deprecated = '', $deprecated_echo = true ) { ... }

get_the_author_meta( $field = '', $user_id = false ) { ... }

the_author_meta( $field = '', $user_id = false ) { ... }

Please review attached proposed patch.

[swissspidy]

We don't usually add things like string|bool in these cases, because it indicates that one could pass true as well.

Instead, the default value of false means "use current user by default".

So, if anything, I'd change the description to Optional. User ID. Defaults to the current author. or perhaps change the type to string|false to be explicit, or both.

[subrataemfluence]

Thank you for explaining :) Please let me know whether I shall modify the patch or close the ticket.

Replying to swissspidy:

We don't usually add things like string|bool in these cases, because it indicates that one could pass true as well.

Instead, the default value of false means "use current user by default".

So, if anything, I'd change the description to Optional. User ID. Defaults to the current author. or perhaps change the type to string|false to be explicit, or both.

[TimothyBlynJacobs]

It's possible to document it as string|false. ​http://docs.phpdoc.org/references/phpdoc/types.html.

[SergeyBiryukov]

In 45086:

Docs: Correct parameter types for the_author(), get_the_author_meta(), and the_author_meta().

Props subrataemfluence.
Fixes #45596.