スマートフォン表示の自動切り替え(vt=sp)設定
WIKIPLUSでは、URLに「vt=sp」パラメータを付加することでスマートフォン用の表示に切り替える機能があります。
これは、設定ファイルで制御することができます。
自動切り替えの有効・無効設定
「vt=sp」パラメータの自動付加を制御するには、以下の設定をuser-config.ymlに追加します:
PLUGIN: SYSTEM: VIEWTYPE: AUTOKICK: TRUE # 自動切り替えを有効にする場合
現在の設定は、機能メニュー → レジストリ編集から確認できます。「PLUGIN」→「SYSTEM」→「VIEWTYPE」→「AUTOKICK」の値がTRUEまたはFALSEで表示されています。
≫ 参考:レジストリ編集(特殊パラメータuser_config.ymlの設定)について
バージョンによる違い
- WIKIPLUS Ver4.0まで: AUTOKICKのデフォルト値はTRUE(自動切り替え有効)
- WIKIPLUS Ver5.0以降: AUTOKICKのデフォルト値はFALSE(自動切り替え無効)
Ver4.0からVer4.1へアップデートした場合、既存のサイトの動作が変わらないよう、自動切り替えを有効にしたい場合は明示的に設定を追加してください。
自動切り替えの仕組み
この機能はautokick.jsというJavaScriptファイルによって実現されています。ユーザーのデバイスがスマートフォンと判断された場合に、URLに「vt=sp」パラメータを追加してリダイレクトします。
- AUTOKICK: TRUE: スマートフォンからのアクセス時に自動的に「vt=sp」を付加
- AUTOKICK: FALSE: 自動切り替えを無効化(ユーザーが明示的にvt=spを指定した場合のみスマートフォン表示)
自動切り替えを無効にする理由
最近のWebサイト開発では、レスポンシブデザインの普及により1つのテンプレートで複数デバイスに対応するケースが増えています。このような場合、自動切り替えは不要になるため、Ver5.0以降ではデフォルトでオフになっています。
また、自動リダイレクトによるページ表示の遅延を避けたい場合や、SEO面での最適化(同一コンテンツに対する複数URLの回避)を考慮して無効化することもあります。
関連設定
ViewTypeのホワイトリストはWPUri::setViewTypeWhite()メソッドで設定でき、デフォルトでは以下の値が許可されています:
- ''''(空文字)
- default
- sp
独自のViewTypeを追加する場合は、プラグインなどでこのホワイトリストを拡張する必要があります。
こんなときどうする?
手動で切り替えを可能にするには?
自動切り替えを無効にしている場合でも、ユーザーが手動で表示を切り替えられるようにリンクを設置することをお勧めします:
// ページ下部などに設置するコード例 {if $vt eq 'sp'} [[{$permalink}.html?vt=default|PC表示に切り替え]] {else} [[{$permalink}.html?vt=sp|スマートフォン表示に切り替え]] {/if}
スマートフォン向けのテンプレートはどこにある?
スマートフォン向けのテンプレートは通常のテンプレートと同じディレクトリに配置し、ファイル名の末尾に.sp.tplを付けます。例えば、通常のテンプレートがbase.design.default.tplの場合、スマートフォン用はbase.design.sp.tplとなります。
レスポンシブデザインと併用するには?
レスポンシブデザインを採用している場合は、通常AUTOKICK: FALSEに設定します。ただし、一部のコンテンツだけデバイス別テンプレートを使いたい場合は、それらのページへのリンクに手動で?vt=spを付加するようにしましょう。