[wp-trac] [WordPress Trac] #54846: Add links to actual topics instead of general Debugging for messages only visible when Debug is enabled

[WordPress Trac]

#54846: Add links to actual topics instead of general Debugging for messages only
visible when Debug is enabled
-------------------------+------------------------------
 Reporter:  oglekler     |       Owner:  (none)
     Type:  enhancement  |      Status:  new
 Priority:  normal       |   Milestone:  Awaiting Review
Component:  General      |     Version:
 Severity:  normal       |  Resolution:
 Keywords:               |     Focuses:  ui-copy
-------------------------+------------------------------
Changes (by sabernhardt):

 * focuses:   => ui-copy


Old description:

> For messages such as:
>
> 'The REST API route definition for %1$s is missing the required %2$s
> argument. For REST API routes that are intended to be public, use %3$s as
> the permission callback.'
>

> '"%1$s" script should not be enqueued together with the new widgets
> editor (%2$s or %3$s).'
>
> instead of the general link to https://wordpress.org/support/article
> /debugging-in-wordpress/ can be provided link better suited for each
> case.
>
> Right now these are notices, and it means that only people with enabled
> debug are seeing them and they already knew about debugging and it's
> possible for them to actually solve the problem, so, more advanced links
> can better suit these cases. It's also possible that such right answers
> with a combination of https://core.trac.wordpress.org/ticket/50493 can
> reduce the number of questions on Support about 'What to do…' when people
> see this message. It is supposed to be clear from the message that if
> this is your own creation - you need to adjust it, if not - address the
> author.
>

> For the message about REST API:
> https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-
> custom-endpoints/ - this link can be added instead, but it looks like
> examples needs to be checked.
>
> And for the second example, can be added something like this: "If you see
> this message, probably you need https://wordpress.org/plugins/classic-
> widgets/ plugin because you are using old widgets. Please contact your
> theme author or developer/maintainer to update widgets to the new
> version."

New description:

 For `_doing_it_wrong()` messages such as:

 - `The REST API route definition for %1$s is missing the required %2$s
 argument. For REST API routes that are intended to be public, use %3$s as
 the permission callback.`
 - `"%1$s" script should not be enqueued together with the new widgets
 editor (%2$s or %3$s).`

 instead of the general link to https://wordpress.org/support/article
 /debugging-in-wordpress/ can be provided link better suited for each case.

 Right now these are notices, and it means that only people with enabled
 debug are seeing them and they already knew about debugging and it's
 possible for them to actually solve the problem, so, more advanced links
 can better suit these cases. It's also possible that such right answers
 with a combination of ticket:50493 can reduce the number of questions on
 Support about 'What to do…' when people see this message. It is supposed
 to be clear from the message that if this is your own creation - you need
 to adjust it, if not - address the author.


 For the message about REST API:
 https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-
 custom-endpoints/ - this link can be added instead, but it looks like
 examples needs to be checked.

 And for the second example, can be added something like this: "If you see
 this message, probably you need https://wordpress.org/plugins/classic-
 widgets/ plugin because you are using old widgets. Please contact your
 theme author or developer/maintainer to update widgets to the new
 version."

--

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