【PHPライブラリ】osm⁄sitemap-phpを使って、ページ情報を渡しxmlサイトマップを出力する方法

今回は、以前composerで入れた段階で放置していた『osm⁄sitemap-phpライブラリを使ってxmlサイトマップを出力』というのをやってみます。サイトマップを自分でつくるのはめんどくさいので、ツールで作成するか、ページの情報を取得して生成などがラクです。さっそく内容を確認していってみましょう。

前回の記事～composerで入れたはいいが、肝心のサイトマップをまだ作っていなかった

さて、以前composerコマンドでサイトマップライブラリ入れた、みたいなことは書いたんですけど、肝心のサイトマップをまだ作っていなかったということが発覚しました（忘れていただけ）。なので、改めて今回やってみようということになったわけです。

前回記事（コマンドでインストールしただけ）と、使ってみるライブラリ『osm⁄sitemap-php』については、以下のリンクをご覧ください。

(過去記事)githubリポジトリにrequireコマンドが書いていないライブラリを、コマンドインストールする方法
https://division-web.atelier-ss-agency.com/10701/php-composer-install-library/

osm⁄sitemap-php（githubリポジトリ）
https://github.com/o/sitemap-php

つける（のを想定している）サイトのページ・ディレクトリ構成

まずは、サイトマップにのせるページの情報を定義します。とりあえず・・・ 最近全く使っていない（笑）管理人の曲アレンジ受付サイトに、PHPで生成されるxmlサイトマップを搭載するという形を想定しています。

ローカルにコピーした、このサイトの構成。『assets(jsやcss、画像など)』や『template-parts(ヘッダー、フッター、サンプル曲配信などのパーツ)』は、特に今回はつかわないのでスルー。 今回使うファイル、フォルダは以下の通りです。特商法表記が少しわかりにくいですが『Specified Commercial Transactions』に由来しています。

また、前回composerで入れたサイトマップでは、sitemap-php-develop/src内に、以下のようなファイルが入っていました。requireまたはautoloadで読んで、use〇〇で名前空間とかもロードして使う感じになります。

このうち、AbstractGeneratorは直接ロードしたりはしませんが、WebSitemapGenerator.phpで継承されてます。このライブラリ内は直接エディットはしません。generate_sitemap.phpをメインに作っていくかたちになります。

osm⁄sitemap-phpライブラリでxmlサイトマップを出力するコード・ポイント

というわけで、上記のgenerate_sitemap.phpをエディットしました。コードは以下の通り(guthub gist)。いくつか解説もつけます。

ここら辺はセットアップみたいな感じです。require_onceでライブラリのファイルをロード、use 〇〇でライブラリ由来する名前空間をロード、ドメイン・ディレクトリ・出力されるファイル名を指定して、サイトマップ作るライブラリのインスタンスにします(new WebSitemapGenerator)。

ここら辺はphpによくある『Key-Value Array』で、表示されるときのurlとファイル名をKey-Valueのペアにしています。『配列の[0]がarray(url,file)』みたいにしてもいいんですけど、ちょっと階層が深くなりますよね。

そして、foreachでループ回して、各項目をxmlサイトマップにセットしていく部分。 最初『division-m.atelier-ss-agency.com/./index.phpのような、変なurlがサイトマップに記載された』というのがあったので、str_replaceでドメインを置き換えて相対パス渡すようにしています。

ここら辺は、サイトマップができたときのメッセージや件数など。コマンドやファイルアクセス時に表示されます。このケースではほぼ100%出力成功するので入れていませんが、状況によって生成失敗の可能性がある場合は、エラー時の表示なども入れます

プログラム実行して、xmlサイトマップを出力してみよう

それでは、さっそくこのプログラム(generate_sitemap.php)を実行してみましょう。 ローカル環境でやっていたので、まずはPHPを実行できるようにxammpを立ち上げて、Apatcheをstartします。

そのあと、コマンドプロンプトを立ち上げ、cdコマンドでgenerate_sitemap.phpに移動(実行するときパスつけてやっても良いかも)。 コマンド『php generate_sitemap.php』を叩いて、実行＆サイトマップ生成

ファイル一覧を見ると、sitemap.xmlが出力されていました。

生成されたsitemap.xmlの中身はこんな感じ。『$item->setLastModified』でファイル更新時間を取ったので、これもxmlサイトマップに反映されました。

自動的にxmlサイトマップを生成・更新したい場合は？

ファイル更新したときに実行する仕掛けを作ったりするほか、管理人が考えたのは、Linuxのcronでした。

例えば、管理人が使用しているロリポップサーバースタンダードプランの場合。週に1回とか、決まった時間で実行したい場合は、これが使えます。

あとがき・まとめ

まとめると、こんなところでしょうか。ガンガン更新しないほぼ静的サイトとかでも、ツールとか手打ちで更新じゃなく、自動実行・コマンド実行でサイトマップ生成は、少し楽になると思います。