A fluent interface for creating WordPress Queries
$ composer require jjgrainger/query
The Query class provides a fluent interface for create WP_Query in WordPress.
useQuery\Query;
// Create a new WP_Query for the latest 3 products.$results = Query::post_type( 'product' )->posts_per_page( 3 )->get();
// The above is the same as...$args = [
'post_type' => 'product',
'posts_per_page' => 3,
];
$results = new \WP_Query( $args );Custom query classes can be created by extending the Query class. Custom query classes can encapsulate default parameters which can then be expanded upon with query methods.
For example, a FeaturedPostsQuery can be created to return posts with the 'featured' taxonomy term. The default query parameters are defined within the setup() method that receives a Builder instance.
useQuery\Query;
useQuery\Builder;
class FeaturedPostsQuery extends Query
{
/** * Setup the initial query. * * @param Builder $builder * * @return Builder */publicfunctionsetup( Builder$builder ): Builder
{
// Setup a tax_query for posts with the 'featured' term.$tax_query = [
[
'taxonomy' => 'featured',
'fields' => 'slugs',
'terms' => [ 'featured' ],
],
];
return$builder->where( 'tax_query', $tax_query );
}
}Once the query class is created it can be used through out the project in a vairety of ways.
useFeaturedPostsQueryasFeatured;
// Returns a WP_Query object for posts with the featured term.$results = Featured::get();
// Returns a WP_Query object for the latest 3 products with the featured term.$results = Featured::type( 'products' )->limit( 3 )->get();
// Queries can be instantiated with an array of additional query arguments.$args = [
'post_type' => 'products',
];
// Create a query object.$query = newFeatured( $args );
// Modify the query and get the WP_Query object.$results = $query->limit( 3 )->get();Custom scopes can be added to the global Query using the static addScope method. One of the simplest ways to add a scope is with a closure.
// Create a new scope with a closure.
Query::addScope( 'events', function( Builder$builder ) {
return$builder->where( 'post_type', 'event' );
} );
// Call the scope when needed.$results = Query::events()->limit( 3 );Custom scope classes can be added to the global Query. The custom scope class will need to implement the Scope interface and contain the required apply method.
The apply method should accept the query Builder as the first argument and any optional arguments passed via the scope.
Once added to the Query class the scope will be available by the class name with the first letter lowecase.
// Create a custom scope class.useQuery\Scope;
useQuery\Builder;
class PostID implements Scope {
publicfunctionapply( Builder$builder, $id = null ) {
return$builder->where( 'p', $id );
}
}
// Add the scope to the Query.
Query::addScope( newPostID );
// Use the scope in the Query.$results = Query::postID( 123 )->get();- The library is still in active development and not intended for production use.
- Licensed under the MIT License
- Maintained under the Semantic Versioning Guide
Joe Grainger