WordPress.org

Make WordPress Core

Opened 2 years ago

Closed 2 years ago

#42155 closed defect (bug) (fixed)

WP_Site_Query $args documentation incorrect

Reported by: welcher Owned by: johnbillion
Milestone: 4.9 Priority: normal
Severity: normal Version:
Component: Networks and Sites Keywords: good-first-bug has-patch
Focuses: docs, multisite Cc:

Description

When using get_sites() or WP_Site_Query, the inline documentation for update_site_cache states that the default value is false but it is actually true.

@type bool $update_site_cache Whether to prime the cache for found sites. Default false.

The docs should be updated in both ms-blogs.php and class-wp-site-query.php to reflect that the default is true.

Attachments (1)

42155.diff​ (1.6 KB) - added by sudar 2 years ago.

Download all attachments as: .zip

Change History (5)

@sudar
2 years ago

#1 @sudar
2 years ago

  • Keywords has-patch added; needs-patch removed

Added a patch that fixes the doc in two places.

#2 @johnbillion
2 years ago

  • Owner set to johnbillion
  • Status changed from new to reviewing

#3 @johnbillion
2 years ago

  • Milestone changed from Awaiting Review to 4.9

#4 @johnbillion
2 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 41795:

Networks and Sites: Correct the documentation for the update_site_cache parameter of WP_Site_Query.

Props welcher, sudar
Fixes #42155

Note: See TracTickets for help on using tickets.