WordPress.org
Get WordPress

Make WordPress Core

Opened 3 years ago

Last modified 3 years ago

#59992 new defect (bug)

Document global $locale in wp-admin/options.php

Reported by: upadalavipul Owned by:
Priority: normal Milestone: Awaiting Review
Component: General Version:
Severity: normal Keywords: 2nd-opinion
Cc: Focuses: docs, coding-standards

Description

I have review the below file code and found the we are used a global locale variable. but they do not mention in function comment. So I think we need improve function comment code.

File Names: wp-admin/options.php

Attachments (1)

59992.patch​ (378 bytes ) - added by upadalavipul 3 years ago.

Download all attachments as: .zip

Change History (2)

@upadalavipul
3 years ago

#1 @sabernhardt
3 years ago

  • Focuses docs added
  • Keywords 2nd-opinion added
  • Summary Docs: Improve various globals documentation, as per docblock standards. → Document global $locale in wp-admin/options.php

The $locale global is on line 347, not inside a named function with its own docblock. 59992.patch adds to the docblock for the allowed_options filter, which does not include the global variable. The comment immediately above line 347 could be good enough.

[39122] added the $locale variable (and the comment).

Note: See TracTickets for help on using tickets.