the-under-scorer/wp-eloquent

Eloquent ORM for WordPress

1.5.2 2019-10-08 10:51 UTC

Requires

• illuminate/database: ^5.4
• illuminate/pagination: ^5.4

Requires (Dev)

• phpunit/phpunit: ^7
• vlucas/phpdotenv: ^3.3

GPL-2.0-or-later

• Tareq Hasan
• Przemysław Żydek

• orm
• sql
• plugin
• wordpress
• eloquent

README

Eloquent Wrapper for WordPress

This is a library package to use Laravel's Eloquent ORM with WordPress. It's an fork of original https://github.com/tareq1988/wp-eloquent library that seems to be abandoned.

Package Installation

To install this package run:

$ composer require the-under-scorer/wp-eloquent

Usage Example

Basic Usage

$db = \UnderScorer\ORM\Eloquent\Database::instance();

var_dump( $db->table('users')->find(1) );
var_dump( $db->select('SELECT * FROM wp_users WHERE id = ?', [1]) );
var_dump( $db->table('users')->where('user_login', 'john')->first() );

// OR with DB facade
use \UnderScorer\ORM\Eloquent\Facades\DB;

var_dump( DB::table('users')->find(1) );
var_dump( DB::select('SELECT * FROM wp_users WHERE id = ?', [1]) );
var_dump( DB::table('users')->where('user_login', 'john')->first() );

Creating Models For Custom Tables

You can use custom tables of the WordPress databases to create models:

	namespace whatever;


	class CustomTableModel extends \UnderScorer\ORM\Eloquent\Model {

		/**
		 * Name for table without prefix
		 *
		 * @var string
		 */
		protected $table = 'table_name';


		/**
		 * Columns that can be edited - IE not primary key or timestamps if being used
		 */
		protected $fillable = [
			'city',
			'state',
			'country'
		];

		/**
		 * Disable created_at and update_at columns, unless you have those.
		 */
		public $timestamps = false;

		/** Everything below this is best done in an abstract class that custom tables extend */

		/**
		 * Set primary key as ID, because WordPress
		 *
		 * @var string
		 */
		protected $primaryKey = 'ID';

		/**
		 * Make ID guarded -- without this ID doesn't save.
		 *
		 * @var string
		 */
		protected $guarded = [ 'ID' ];

		/**
		 * Overide parent method to make sure prefixing is correct.
		 *
		 * @return string
		 */
		public function getTable()
		{
			//In this example, it's set, but this is better in an abstract class
			if( isset( $this->table ) ){
				$prefix =  $this->getConnection()->db->prefix;
				return $prefix . $this->table;

			}

			return parent::getTable();
		}

	}

Retrieving All Rows From A Table

$users = $db->table('users')->get();

foreach ($users as $user) {
    var_dump($user->display_name);
}

Here users is the table name without prefix. The prefix will be applied automatically.

Other Examples

• Queries
• Eloquent ORM

Writing a Model

use \UnderScorer\ORM\Eloquent\Model as Model;

class Employee extends Model {

}

var_dump( Employee::all()->toArray() ); // gets all employees
var_dump( Employee::find(1) ); // find employee with ID 1

The class name Employee will be translated into PREFIX_employees table to run queries. But as usual, you can override the table name.

In-built Models for WordPress

• Post
• Comment
• Post Meta
• User
• User Meta
• Term
• TermTaxonomy

use UnderScorer\WP\Post;

var_dump( Post::all() ); //returns only posts with WordPress post_type "post"

Filter Post by post_status and post_type

use UnderScorer\WP\Post;
var_dump(Post::type('page')->get()->toArray()); // get pages
var_dump(Post::status('publish')->get()->toArray()); // get posts with publish status
var_dump(Post::type('page')->status('publish')->get()->toArray()); // get pages with publish status

How it Works

• Eloquent is mainly used here as the query builder
• WPDB is used to run queries built by Eloquent
• Hence, we have the benfit to use plugins like debug-bar or query-monitor to get SQL query reporting.
• It doesn't create any extra MySQL connection

Minimum Requirement

• PHP 5.6.4+
• WordPress 4.0+

Author

Tareq Hasan Przemysław Żydek