WordPress.org

Make WordPress Core

Opened 2 months ago

Closed 2 months ago

#54524 closed defect (bug) (fixed)

Incorrect in-code comment (docs) for filter screen_settings

Reported by: Starbuck Owned by: SergeyBiryukov
Milestone: 5.9 Priority: normal
Severity: trivial Version:
Component: Administration Keywords:
Focuses: docs Cc:

Description (last modified by SergeyBiryukov)

Ref comment about filter screen_settings :
https://core.trac.wordpress.org/browser/tags/5.8.1/src/wp-admin/includes/class-wp-screen.php#L1011:

This filter is currently only used on the Widgets screen to enable accessibility mode.

I believe this comment can be removed, because the hook is called for all admin screens. It was originally added in this changeset and seems to be an inaccuracy that crept in: [27256]

Change History (4)

#1 @Starbuck
2 months ago

  • Focuses accessibility removed
  • Summary changed from Obsolete in-code comment (docs) for filter screen_settings to Incorrect in-code comment (docs) for filter screen_settings

Correcting Summary: I originally thought this was an obsolete comment but now it seems it was inaccurate at the time it was created.

Also removing accessibility tag for the same reason.

#2 @SergeyBiryukov
2 months ago

  • Component changed from Comments to Administration
  • Description modified (diff)

#3 @SergeyBiryukov
2 months ago

  • Milestone changed from Awaiting Review to 5.9

#4 @SergeyBiryukov
2 months ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from new to closed

In 52257:

Docs: Remove inaccurate part of the screen_settings filter description.

The filter is called for all admin screens, not just the Widgets screen.

Follow-up to [27256].

Props Starbuck.
Fixes #54524.

Note: See TracTickets for help on using tickets.