Download the PHP package mallardduck/wp-eloquent-models without Composer
On this page you can find all versions of the php package mallardduck/wp-eloquent-models. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mallardduck/wp-eloquent-models
More information about mallardduck/wp-eloquent-models
Files in mallardduck/wp-eloquent-models
Package wp-eloquent-models
Short Description A Laravel wrapper for wordpress which turns all Wordpress models into Laravel Eloquent Models.
License MIT
Homepage https://github.com/mallardduck/wp-eloquent-models
Informations about the package wp-eloquent-models
Wordpress Laravel Eloquent Models
A library that converts converts wordpress tables into Laravel Eloquent Models. This is can be helpful for any wordpress project where maybe you'd rather use the awesome features of Laravel's Eloquent.
Or maybe you're building a project using Laravel and Roots Bedrock/Sage/etc and want to access WordPress data within Laravel. Or maybe you're writing an API with something like Slim or better yet Lumen don't want to increase your load time by loading the entire WP core.
This is a great boiler plate based off Eloquent by Laravel to get you going.
Note: This is documentation for additional functionality on top of Eloquent. For documentation on all of Eloquent's features you visit the documentation.
Overview
- Installation
- Setup
- Setup with Laravel
- Posts
- Comments
- Terms
- Users
- Meta
- Options
- Links
- Extending your own models
- Query Logs
Installing WPEloquent
The recommended way to install WPEloquent is through Composer.
Version Guidance
Version | Status | Packagist | Namespace | Repo | illuminate/database | PHP Version |
---|---|---|---|---|---|---|
v0.2.1 | Upstream | drewjbartlett/wordpress-eloquent |
WPEloquent |
v0.2.1 | 5.4.* |
>= 5.6.4 |
v0.3.x | Maintained | mallardduck/wp-eloquent-models |
WPEloquent |
v0.3.0 | 5.5 |
>= 7.1 |
v0.4.x | Maintained | mallardduck/wp-eloquent-models |
WPEloquent |
v0.4.1 | 5.7.10 or 5.8 or 6.x |
>= 7.2 |
Setup - Common
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.
Setup with Laravel
These directions are for when you want to work with WordPress database using Eloqent inside Laravel. The easiest mehtod is making a new config inside Laravel's config/database.php
. For example:
Note: In this example the WordPress database and Laravel database can be accessed on the same server by the same MySQL user. The laravel .env
of your project may need to be adjusted to match this example.
Then in your AppServiceProvider
add the following line:
Supported Models
Posts
Statuses
By default, the Post
returns posts with all statuses. You can however override this with the local scope published
to return only published posts.
Or if you need a specific status you can override with defined status via local scope.
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.
Comments
Terms
In this version Term
is still accesible as a model but is only leveraged through posts.
Users
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:
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
.
Or of course, the long form:
Links
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:
Another example would be for custom taxonomies on a post, say country
Or maybe you need to access a custom post type, like:
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) on the Laravel::connect
method. Logs are retrieved by running.