WordPress 4.3.0 で、サイトアイコンが設定できるようになりました。

プラグインからの取得方法など。

サイトアイコンが設定できるようになった！

今までも自分で一番上のディレクトリに「favicon.ico」を置いておいたり、テーマの機能でサイトアイコンを設定したりしていましたが、WordPressの標準機能としてサイトアイコン（ファビコン）が設定できるようになりました。

32×32と192×192の「icon」（サイトアイコン）と、iOSのアイコンに表示するための「apple-touch-icon-precomposed」（多分180×180）と、Windows8以降のピン留め時に表示するための「msapplication-TileImage」としてHTMLに出力してくれるようです。

[link url=”https://developer.wordpress.org/reference/functions/wp_site_icon/”]

サイトアイコンの設定と削除の方法は、「はぴすぶ」さんのページにまとまっていました。

[link url=”http://hapisupu.com/2015/08/wordpress-4-3-site-icon-favicon/”]

ダブルで出力されていても特に問題は無いと思いますが、「サイトアイコン直したつもりなのに直らない？」とかなりそうなので、header.phpに直接書かれているサイトアイコンの表記は削除しておいても良いかも知れません。

サイトアイコンをWebAPIで取得

ちょっとお話しは変わりまして…。

外部リンクを「はてなブログカード」で表示するWordPressプラグイン「Pz-HatenaBlogCard」を公開しています。

サイトアイコンのURLを取得するのは結構手間だったりするので、サイトアイコンの取得はWebAPIにぶん投げています。

内部サイトの場合もサイトアイコンのURLを素直に取得する手段は無かったため、外部サイト同様WebAPIを使用しています。

Pz-HatenaBlogCard を使っていただいている方から、サイトアイコンが表示されないという話がありました。

https://twitter.com/misoji_13/status/645980175566422016

標準では「Hatena::Favicon」を使用しているのですが、「http://」とかから書かれていない場合、うまく取得ができないようです。

[html]<link rel=”icon” href=”http://poporon.poponet.jp/favicon.ico” />[/html]
↓取得できる。

[html]<link rel=”icon” href=”/favicon.ico” />[/html]
↓取得できない。

「http://favicon.hatena.ne.jp/?url=%URL%」でも「http://favicon.st-hatena.com/?url=%URL%」でも取得できません。

「はてなブログカード」では取得できているので、仕組みが少し違うようです。

使用しているWordPressテーマによって、サイトアイコンのURLの出力の仕方が違ったり、WebAPIでどこまで追いかけるかが違っていたりして、ブラウザでは表示されていても、WebAPIでは取得できない場合があります。

とりあえず今回は、Google のサイトアイコン取得APIを使うように設定してみたところ、うまく表示ができたので、設定を変更していただくように伝えました。

[html title=”ファビコンの取得API” wrap=”true”]http://favicon.hatena.ne.jp/?url=%URL%[/html]
↓
[html title=”ファビコンの取得API” wrap=”true”]http://www.google.com/s2/favicons?domain=%DOMAIN%[/html]

Googleの「domain」パラメータにはドメイン名じゃなくても、記事URLとかでも取得できたりするので、昔よりも柔軟で高性能になってる気がします。

 自サイトのサイトアイコンを取得する方法

お話し戻りまして。

WordPress 4.3.0 から標準でサイトアイコンが設定できるようになりました。

ということは、「標準の関数でサイトアイコンが取得できるのでは？Σ(ﾟロﾟ)oﾞ」と思うわけです。

「Codex日本語版」では詳細がまだ無いようで、HTMLにサイトアイコンの記述を出力する「wp_site_icon()」しか書いていないようです。

もうちょっと見ていくと、サイトアイコンに関する関数は「wp_site_icon()」「get_site_icon_url()」「site_icon_url()」「has_site_icon()」の4つが追加されているようです。

[link url=”https://make.wordpress.org/core/2015/07/27/site-icon/”]

わからーん！Σ(ﾟロﾟ)oﾞ
↓
英語が…英語力が欲しいですΣ(ﾟロﾟ)oﾞ（しかし勉強はしたくない。）
↓
WordPressの関数で困ったときは、こっちだッ！Σ(ﾟロﾟ)oﾞ
↓

[link url=”http://elearn.jp/wpman/function/get_site_icon_url.html”]

↓
あったー！Σ(ﾟロﾟ)oﾞ

「WordPress私的マニュアル」さんのところにありました。

さらには wp_head() が呼ばれたところで wp_site_icon が呼ばれて、みたいなところも書いてありました。

スゲーΣ(ﾟロﾟ)oﾞ

[link url=”http://elearn.jp/wpman/column/c20150827_01.html”]

自分で使いたい関数をメインに、あくまでも「私的」として書いてるからこその速さなんだろうなぁΣ(ﾟロﾟ)oﾞ

とりあえず、has_site_icon() でサイトアイコンが定義されているかどうかを見て、get_site_icon_url() でURLが取得できそうです。

[php]echo ‘has_site_icon=’.has_site_icon().'<br />’;
echo ‘get_site_icon_url=’.get_site_icon_url().'<br />’;[/php]
↓

無事取得できました。

ということは、こんな感じで良さそうです。

[php]if (has_site_icon()) echo ‘<img src=”‘.get_site_icon_url().'”>’;[/php]
↓

自サイトのときはWebAPI経由じゃなくてもサイトアイコンが取得できました。

テーマ独自で設定している場合、この方法では取得できないので、取得するかどうか設定項目を付けた方がよさそうですね。

あと、WordPress 4.3.0 以降でしか使用できない関数なので、function_exists() でチェックもした方がいいかもしれません。

WordPressで外部リンクを「はてなブログカード」に置き換えて表示させるプラグイン「Pz-HatenaBlogCard」のver1.2.1を公式プラグインディレクトリにて公開したところ、さっそくご意見をいただいたので調べてみました。

ソーシャルカウントの取得方法

ソーシャルカウントの取得には、FILE_GET_COUNTを使って、ソーシャルカウント取得APIから値を取得しています。

ちなみに「Syncer」さんの「ソーシャルカウント取得方法まとめ」を参考にさせていただきました。

[link url=”https://syncer.jp/how-to-get-sns-count”]

ツイッターの場合、APIを叩くとJSON形式で返してくるので、それを配列に入れておきます。

[php]$json = json_decode( @file_get_contents( ‘http://urls.api.twitter.com/1/urls/count.json?url=’.rawurlencode($url)), true );[/php]

そこから、「count」を取得して、空っぽだったら「0」をセットしています。

「file_get_contents」の前に「@」（アットマーク）が付いているのは、「エラー出てもエラー吐かずにスルーしてね」という意味です。

[php start-line=”2″]$count = isset($json[‘count’]) ? $json[‘count’] : 0 ;[/php]

そして、取得したカウントが0より多かったら、カウントの表示をしています。

[php start-line=”3″]if ($count > 0 ) {
$domain_info .= ‘<span class=”linkcard-sns-twitter”>’.$count.’&nbsp;tweet’.(($count > 1) ? ‘s’ : ”).'</span>’;
}[/php]

「(($count > 1) ? ‘s’ : ”)」っていうところで、1だったら「1 tweet」、2以上だったら「2 tweets」と、「s」を付けるようにしています。

さて、「はてなブックマーク数やツイート数が取得できない」という話をいただきました。

そちらのサイトさんを見に行くと確かにカウントが表示されていませんでした。

自分のテストサイトを使って同じURLでブログカードをつくってみると、ちゃんとカウント数が表示されます。

「（外部サイト）」と表示されているので、「はてなブログカード」では無くオリジナル形式で表示されているようです。

また、設定画面のハードコピーもいただいたので、設定も問題無さそうです。

GET_FILE_CONTENTSが使えない？

サーバー内のファイルも開ければ、URLを指定すればHTMLも取得できる「get_file_contents」ですが、どうやらphpの設定によってはURL指定が出来ないらしいです。

php.ini を編集することで、有効にできるようです。

[php]allow_url_fopen = On[/php]

信頼できないファイルを取得してしまう場合があるので、安全性を取るか利便性を取るかみたいなところなんだと思います。

レンタルサーバーなどによっては php.ini を編集できない場合もあるので、今回は別の取得方法を検討してみます。

cURLなら取得できそう

「記述がラクで、少ない行数で書けるかなぁ」という考えでget_file_contentsを使っていたのですが、cURLを使った方が良さそうです。

[link url=”https://popozure.info/20150730/7836″]

cURLは、あたかもブラウザでサイトを見に行ったようなことができる関数です。

使いこなしたらスクレイピングみたいなことは何でも出来そうな気がします。

wp_remote_getも使えそう

WordPressの関数で、「安全なHTML取得」みたいなのがあったと思ったのですが、思い出せず。

調べてみたところ、探していたのは「wp_remote_get」関数だったようです。

[link url=”http://hayashikejinan.com/wordpress/functions/371/”]

「安全な」というフレーズをどこで見たのかは分かりませんが、今回はこれを使ってみようと思います。

書き換えてみる

ツイート数を例に。

変更前は、file_get_contents で body を取得しつつも json_decode で連想配列方式に変換。

連想配列から「count」を取得して、0より上ならカウントを表示しています。

[php title=”pz-hatenablogcard.php 変更前” start-line=”366″]$json = json_decode( @file_get_contents( ‘http://urls.api.twitter.com/1/urls/count.json?url=’.rawurlencode($url)), true );
$count = isset($json[‘count’]) ? $json[‘count’] : 0 ;
if ($count > 0 ) {
$domain_info .= ‘<span class=”linkcard-sns-twitter”>’.$count.’&nbsp;tweet’.(($count > 1) ? ‘s’ : ”).'</span>’;
}[/php]

基本的には file_get_contents を wp_remote_get に置き換えます。

file_get_contents は、body を直接返してくれましたが、wp_remote_get の場合はステータスとかも込みで連想配列で返してくれます。

いったん配列に入れて「body」を取り出すために1行増えています。

[php title=”pz-hatenablogcard.php 変更後” start-line=”369″]$array = wp_remote_get( ‘http://urls.api.twitter.com/1/urls/count.json?url=’.rawurlencode($url) );
$json = json_decode( (isset($array[‘body’]) ? $array[‘body’] : null), true );
$count = ( (isset($json[‘count’]) ? $json[‘count’] : 0) );
if ($count > 0 ) {
$domain_info .= ‘<span class=”linkcard-sns-twitter”>’.$count.’&nbsp;tweet’.(($count > 1) ? ‘s’ : ”).'</span>’;
}[/php]

同じ結果が表示されたのを確認しました。

「取得エラー時の処理を書いてないけど、大丈夫かな！Σ(ﾟロﾟ)oﾞ」と思いましたが…。

大丈夫じゃありませんでしたΣ(ﾟロﾟ)oﾞ

相手サイトが落ちてたりすると、こっちもエラーが出てしまうようです。

「おち研」さんのところに、wp_remote_get を使ってシンプルにソーシャルカウントを取る方法がありました。

[link url=”http://www.02320.net/get_social_share_count/”]

wp_remote_get をしたあとに、isset でセットされていること、wp_error でエラーを確認して、jsonデコードしつつも値をセットして、0を引くことで数値にしちゃう感じです。

[php]$array = wp_remote_get( ‘http://urls.api.twitter.com/1/urls/count.json?url=’ .rawurlencode($url) );
if (isset($array) && !is_wp_error($array)) {
$count = json_decode($array[‘body’])->count – 0;
if ($count > 0 ) {
$domain_info .= ‘<span class=”linkcard-sns-twitter”>’.$count.’&nbsp;tweet’.(($count > 1) ? ‘s’ : ”).'</span>’;
}
}[/php]

相手サイトが落ちていても、wp_error で引っかかるので大丈夫そうです。（適当なアドレスに書き換えたとき、シェア数0として動作しました。）

とりあえずリリースしてみます

一応テストサーバーがあって、過去に報告をいただいた方が使っているテーマやらプラグインを入れた環境でテストするように心掛けてはいるものの、環境のパターンは無数にあって難しいです(^-^;

でも、リリースするたびに、色々言ってもらって、新しい発見があったりするのは嬉しいです。

トラブルシューティングも楽しいので良いのですが、安定して使いたい方のところで止まってしまうとあせってしまいますね(^-^;

というわけで、準備でき次第、ver1.2.2 としてリリースします。