ogp.inc.php

名称OGP metaタグ出力プラグイン
ファイルogp.inc.php
バージョン1.00
対象サーバーPukiWiki 1.5.3 / PHP 7.4 / UTF-8
対象ブラウザーFirefox, Chrome, Safari, Edge 各最新版
ライセンスGPLv3

OGP metaタグを出力するPukiWiki用プラグイン。

インストール

ogp.inc.php
4.5KB | 2020-05-28

ogp.inc.phpPukiWikipluginディレクトリに配置してください。

使い方

#ogp([title][,[description][,image]])
  • title … ページのタイトル文字列。省略すると「ページ名 - ウィキ名」で代替される
  • description … ページの説明文字列。省略すると「ページ名 - ウィキ名」で代替される
  • image … ページの代表画像。ページ添付画像ファイル名または画像URL。省略すると定数 PLUGIN_OGP_DEFAULT_IMAGE で代替される

使用例

#ogp(サンプルページ,このページはサンプルです。,image.jpg)

設定

コード内の下記の定数で動作を制御することができます。

定数名既定値意味
PLUGIN_OGP_NS_PREFIX文字列OGP名前空間のプリフィクス(og以外の場合に指定)
PLUGIN_OGP_WITH_DESC0 or 111:<meta name="description">タグを出力, 0:なし
PLUGIN_OGP_DEFAULT_IMAGE文字列既定のOGP画像の絶対URL(例:'https://example.com/img/ogp.jpg')
PLUGIN_OGP_TWITTER_SITE文字列Twitterカード用:ウェブサイトの@ユーザー名(例:'@hogeSite')
PLUGIN_OGP_TWITTER_CREATEOR文字列Twitterカード用:コンテンツ作成者の@ユーザー名(例:'@fugaUser')
PLUGIN_OGP_FACEBOOK_APPID文字列Facebook用:App-ID(例:'123456789000000')

補足

本プラグインはデフォルトで属性に「og」プリフィクスのついたmetaタグを出力します。そのため、スキンファイル内のheadまたはhtmlタグ(つまりmetaタグの親要素)にOGP名前空間プリフィクス宣言「prefix="og: http://ogp.me/ns#"」を加えることを推奨します*1。ただし、必須ではありません。RDFa Initial Context仕様において、ogは広く普及しているプリフィクスの一つとして宣言の省略が認められているためです。

FacebookApp-ID(PLUGIN_OGP_FACEBOOK_APPID定数)を設定する場合は、Facebook名前空間プリフィクス宣言「prefix="fb: http://ogp.me/ns/fb#"」が必須となります。

default.ini.phpへの設定

本プラグインの定数設定(ファイル内の下記のような行)は、PukiWikiルートディレクトリにある標準設定ファイルdefault.ini.phpにも記述することができます。本プラグインの定数設定行をdefault.ini.phpの末尾にそのままコピーしてください。default.ini.php側の設定値が優先されます。

/////////////////////////////////////////////////
// ○○プラグイン設定(○○.inc.php)
if (!defined('PLUGIN_○○_×××)) define('PLUGIN_○○_×××', △);

設定をdefault.ini.phpに記述することで、プラグインをアップデート(ファイル上書き)するたびに値を書き直す必要がなくなります。また、設定がdefault.ini.phpに集中することで、運用中の設定管理も楽になります。

凡例

プラグインの引数は下記の書式で表現しています。

  • [] … 省略でき必要に応じて記述します
  • | … |で区切られた項目のうち1つを記述します
  • {} … 中カッコ内の引数は任意の順序で記述できます

*1 イカスキンheadタグには名前空間プリフィクスogfbが宣言されています。