README

Yii 2 的 Open Graph 实现，为您的 HTML 输出添加有效的元标签。

配置

'components' => [
	'opengraph' => [
		'class' => 'dragonjet\opengraph\OpenGraph',
	],
	//....
],

使用

以下代码必须在渲染视图之前在控制器操作中使用。

通过对象使用

Yii::$app->opengraph->title = 'My_Article';
Yii::$app->opengraph->description = 'My_Article_Description';
Yii::$app->opengraph->image = 'http://image.for.my/article';
return $this->render('My_View_Name');

通过数组使用

Yii::$app->opengraph->set([
	'title' => 'My_Article',
	'description' => 'My_Article_Description',
	'image' => 'http://image.for.my/article',
]);
return $this->render('My_View_Name');

Twitter 卡片

Yii::$app->opengraph->title = 'My_Article';
Yii::$app->opengraph->description = 'My_Article_Description';
Yii::$app->opengraph->image = 'http://image.for.my/article';
Yii::$app->opengraph->twitter->card = 'summary';
Yii::$app->opengraph->twitter->site = 'My_Site_Twitter_Username';
Yii::$app->opengraph->twitter->creator = 'Author_Username';
return $this->render('My_View_Name');

或

Yii::$app->opengraph->set([
	'title' => 'My_Article',
	'description' => 'My_Article_Description',
	'image' => 'http://image.for.my/article',
	'twitter' => [
		'card' => 'summary',
		'site' => 'My_Site_Twitter_Username',
		'creator' => 'Author_Username',
	],
]);
return $this->render('My_View_Name');

可用属性

标题

Yii::$app->opengraph->title

这是在社交分享中显示的标题。与视图标题相比，这应该更简单，不应包含您的品牌，这是根据《Facebook 分享指南》的最佳实践。

• "不包括任何品牌的文章标题。"
• "标题不应包含品牌或无关信息。"

例如，"MySite.com - Blog - Hello world!" 应该只是 "Hello World!"

网站名称

Yii::$app->opengraph->site_name

[自动] 这是您的网站名称。如果您在 Yii 配置中有一个 name 应用程序，则不需要在每次控制器操作中指定此名称。

return [
    'id' => 'yiiappid',
	'name' => 'My Website',
    //....
]

URL

Yii::$app->opengraph->url

[自动] 这将自动预填当前 URL。您不需要在每次控制器操作中指定此 URL。

描述

Yii::$app->opengraph->description

当前页面的描述。虽然不是必需的，但建议使用，以获得最佳的社交分享效果。

对象类型

Yii::$app->opengraph->type

此页面将在社交媒体上显示的对象类型。默认为 article。

区域设置

Yii::$app->opengraph->locale

[自动] 这是 Open Graph 对象的区域设置（语言）。默认为您的 Yii 应用程序语言。

图像

Yii::$app->opengraph->image

Open Graph 对象的图像。强烈建议使用，以获得在社交媒体上分享的最佳效果。为了在 Facebook 上获得最佳效果，此图像至少应为 600x315px。