PHPackages                             ycms/corcel - 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. ycms/corcel

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

ycms/corcel
===========

Wrappers to collect data from Wordpress databases

023PHP

Since Sep 2Pushed 10y ago1 watchersCompare

[ Source](https://github.com/ycms/corcel)[ Packagist](https://packagist.org/packages/ycms/corcel)[ RSS](/packages/ycms-corcel/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

Wordpress Corcel
================

[](#wordpress-corcel)

*Corcel is under development, but it's working :D*

\--

Corcel is a class collection created to retrieve Wordpress database data using a better syntax. It uses the Eloquent ORM developed for the Laravel Framework, but you can use Corcel in any type of PHP project.

This way you can use Wordpress as back-end, to insert posts, custom types, etc, and you can use what you want in front-end, like Silex, Slim Framework, Laravel, Zend, or even pure PHP (why not?).

Installation
------------

[](#installation)

To install Corcel just create a `composer.json` file and add:

```
"require": {
    "jgrossi/corcel": "dev-master"
},

```

After that run `composer install` and wait.

Usage
-----

[](#usage)

First you must include the Composer `autoload` file.

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

```

Now you must set your Wordpress database params:

```
$params = array(
    'database'  => 'database_name',
    'username'  => 'username',
    'password'  => 'pa$$word',
    'prefix'    => 'wp_' // default prefix is 'wp_', you can change to your own prefix
);
Corcel\Database::connect($params);

```

You can specify all Eloquent params, but some are default (but you can override them).

```
'driver'    => 'mysql',
'host'      => 'localhost',
'charset'   => 'utf8',
'collation' => 'utf8_unicode_ci',
'prefix'    => 'wp_', // Specify the prefix for wordpress tables, default prefix is 'wp_'

```

### Posts

[](#posts)

```
// All published posts
$posts = Post::published()->get();
$posts = Post::status('publish')->get();

// A specific post
$post = Post::find(31);
echo $post->post_title;

```

You can retrieve meta data from posts too.

```
// Get a custom meta value (like 'link' or whatever) from a post (any type)
$post = Post::find(31);
echo $post->meta->link; // OR
echo $post->fields->link;
echo $post->link; // OR

```

Updating post custom fields:

```
$post = Post::find(1);
$post->meta->username = 'juniorgrossi';
$post->meta->url = 'http://grossi.io';
$post->save();

```

Inserting custom fields:

```
$post = new Post;
$post->save();

$post->meta->username = 'juniorgrossi';
$post->meta->url = 'http://grossi.io';
$post->save();

```

### Custom Post Type

[](#custom-post-type)

You can work with custom post types too. You can use the `type(string)` method or create your own class.

```
// using type() method
$videos = Post::type('video')->status('publish')->get();

// using your own class
class Video extends Corcel\Post
{
    protected $postType = 'video';
}
$videos = Video::status('publish')->get();

```

Custom post types and meta data:

```
// Get 3 posts with custom post type (store) and show its title
$stores = Post::type('store')->status('publish')->take(3)->get();
foreach ($stores as $store) {
    $storeAddress = $store->address; // option 1
    $storeAddress = $store->meta->address; // option 2
    $storeAddress = $store->fields->address; // option 3
}

```

### Taxonomies

[](#taxonomies)

You can get taxonomies for a specific post like:

```
$post = Post::find(1);
$taxonomy = $post->taxonomies()->first();
echo $taxonomy->taxonomy;

```

Or you can search for posts using its taxonomies:

```
$post = Post::taxonomy('category', 'php')->first();

```

### Pages

[](#pages)

Pages are like custom post types. You can use `Post::type('page')` or the `Page` class.

```
// Find a page by slug
$page = Page::slug('about')->first(); // OR
$page = Post::type('page')->slug('about')->first();
echo $page->post_title;

```

### Categories & Taxonomies

[](#categories--taxonomies)

Get a category or taxonomy or load posts from a certain category. There are multiple ways to achief it.

```
// all categories
$cat = Taxonomy::category()->slug('uncategorized')->posts()->first();
echo ""; print_r($cat->name); echo "";

// only all categories and posts connected with it
$cat = Taxonomy::where('taxonomy', 'category')->with('posts')->get();
$cat->each(function($category) {
    echo $category->name;
});

// clean and simple all posts from a category
$cat = Category::slug('uncategorized')->posts()->first();
$cat->posts->each(function($post) {
    echo $post->post_title;
});

```

### Attachment and Revision

[](#attachment-and-revision)

Getting the attachment and/or revision from a `Post` or `Page`.

```
$page = Page::slug('about')->with('attachment')->first();
// get feature image from page or post
print_r($page->attachment);

$post = Post::slug('test')->with('revision')->first();
// get all revisions from a post or page
print_r($post->revision);

```

TODO
----

[](#todo)

I'm already working with Wordpress comments integration.

Licence
-------

[](#licence)

Corcel is licensed under the MIT license.

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/a7a3e86f4c5b8711afc3fa0c0cc06cc93ea32bd4a6056085ca67419d6715e378?d=identicon)[ycms](/maintainers/ycms)

### Embed Badge

![Health badge](/badges/ycms-corcel/health.svg)

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

###  Alternatives

[doctrine/orm

Object-Relational-Mapper for PHP

10.2k285.3M6.2k](/packages/doctrine-orm)[jdorn/sql-formatter

a PHP SQL highlighting library

3.9k115.1M102](/packages/jdorn-sql-formatter)[illuminate/database

The Illuminate Database package.

2.8k52.4M9.4k](/packages/illuminate-database)[ramsey/uuid-doctrine

Use ramsey/uuid as a Doctrine field type.

90440.3M211](/packages/ramsey-uuid-doctrine)[reliese/laravel

Reliese Components for Laravel Framework code generation.

1.7k3.4M16](/packages/reliese-laravel)[wildside/userstamps

Laravel Userstamps provides an Eloquent trait which automatically maintains `created\_by` and `updated\_by` columns on your model, populated by the currently authenticated user in your application.

7511.7M13](/packages/wildside-userstamps)

PHPackages © 2026

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