[wp-trac] [WordPress Trac] #37173: get_the_content() has undocumented globals

[WordPress Trac]

#37173: get_the_content() has undocumented globals
--------------------------------------+------------------------------
 Reporter:  slimndap                  |       Owner:  goranseric
     Type:  defect (bug)              |      Status:  assigned
 Priority:  normal                    |   Milestone:  Awaiting Review
Component:  Posts, Post Types         |     Version:  0.71
 Severity:  normal                    |  Resolution:
 Keywords:  good-first-bug has-patch  |     Focuses:  docs
--------------------------------------+------------------------------

Comment (by DrewAPicture):

 @goranseric In the case of descriptions for globals, we should be
 describing what the global represents at the initial point of access,
 rather than try to specific about purpose they serve in the current
 context.

 So for `$multipage`, for instance, it's truly an indicator for whether
 pagination is play. It's technically an integer, but treated as a boolean.

 So a possible description for `$multipage` might be something like:
 {{{
  * @global int $multipage Boolean indicator for whether multiple pages are
 in play.
 }}}

 In the case of `$pages`, what it ''really'' represents is an array of all
 pages. And so on with the others.

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