Download the PHP package dutchigor/cmb2-rest-query without Composer
On this page you can find all versions of the php package dutchigor/cmb2-rest-query. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package cmb2-rest-query
CMB2-rest-query
Adds a query parameter to the REST API for any CMB2 field that has the property rest_query set on it.
How to install
Option one
- Clone or download and unzip this plugin in to your WordPress plugin directory and active.
Option two
- Add dutchigor/cmb2-rest-query to required packages in composer and require CMB2-rest-query.php in your code
How to use
Setting up the metabox in CMB2
Add the query_rest property to the field that you wish to query by in your CMB2 field configuration.
- If set to true, the field ID will used to query the REST API.
- If set to a value, the value will be used to query REST API.
Example
Querying the REST API
For each field that has rest_query set, 3 parameters will be available in the REST request on each post type that this field's metabox is registered on:
- the field's rest_query value or id (as defined above)
- the above parameter appended with _compare
- the above parameter appended with _type
Adding the field's query parameter to the request will add that field to the request's meta query. By default compare will be '=' but using the {rest_query}_compare parameter, this can be changed to any option allowed by WP_Meta_Query. The type of the query parameter will be set to 'CHAR' by default but this can be overwritten using {rest_query}_type, again with the values allowd in WP_Meta_Query.
Following the above example a query could look like:
