README

一个库，可以将WordPress表转换为Laravel Eloquent模型。这对于可能更愿意使用Laravel Eloquent强大功能的任何WordPress项目都有帮助。

或者，您可能正在使用Laravel和Roots Bedrock/Sage等构建项目，并想在Laravel中访问WordPress数据。或者，您可能正在使用类似Slim或更好的Lumen编写API，不想通过加载整个WP核心来增加您的加载时间。

这是一个基于Laravel的Eloquent的绝佳模板，可以帮助您开始。

注意：这是Eloquent附加功能的文档。有关Eloquent所有功能的文档，请访问文档。

概述

安装
设置
使用Laravel设置
文章
评论
术语
用户
元数据
选项
链接
扩展您自己的模型
查询日志

安装WPEloquent

推荐通过Composer安装WPEloquent。

composer require mallardduck/wp-eloquent-models

版本指南

设置 - 常见

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
]);

如果您想在整个WP安装上启用此功能，可以创建一个包含上述代码的文件，并将其放入mu-plugins文件夹中。

使用Laravel设置

以下说明是在您想使用Laravel中的Eloquent在WordPress数据库中工作时。最简单的方法是在Laravel的config/database.php中创建一个新的配置。例如

    'wordpress' => [
        'driver' => 'mysql',
        'url' => env('DATABASE_URL'),
        'host' => env('DB_HOST', '127.0.0.1'),
        'port' => env('DB_PORT', '3306'),
        'database' => env('DB_NAME', 'wordpress'),
        'username' => env('DB_USER', 'forge'),
        'password' => env('DB_PASSWORD', ''),
        'unix_socket' => env('DB_SOCKET', ''),
        'charset' => 'utf8mb4',
        'collation' => 'utf8mb4_unicode_ci',
        'prefix' => env('DB_PREFIX', 'wp_'),
        'prefix_indexes' => true,
        'strict' => true,
        'engine' => null,
        'options' => extension_loaded('pdo_mysql') ? array_filter([
            PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'),
        ]) : [],
    ],

注意： 在此示例中，WordPress数据库和Laravel数据库可以由同一个MySQL用户在同一个服务器上访问。您可能需要调整项目的laravel .env以匹配此示例。

然后在您的AppServiceProvider中添加以下行

BaseModel::setDefaultConnection('wordpress');

支持的模型

文章

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;

状态

默认情况下，Post返回所有状态的文章。但是，您可以通过使用局部作用域 published来覆盖此操作，仅返回已发布文章。

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

或者，如果您需要特定的状态，可以通过局部作用域使用定义的状态来覆盖。

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

文章类型

默认情况下，Post返回所有文章类型的文章。但是，您可以通过定义文章类型通过局部作用域来覆盖此操作。

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

use \WPEloquent\Model\Comment;

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

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

术语

在此版本中，Term仍然作为模型可访问，但只能通过文章访问。

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

用户

use \WPEloquent\Model\User;

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

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

元数据

模型Post、User、Comment、Term都实现了HasMeta。因此，可以通过getMeta和setMeta辅助函数轻松检索元数据和设置。

$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');

选项

在WordPress中，您可以使用get_option。或者，如果您不想加载WordPress核心，可以使用辅助函数getValue。

use \WPEloquent\Model\Post;

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

或者当然，长格式

use \WPEloquent\Model\Options;

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

链接

use \WPEloquent\Model\Link;

$siteurl = Link::find(1);

扩展您自己的模型

如果您想向模型添加自己的功能，例如一个用户，可以这样操作：

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');
    }

}

另一个例子是为文章的自定义分类，比如国家：

namespace App\Model;

class Post extends \WPEloquent\Model\Post {

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

}

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

或者您可能需要访问自定义的文章类型，如下：

namespace App\Model;

class CustomPostType extends \WPEloquent\Model\Post {
    protected $post_type  = 'custom_post_type';

    public static function getBySlug(string $slug): self
    {
        return self::where('post_name', $slug)->firstOrfail();
    }
}

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

查询日志

有时查看查询日志对于调试很有帮助。您可以通过将log设置为true来启用日志（见设置）在Laravel::connect方法上。通过运行来检索日志。

use \WPEloquent\Core\Laravel;

print_r(Laravel::queryLog());

mallardduck / wp-eloquent-models

维护者

详细信息