[wp-trac] [WordPress Trac] #64018: Improve PHPDoc for template_redirect hook

[WordPress Trac]

#64018: Improve PHPDoc for template_redirect hook
-------------------------+-----------------------------
 Reporter:  apermo       |       Owner:  SergeyBiryukov
     Type:  enhancement  |      Status:  closed
 Priority:  normal       |   Milestone:  6.9
Component:  Themes       |     Version:  1.5
 Severity:  normal       |  Resolution:  fixed
 Keywords:  has-patch    |     Focuses:  docs
-------------------------+-----------------------------

Comment (by apermo):

 Thanks @SergeyBiryukov for the merge and for the point to the doc
 standards.


 As mentioned above, I realized that the hook was regularly misunderstood,
 and the added documentation is a shortened version of the official
 documentation of the filter.

 And as you quoted:

 > Summary: A brief, one line explanation of the purpose of the hook. Use a
 period at the end.
 > Description: A supplemental description to the summary, if warranted.

 In that case I found it is warranted to describe a bit further what to use
 it for, and what alternative filter you should look for, for the regular
 misuse.

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