floor12/yii2-opengraph

为Yii 2实现的Open Graph

安装: 16

依赖项: 0

建议者: 0

安全: 0

星标: 1

关注者: 2

分支: 12

类型:yii2-extension

0.1.0 2018-02-10 11:05 UTC

This package is auto-updated.

Last update: 2024-09-10 04:36:45 UTC


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 Cards

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

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