Add filter when building WP_Query arguments

[alexmerz]

Allow to customize the arguments for WP_Query created by build_articles_query using the new filter 'newspack_blocks_build_articles_query'.

All Submissions:

• Have you followed the Newspack Contributing guideline?
• Does your code follow the WordPress' coding standards and VIP Go coding standards?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Our websites make heavy use of the Homepage Articles block on the Homepage and related type of pages. This results in a significant amount of slow WP_Query calls by the Homepage Articles blocks in case of a cache invalidation caused by new post publications or content changes to these pages. The underlying reason for the slow queries is the default usage of SQL_CALC_FOUND_ROWS by Wordpress. As this seems not to be necessary for a Homepage Articles block, it would be usefull to set the argument 'no_found_rows' for WP_Query in such situations.

But as such a change might break other existing code in the plugin or third party usage, the best way seems to add a filter to build_articles_query() to allow users to add such an argument in a filter when usefull.

I our case we were a able to reduce the time to generate the Homepage from 24 seconds down to 13 seconds by adding the filter and add the 'no_found_rows' argument in the custom filter.

Closes # .

How to test the changes in this Pull Request:

1. Add a filter such as

add_filter( 'newspack_blocks_build_articles_query', function( $args, $attributes, $block_name) {
	if ( 'newspack-blocks/homepage-articles' === $block_name ) {
		$args['no_found_rows'] = true;
	}
	return $args;
}, 10, 3 );

2. The resulting SQL should not contain the SQL_CALC_FOUND_ROWS keyword.
3. Execution time for the SQL statement should improve.

Other information:

• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you successfully ran tests with your changes locally?

[leogermani]

Thanks @alexmerz ,

Could you please add a doc block to the new filter? Please have a look at the WP coding standards here https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#4-hooks-actions-and-filters

[alexmerz]

@leogermani Doc block is added, feel free to adjust the "since" argument.

[leogermani]

Thanks!

[matticbot]

🎉 This PR is included in version 2.6.0-alpha.1 🎉

The release is available on:

• npm package (@alpha dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[matticbot]

🎉 This PR is included in version 2.6.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀