Download the PHP package juvo/bricks-custom-query without Composer
On this page you can find all versions of the php package juvo/bricks-custom-query. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download juvo/bricks-custom-query
More information about juvo/bricks-custom-query
Files in juvo/bricks-custom-query
Package bricks-custom-query
Short Description Easy to use custom bricks query
License GPL-3.0-or-later
Informations about the package bricks-custom-query
God damn easy Bricks Builder Custom Queries
You are a developer and want to add custom queries to the bricks builder? This package is for you. From now on you can add your own logic and functionality to loops. Ever wanted to iterate your custom database, external APIs or WordPress Data Structures in a highly complex loop? Here you go.
Feature overview:
- Simple registration of Custom Queries
- Automatic Performance Profiling for the Query Monitor Plugin
- Add custom controls to your query
- WP Gridbuilder Support (Only for native WordPress Data Types)
- Multisite Queries (Only for native WordPress Data Types)
Installation
To install the package you can use composer. Run the following command in your terminal:
You should initiate the registry as early as possible. The best place to do this is in your plugin's main file or the functions.php of your theme.
Usage
To register a simple query you can use the following code snippet. The first parameter is the query name, the second parameter is the query label, the third parameter is the callback that returns a callback.
Query Types
There is an optional fourth parameter that allows you to set the type of the query. If you query something other than a
post please change the type accordingly. Supported types are set up as a PHP Enum. The default type
is Query_Type::Post
.
Choose Query_Type::Other
if you are not working with native wordpress data types. A more in detail guide for "Other" queries can be found in this guide
Query Callback
For native wordpress data types the callback must return valid query arguments. For custom data types you need to return the actual data. For the later the return value will not be processed further.
Query Configuration
You can configure a couple of query configurations using setter function. Full documentation for these can be found here: https://github.com/JUVOJustin/bricks-custom-query/wiki/Query-Configs
Additional Controls
You can add additional controls to your query. The full list of controls can be found here: https://academy.bricksbuilder.io/topic/controls/ You don´t need to set the tab.