[wp-trac] [WordPress Trac] #54524: Incorrect in-code comment (docs) for filter screen_settings

WordPress Trac noreply at wordpress.org
Sat Nov 27 01:54:44 UTC 2021


#54524: Incorrect in-code comment (docs) for filter screen_settings
----------------------------+------------------------------
 Reporter:  Starbuck        |       Owner:  (none)
     Type:  defect (bug)    |      Status:  new
 Priority:  normal          |   Milestone:  Awaiting Review
Component:  Administration  |     Version:
 Severity:  trivial         |  Resolution:
 Keywords:                  |     Focuses:  docs
----------------------------+------------------------------
Changes (by SergeyBiryukov):

 * component:  Comments => Administration


Old description:

> 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:
> [https://core.trac.wordpress.org/changeset/27256]

New description:

 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]

--

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/54524#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list