Opened 8 years ago
Closed 7 years ago
#44850 closed defect (bug) (fixed)
incorrect DocBlock for set-screen-option filter
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| Milestone: | 5.1 | Priority: | normal |
| Severity: | normal | Version: | |
| Component: | Administration | Keywords: | good-first-bug has-patch |
| Focuses: | docs | Cc: |
Description
This is a follow-up to #26186.
The first param in the DocBLock in the patch committed in r27379 is incorrect, in a couple of ways:
- the param type should be
bool - the param name should be something like
$keep(see below) - the param description should be something like
Whether to keep or skip saving the screen option value. Default false.
The fact that the incorrect name $value is also the name of another one of the params causes phpdoc-parser to skip outputting the param altogether in the Code Reference: https://developer.wordpress.org/reference/hooks/set-screen-option/ (caused me a few minutes of grief wondering why my screen options weren't being saved).
Related: #42505
Attachments (1)
Change History (8)
Note: See
TracTickets for help on using
tickets.
As par pbiron recommendation