PHPackages                             cloakwp/eloquent - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. cloakwp/eloquent

ActiveLibrary[Database & ORM](/categories/database)

cloakwp/eloquent
================

A Laravel wrapper for WordPress that converts all WordPress tables into Laravel Eloquent Models.

0.0.4(1y ago)0471MITPHPPHP >=8.0

Since May 27Pushed 10mo agoCompare

[ Source](https://github.com/cloak-labs/cloakwp-eloquent)[ Packagist](https://packagist.org/packages/cloakwp/eloquent)[ Docs](https://github.com/cloak-labs/cloakwp-eloquent)[ RSS](/packages/cloakwp-eloquent/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (5)Used By (0)

Wordpress Laravel Eloquent Models
---------------------------------

[](#wordpress-laravel-eloquent-models)

[![](https://camo.githubusercontent.com/1dfedbae65fc9038b1823809b2675564207682c6d22b4e53d1c8ad77e4cbfbde/687474703a2f2f647265776a626172746c6574742e636f6d2f696d616765732f6769746875622f6c6f676f2d6c61726176656c2e737667)](https://camo.githubusercontent.com/1dfedbae65fc9038b1823809b2675564207682c6d22b4e53d1c8ad77e4cbfbde/687474703a2f2f647265776a626172746c6574742e636f6d2f696d616765732f6769746875622f6c6f676f2d6c61726176656c2e737667)[![](https://camo.githubusercontent.com/7aa74a43df31c0c0df3a4e7346efbbd7fc597033950a3a82ce3752b0feb82465/687474703a2f2f647265776a626172746c6574742e636f6d2f696d616765732f6769746875622f776f726470726573732d6c6f676f2e706e67)](https://camo.githubusercontent.com/7aa74a43df31c0c0df3a4e7346efbbd7fc597033950a3a82ce3752b0feb82465/687474703a2f2f647265776a626172746c6574742e636f6d2f696d616765732f6769746875622f776f726470726573732d6c6f676f2e706e67)

A library that converts converts wordpress tables into [Laravel Eloquent Models](https://laravel.com/docs/5.3/eloquent). This is helpful for dropping into any wordpress project where maybe you'd rather use the awesome features of Laravel's Eloquent Models. Or maybe you're writing an API with something like [Slim](https://www.slimframework.com/) or better yet [Lumen](https://lumen.laravel.com/) don't want to increase your load time by loading the entire WP core. This is a great boiler plate based off [Eloquent](https://laravel.com/docs/5.3/eloquent) by Laravel to get you going.

\*\* This is documentation for additional functionality on top of Eloquent. For documentation on all of Eloquent's features you visit the [documentation](https://laravel.com/docs/5.3/eloquent).

Overview
--------

[](#overview)

- [Installation](#installation)
- [Setup](#setup)
- [Posts](#posts)
- [Comments](#comments)
- [Terms](#terms)
- [Users](#users)
- [Meta](#meta)
- [Options](#options)
- [Links](#links)
- [Extending your own models](#extending-your-own-models)
- [Query Logs](#query-logs)

### Installation

[](#installation)

```
composer require drewjbartlett/wordpress-eloquent

```

### Setup

[](#setup)

```
require_once('vendor/autoload.php');

\WPEloquent\Core\Laravel::connect([
    'global' => true,

    'config' => [

        'database' => [
            'user'     => 'user',
            'password' => 'password',
            'name'     => 'database',
            'host'     => '127.0.0.1',
            'port'     => '3306'
        ],

        // your wpdb prefix
        'prefix' => 'wp_',
    ],

    // enable events
    'events' => false,

    // enable query log
    'log'    => true
]);
```

If you wanted to enable this on your entire WP install you could create a file with the above code to drop in the `mu-plugins` folder.

### Posts

[](#posts)

```
use \WPEloquent\Model\Post;

// getting a post
$post = Post::find(1);

// available relationships
$post->author;
$post->comments;
$post->terms;
$post->tags;
$post->categories;
$post->meta;
```

***Statuses***

By default, the `Post` returns posts with all statuses. You can however override this with the [local scope](https://laravel.com/docs/5.3/eloquent#query-scopes) `published` to return only published posts.

```
Post::published()->get();
```

Or if you need a specific status you can override with defined status via [local scope](https://laravel.com/docs/5.3/eloquent#query-scopes).

```
Post::status('draft')->get();
```

***Post Types***

By default, the `Post` returns posts with all post types. You can however override this by defining a post type via [local scope](https://laravel.com/docs/5.3/eloquent#query-scopes).

```
Post::type('page')->get();
```

### Comments

[](#comments)

```
use \WPEloquent\Model\Comment;

// getting a comment
$comment = Comment::find(12345);

// available relationships
$comment->post;
$comment->author;
$comment->meta
```

### Terms

[](#terms)

In this version `Term` is still accesible as a model but is only leveraged through posts.

```
$post->terms()->where('taxonomy', 'country');
```

### Users

[](#users)

```
use \WPEloquent\Model\User;

// getting a comment
$user = User::find(123);

// available relationships
$user->posts;
$user->meta;
$user->comments
```

### Meta

[](#meta)

The models `Post`, `User`, `Comment`, `Term`, all implement the `HasMeta`. Therefore they meta can easily be retrieved by the `getMeta` and set by the `setMeta` helper functions:

```
$post = Post::find(1);
$post->setMeta('featured_image', 'my-image.jpg');
$post->setMeta('breakfast', ['waffles' => 'blueberry', 'pancakes' => 'banana']);

// or all in one call
$featured_image = Post::find(1)->getMeta('featured_image');
Post::find(1)->setMeta('featured_image', 'image.jpg');

// same applies for all other models

$user = User::find(1)
$facebook = $user->getMeta('facebook');
$user->setMeta('social', ['facebook' => 'facebook.com/me', 'instagram' => 'instagram.com/me']);

$comment = Comment::find(1);
$meta = $comment->getMeta('some_comment_meta');

$term = Term::find(123);
$meta = $term->getMeta('some_term_meta');

// delete meta
$post = Post::find(123)->deleteMeta('some_term_meta');
```

### Options

[](#options)

In wordpress you can use `get_option`. Alternatively, if you don't want to load the wordpress core you can use helper function `getValue`.

```
use \WPEloquent\Model\Post;

$siteurl = Option::getValue('siteurl');
```

Or of course, the long form:

```
use \WPEloquent\Model\Options;

$siteurl = Option::where('option_name', 'siteurl')->value('option_value');
```

### Links

[](#links)

```
use \WPEloquent\Model\Link;

$siteurl = Link::find(1);
```

### Extending your own models

[](#extending-your-own-models)

If you want to add your own functionality to a model, for instance a `User` you can do so like this:

```
namespace App\Model;

class User extends \WPEloquent\Model\User {

    public function orders() {
        return $this->hasMany('\App\Model\User\Orders');
    }

    public function current() {
        // some functionality to get current user
    }

    public function favorites() {
        return $this->hasMany('Favorites');
    }

}
```

Another example would be for custom taxonomies on a post, say `country`

```
namespace App\Model;

class Post extends \WPEloquent\Model\Post {

    public function countries() {
        return $this->terms()->where('taxonomy', 'country');
    }

}

Post::with(['categories', 'countries'])->find(1);
```

### Query Logs

[](#query-logs)

Sometimes it's helpful to see the query logs for debugging. You can enable the logs by passing `log` is set to `true` (see [setup](#setup)) on the `Laravel::connect` method. Logs are retrieved by running.

```
use \WPEloquent\Core\Laravel;

print_r(Laravel::queryLog());
```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance45

Moderate activity, may be stable

Popularity10

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 66.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~33 days

Total

4

Last Release

620d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6029133664b39b787817bddb9c1840cfdb8fac3b0ee8dee66edc10a6b9391f80?d=identicon)[kaelan](/maintainers/kaelan)

---

Top Contributors

[![drewjbartlett](https://avatars.githubusercontent.com/u/2146829?v=4)](https://github.com/drewjbartlett "drewjbartlett (39 commits)")[![kaelansmith](https://avatars.githubusercontent.com/u/60372141?v=4)](https://github.com/kaelansmith "kaelansmith (9 commits)")[![terence1990](https://avatars.githubusercontent.com/u/8171301?v=4)](https://github.com/terence1990 "terence1990 (5 commits)")[![riozzi](https://avatars.githubusercontent.com/u/7408598?v=4)](https://github.com/riozzi "riozzi (4 commits)")[![SanderMuller](https://avatars.githubusercontent.com/u/9074391?v=4)](https://github.com/SanderMuller "SanderMuller (1 commits)")[![twosg](https://avatars.githubusercontent.com/u/325412?v=4)](https://github.com/twosg "twosg (1 commits)")

---

Tags

laravelwordpresseloquentcloakwp

### Embed Badge

![Health badge](/badges/cloakwp-eloquent/health.svg)

```
[![Health](https://phpackages.com/badges/cloakwp-eloquent/health.svg)](https://phpackages.com/packages/cloakwp-eloquent)
```

###  Alternatives

[mongodb/laravel-mongodb

A MongoDB based Eloquent model and Query builder for Laravel

7.1k7.2M71](/packages/mongodb-laravel-mongodb)[watson/validating

Eloquent model validating trait.

9723.3M47](/packages/watson-validating)[cybercog/laravel-ban

Laravel Ban simplify blocking and banning Eloquent models.

1.1k651.8k11](/packages/cybercog-laravel-ban)[dyrynda/laravel-model-uuid

This package allows you to easily work with UUIDs in your Laravel models.

4802.8M8](/packages/dyrynda-laravel-model-uuid)[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9682.1M97](/packages/roots-acorn)[pdphilip/elasticsearch

An Elasticsearch implementation of Laravel's Eloquent ORM

145360.2k4](/packages/pdphilip-elasticsearch)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)