Document the globals in various docblocks.

[upadalavipul]

function commenting details needs to improve.

File Names:
wp-includes/class-wp-block.php
wp-includes/class-wp-tax-query.php
wp-includes/class-wp-term-query.php
wp-includes/class-wp-locale.php

Function Name: render(), transform_query(), parse_orderby() and init()

[mukesh27]

Thanks for the ticket and patch!

patch 57069.patch​ look fine to me. It removes unnecessary global declaration.

Ping @audrasjb for final review and commit.

[audrasjb]

Hello and thanks for the ticket!

We had the exact same ticket yesterday with #57058, this time let's use this ticket to address more occurrences of the same issue :)

Feel free to add more patches to this ticket if you find more missing or erroneous globals.

Thanks!

[krupalpanchal]

Hi @upadalavipul

I've found one more file you could update.

1. /wp-admin/includes/class-wp-upgrader.php - L910

[audrasjb]

[54867] merges the code proposed in 57069.patch, 57069.2.patch and 57069.4.patch.

[audrasjb]

In 54868:

Docs: Improve various globals documentation, as per documentation standards.

Props upadalavipul.
See #57069, #56792.

[audrasjb]

and [54868] merges the code proposed in 57069.3.patch.

[audrasjb]

I'll commit 57069.5.patch.
I'm unsure about 57069.6.patch as those are deprecated functions.

[audrasjb]

In 54877:

Docs: Improve various globals documentation, as per documentation standards.

Props upadalavipul.
See #57069, #56792.

[audrasjb]

[54877] merges the code proposed in 57069.5.patch.

[viralsampat]

I have found one another file and added comments for the same.

[viralsampat]

I have checked another file and added comments.

[audrasjb]

In 54953:

Docs: Improve various globals documentation, as per documentation standards.

Props upadalavipul.
See #57069, #56792.

[audrasjb]

[54953] addresses 57069.7.patch and 57069.8.patch.

[SergeyBiryukov]

In 54954:

Docs: Add missing type for $_wp_theme_features in WP_Debug_Data::debug_data().

Includes moving the global declaration to the top of the method for consistency.

Follow-up to [44986], [54953].

See #57069, #56792.

[audrasjb]

@viralsampat it looks like 57069.diff adds some unrelated changes:

// Check array attributes place holder value isset or not
if( empty( $attributes['placeholder'] ) ) {
    $attributes['placeholder'] = 'Optional placeholder…';
}

(also, this change doesn't follow WPCS)

Edit: same goes for 57069.2.diff, this patch is unrelated.

[viralsampat]

HELLO @audrasjb

Thank you so much for sharing your feedback.

By mistake I had created patch with old changes.

Can I will create new patch and can I add it back?

Please let me know your feedback for the same.

Thanks,

[upadalavipul]

Added one more patch

[audrasjb]

@upadalavipul I'm going to partially commit 57069.9.patch. Worth noting that I made a few changes from your original patch:

• twentytwenty/inc/template-tags.php: I moved the first declaration to line 244.
• wp-includes/blocks/comments.php: this needs to be addressed on Gutenberg side. Please open a PR on the GH repository.

[audrasjb]

In 55003:

Docs: Improve various globals documentation, as per docblock standards.

Props upadalavipul, audrasjb.

See #57069, #56792.

[SergeyBiryukov]

In 55004:

Twenty Seventeen: Document the $twentyseventeencounter global.

Follow-up to [38833], [38986], [55003].

See #57069, #56792.

[viralsampat]

I have added another patch

[viralsampat]

I have checked from my end and found few other files. So, I have added my patch.

[audrasjb]

@viralsampat for 57069.3.diff and 57069.4.diff, it would be nice to add a small description for the globals.

@upadalavipul 57069.11.diff contains unrelated changes and we can't commit 57069.12.diff as these files are located in the Block Editor and should be modified on ​Gutenberg GitHub repository.

[viralsampat]

I have read your comments and made small changes based on requirement.

[viralsampat]

I have added patch and resolved this issue.

[costdev]

Globals reordered to meet ​the established docblock format + type added for $wp_customize

[costdev]

@audrasjb I've added 57069.7.diff to bring it in line with docblock formatting standards and to add a type for $wp_customize. Do you have time to take a look at this one? 🙂

[audrasjb]

In 55472:

Bundled Themes: Improve various globals documentation, as per docblock standards.

Props viralsampat, audrasjb, costdev.
See #56792, #57069.

[audrasjb]

We're very close to WP 6.2 RC1 now. Closing this as fixed.
Fixes for 6.3 can go to #57840.

[SergeyBiryukov]

#60019 was marked as a duplicate.