PHPDoc correction for src/wp-admin/includes/class-wp-filesystem-base.php

[Jaydeep Rami]

There are a wrong argument type in PHPDoc. Below is file path:

/wp-admin/includes/class-wp-filesystem-base.php

Thanks,

[Jaydeep Rami]

Fixed: PHPDoc correction for src/wp-admin/includes/class-wp-filesystem-base.php

[SergeyBiryukov]

Hi Jaydeep, thanks for the patch!

The existing docs for these arguments are correct, it's just that default values don't match the expected type.

• $theme should either be documented as string|false, or the default value should be changed to an empty string, here and in get_theme_root() as well.
• $mode should be documented as int|false, here and in other class-wp-filesystem-*.php files as well.

[Jaydeep Rami]

Replying to SergeyBiryukov: Thank you @SergeyBiryukov, I understood. Thanks for the explanation!

Hi Jaydeep, thanks for the patch!

The existing docs for these arguments are correct, it's just that default values don't match the expected type.

• $theme should either be documented as string|false, or the default value should be changed to an empty string, here and and in get_theme_root() as well.
• $mode should be documented as int|false, here and in other class-wp-filesystem-*.php files as well.

[SergeyBiryukov]

Related: #46779

[audrasjb]

As per today's bug scrub, the patch needs a refresh to land in 5.2.

Cheers,
Jb

[man4toman]

$mode should be documented as int|false, here and in other class-wp-filesystem-*.php files as well.

If I understand it correctly, the third patch must be OK.

[SergeyBiryukov]

In 45226:

Docs: Improve documentation for various WP_Filesystem_Base methods and extending classes.

Props jaydeep-rami, man4toman, SaeedFard, mukesh27, mohadeseghasemi, ebrahimzadeh, juiiee8487, SergeyBiryukov.
Fixes #42227, #46806, #46840. See #46543.