Return for short circuits for multisite classes.

[spacedmonkey]

In [44983] we introduced pre query filters in multisite classes. However this short circuit acts differently from other short circuits and still continues to execute. After the filter runs, it should exit straight away.

[adamsilverstein]

@spacedmonkey Thanks for the patch!

Can you explain what problem this patch solves? are you still seeing database queries after returning an array of ids from this filter?

noticing that after this patch we loose handling in ​https://github.com/WordPress/wordpress-develop/blob/master/src/wp-includes/class-wp-network-query.php#L247-L290 - including args like fields, count and update_network_cache.

Also the function get_networks usually returns an array of WP_Network objects - after this change it looks more like you the function would return an array of IDs, is that right?

[adamsilverstein]

Reviewing this diff without whitespace changes I can see the change here is smaller than what i thought and does exactly what our other filters do.

This looks good, thanks @spacedmonkey!

​https://github.com/WordPress/wordpress-develop/pull/76/files?w=1

[adamsilverstein]

This could use a unit test to verify that these functions return early when the filters return non null values.

[adamsilverstein]

Question from @felipeelia related - https://core.trac.wordpress.org/ticket/45800#comment:21

Should we really be setting $this->sites here? before the filter depending on the query this could be set to ids, full objects or nothing (for a count request). Since we pass a reference to $this in the filter, maybe we should leave it up to filter consumers to set $this->sites?

In 47599.2.diff​ I updated our existing unit tests to account for requesting full objects not just ids. in this case previously additional database requests were made and the tests fail. after this patch the tests pass - no additional queries are run when a non null value is returned from the filter.

[adamsilverstein]

In 47599.3.diff​:

• improve documentation of filter, return type
• don't set this->sites with return value

Diff without whitespace: ​https://github.com/WordPress/wordpress-develop/pull/78/files?w=1

[adamsilverstein]

47599.4.diff​ improve filter docs.

[adamsilverstein]

@spacedmonkey or @felipeelia - appreciate a review of 47599.4.diff​ when you have a chance!

[felipeelia]

Seems good. The only consideration I have is that $network_data type should follow $site_data and be array|int|null as well :)

[adamsilverstein]

47599.6.diff​ includes some doc block cleanup after reviewing https://core.trac.wordpress.org/changeset/46087

[SergeyBiryukov]

Replying to adamsilverstein:

47599.6.diff​ includes some doc block cleanup after reviewing https://core.trac.wordpress.org/changeset/46087

47599.7.diff​ adjusts the alignment in lines 215-217 in class-wp-network-query.php to account for the added int, looks good to me otherwise :)

[adamsilverstein]

47599.8.diff​ ensure tess run against returned results so they pass.

[adamsilverstein]

In 46100:

Multisite: improve sites_pre_query and networks_pre_query filters, avoiding db queries.

Improve the pre_query filters in multisite classes introduced in r44983. Return (non null) values immediately,
avoiding the database queries entirely, similar to other pre_query filters.

Props spacedmonkey, SergeyBiryukov, felipeelia.
Fixes #47599.

[adamsilverstein]

Added needs-dev-note, we should document this change along with the new comments pre filter.

[desrosj]

Dev note: ​https://make.wordpress.org/core/2019/10/15/enhancements-to-the-network-sites-screen-in-wordpress-5-3/

Fixed in https://core.trac.wordpress.org/changeset/46100.

[SergeyBiryukov]

In 48984:

Docs: Correct the parameter type for networks_pre_query filter.

The filter should return the network count as an integer if $this->query_vars['count'] is set.

Follow-up to [46100].

See #50768, #47599.