[wp-trac] [WordPress Trac] #42156: Adjust the inline docs for get_sites() to avoid WP_Site_Query doc-duplication

WordPress Trac noreply at wordpress.org
Mon Oct 9 14:28:15 UTC 2017


#42156: Adjust the inline docs for get_sites() to avoid WP_Site_Query doc-
duplication
--------------------------------+-----------------------------
 Reporter:  birgire             |      Owner:
     Type:  enhancement         |     Status:  new
 Priority:  normal              |  Milestone:  Awaiting Review
Component:  Networks and Sites  |    Version:  4.6
 Severity:  normal              |   Keywords:
  Focuses:  docs, multisite     |
--------------------------------+-----------------------------
 The {{{get_sites()}}} is a wrapper for a {{{WP_Site_Query}}} object, so to
 avoid doc duplication, we should adjust the inline docs for that function.

 Similar to what has been done for the documentation of the
 {{{get_posts()}}} function, that's a wrapper for a {{{WP_Query}}} object.

 Code reference:

 {{{get_sites()}}}:

 https://core.trac.wordpress.org/browser/tags/4.8/src/wp-includes/ms-
 blogs.php#L588

 {{{WP_Site_Query}}}:

 https://core.trac.wordpress.org/browser/tags/4.8/src/wp-includes/class-wp-
 site-query.php#L105

 {{{get_posts()}}}:

 https://core.trac.wordpress.org/browser/tags/4.8/src/wp-
 includes/post.php#L1646

 Related #42117

--
Ticket URL: <https://core.trac.wordpress.org/ticket/42156>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list