README

Use the latitude query builder to build queries for use in wpdb.

Warning

This package is currently in development and is subject to breaking changes without notice until v1.0 has been tagged.

It is one in a series of WordPress toys I have been working on with the intention of exploring ways to modernize the feel of working with WordPress.

As the label suggests, it should be treated as a toy.

Installation

composer require ssnepenthe/wpdb-engine-for-latitude

Usage

Start by reviewing the latitude documentation. Using this package will be largely the same.

The important differences are noted below:

WpdbEngine

The engine provided to the query factory should always be an instance of WpdbEngine:

use Latitude\QueryBuilder\QueryFactory;
use WpdbEngineForLatitude\WpdbEngine;

$factory = new QueryFactory(new WpdbEngine());

Field Function

In place of the Latitude\QueryBuilder\field() function, use WpdbEngineForLatitude\field():

use function WpdbEngineForLatitude\field;

$query = $factory
    ->select('id', 'username')
    ->from('users')
    ->where(field('id')->eq(5))
    ->compile();

Search Function

In place of the Latitude\QueryBuilder\search() function, use WpdbEngineForLatitude\search():

use function WpdbEngineForLatitude\search;

$query = $factory
    ->select()
    ->from('users')
    ->where(search('first_name')->begins('john'))
    ->compile();

With Wpdb

Once you have compiled a query instance you should pass the sql and params through the wpdb->prepare() method to get your final query string:

global $wpdb;

$queryString = $wpdb->prepare($query->sql(), ...$query->params());

And finally use it with any of the wpdb query methods:

$result = $wpdb->get_row($queryString);

More Examples

Please refer to the tests in tests/CodeReferenceExamplesTest.php - The examples from the wpdb code reference page have been re-implemented there.

ssnepenthe / wpdb-engine-for-latitude

Maintainers

Details