Document global variables comment code improvement.

[upadalavipul]

I have reviewed the below file code and found that we are using a global $wp_version variable. but they do not mention it in the function comment. Also one more $wp_theme_directories global variable used. but they do not mention in the function comment. So I think we need to improve the function comment code.

Files:

---

1) wp-admin/includes/update-core.php
2) wp-includes/theme.php

[upadalavipul]

patch Added.

[mukesh27]

Hi there!

Thanks for ticket and patch. The indention is not correct in wp-admin/includes/update-core.php that needs to correct.

[upadalavipul]

I have updated patch.

[johnbillion]

$wp_version can't be globalised here. There's an inline comment about it: ​https://github.com/WordPress/wordpress-develop/blob/5c519f8f7c8cd89b8cdcf1a6110fdce2d1f9bde3/src/wp-admin/includes/update-core.php#L1089-L1090

[SergeyBiryukov]

In 60262:

Docs: Document the $wp_theme_directories global in wp_is_block_theme().

Follow-up to [52069], [52330].

Props upadalavipul.
See #63496.

[SergeyBiryukov]

Replying to johnbillion:

$wp_version can't be globalised here. There's an inline comment about it

I think the patch aims to document the existing $GLOBALS['wp_version'] reference in line 1121​.

[johnbillion]

Replying to SergeyBiryukov:

I think the patch aims to document the existing $GLOBALS['wp_version'] reference in line 1121​.

Seeing as that explicitly uses the $GLOBALS superglobal I would say it doesn't need documenting as a global.

[SergeyBiryukov]

Replying to johnbillion:

Seeing as that explicitly uses the $GLOBALS superglobal I would say it doesn't need documenting as a global.

That would be inconsistent with the rest of core though, we do document these $GLOBALS references pretty much everywhere :)

[viralsampat]

I have reviewed above mentioned issue and founds few files. Here, I have added its patch.

[SergeyBiryukov]

@viralsampat Thanks for the patch!

However, the alignment looks correct as is in all those files, except for class-ftp-*.php, but they a part of an adopted PemFTP library and don't follow the WordPress coding standards.

[SergeyBiryukov]

In 60265:

Docs: Document the $wp_version global in update_core().

Follow-up to [17576], [22226], [31124], [32643], [39687].

Props upadalavipul, mukesh27, johnbillion, SergeyBiryukov.
Fixes #63496.