https://github.com/dimitribouteille/wp-orm

✨ WordPress ORM with Eloquent, an object-relational mapper that makes it enjoyable to interact with your database.
https://github.com/dimitribouteille/wp-orm

database eloquent eloquent-database eloquent-orm migration-tool mysql orm wordpress wordpress-development wordpress-orm wordpress-starter

Last synced: 2 months ago
JSON representation

✨ WordPress ORM with Eloquent, an object-relational mapper that makes it enjoyable to interact with your database.

• Host: GitHub
• URL: https://github.com/dimitribouteille/wp-orm
• Owner: dimitriBouteille
• License: mit
• Created: 2020-04-30T23:15:20.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-22T02:30:01.000Z (3 months ago)
• Last Synced: 2025-04-04T12:52:18.996Z (2 months ago)
• Topics: database, eloquent, eloquent-database, eloquent-orm, migration-tool, mysql, orm, wordpress, wordpress-development, wordpress-orm, wordpress-starter
• Language: PHP
• Homepage: https://packagist.org/packages/dbout/wp-orm
• Size: 518 KB
• Stars: 80
• Watchers: 4
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# WordPress ORM with Eloquent

[![GitHub Release](https://img.shields.io/github/v/release/dimitriBouteille/wp-orm)](https://github.com/dimitriBouteille/wp-orm/releases)

[![Tests](https://img.shields.io/github/actions/workflow/status/dimitriBouteille/wp-orm/tests.yml?label=tests)](https://github.com/dimitriBouteille/wp-orm/actions/workflows/tests.yml)

[![Packagist Downloads](https://img.shields.io/packagist/dt/dbout/wp-orm?color=yellow)](https://packagist.org/packages/dbout/wp-orm)

[![Eloquent version](https://img.shields.io/packagist/dependency-v/dbout/wp-orm/illuminate%2Fdatabase?color=orange)](https://github.com/dimitriBouteille/wp-orm/blob/main/composer.json)

[![Coverage Status](https://coveralls.io/repos/github/dimitriBouteille/wp-orm/badge.svg?branch=main)](https://coveralls.io/github/dimitriBouteille/wp-orm)

WordPress ORM with Eloquent is a small library that adds a basic ORM into WordPress, which is easily extendable and includes models for core WordPress models such as posts, post metas, users, comments and more.

The ORM is based on [Eloquent ORM](https://laravel.com/docs/eloquent) and uses the WordPress connection (`wpdb` class).

> [!TIP]

> To simplify the integration of this library, we recommend using WordPress with one of the following tools: [Bedrock](https://roots.io/bedrock/), [Themosis](https://framework.themosis.com/) or [Wordplate](https://github.com/wordplate/wordplate#readme).

## Features

- ✅ Support core WordPress models: `Comment`, `Option`, `Post`, `TermTaxonomy`, `Term`, `User`, `PostMeta` and `UserMeta`

- ✅ Support core WordPress post type: `Article`, `Attachment` and `Page`

- ✅ Based on core WordPress database connection (`wpdb` class), no configuration required !

- ✅ Custom functions to filter models with meta

- ✅ Meta casting (e.g. [Attribute Casting](https://laravel.com/docs/eloquent-mutators#attribute-casting))

- ✅ Multisite support

- ❤️ Easy integration of a custom post and comment type

- ❤️ Easy model creation for projects with custom tables

- ❤️ All the features available in Eloquent, are usable with this library !

**Not yet developed but planned in a future version:**

- 🗓️ [Create migration tool with Eloquent](https://github.com/dimitriBouteille/wp-orm/issues/28)

## Documentation

This documentation only covers the specific points of this library, if you want to know more about Eloquent, the easiest is to look at [the documentation of Eloquent](https://laravel.com/doc/eloquent).

You can find all the documentation in [the wiki](https://github.com/dimitriBouteille/wp-orm/wiki).

## Installation

**Requirements**

The server requirements are basically the same as for [WordPress](https://wordpress.org/about/requirements/) with the addition of a few ones :

- PHP >= 8.2

- [Composer](https://getcomposer.org/)

**Installation**

You can use [Composer](https://getcomposer.org/). Follow the [installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have composer installed.

~~~bash

composer require dbout/wp-orm

~~~

In your `wp-config.php` make sure you include the autoloader:

~~~php

require __DIR__ . '/vendor/autoload.php';

~~~

🎉 You have nothing more to do, you can use the library now! Not even need to configure database accesses because it's the `wpdb` connection that is used.

## Contributing

We encourage you to contribute to this repository, so everyone can benefit from new features, bug fixes, and any other improvements. Have a look at our [contributing guidelines](CONTRIBUTING.md) to find out how to raise a pull request.