フロントエンドでテーマやプラグインのどのプログラムが動いているかを可視化できるプラグイン「Theme Structure Visualiser」

フロントエンドでテーマやプラグインのどのプログラムが動いているかを可視化できるプラグイン「Theme Structure Visualiser」

WordPressはデータベースに保存した情報をテーマを通すことでページとして表示される仕組みなのはご存じですよね?

WordPressでサイトを作り始めたときにはたくさんあるテーマからどれを選ぼうかというのも1つの楽しみ。でも1歩進んでそのテーマを編集(カスタマイズ)しようと思ったときに困るのがテーマ内のどのファイルがカスタマイズしたい場所で使われているかが分からないこと。

テーマの構造は単独ページを表示する場合は通常

  1. ヘッダー部分(header.php)
  2. 本文部分(single.php)
  3. サイドバー部分(sidebar.phpなど)
  4. フッター部分(footer.php)

で構成されており、ファイル数の少ないテーマではこれらのファイルにびっしりとプログラムが書かれている場合もあります。

が、最近のテーマはカスタマイズしやすいように、また、重複したコードをなるべく少なくするためにこれらのファイルは別のファイルから読み込むための命令だけ記述して、その他のファイルに部分部分が書かれているのが一般的だと思います。

そのテーマをずっと使っていて少しずつ解読していけばいいのでしょうけど、中には何十個もファイルがあるなんてことも少なくありません(このサイトで使用させていただいている【Simplicity2】テーマもたくさんのファイルがあります)。

今回紹介する【Theme Structure Visualiser】は有効化してからフロントエンド(閲覧画面)を表示するとどこの部分にどのファイルが使われているかが一目瞭然となるテーマカスタマイズ時にはとても便利なプラグインです。

イメージとしてはこんな感じです(プラグイン公式紹介ページの画像です)

フロントエンドでテーマやプラグインのどのプログラムが動いているかを可視化できるプラグイン「Theme Structure Visualiser」|Knowledge Base

【Theme Structure Visualiser】プラグインの基本的な機能・できること

  1. 表示されているフロントエンドの部分部分にどのファイルが使われているかを表示
  2. テーマだけでなくフロントエンドに何かを表示するプラグインのファイル名も表示される

※権限やログイン/未ログインにかかわらずファイル名が表示され、デザインが崩れてしまうので、調べたいときにだけ有効化することをおすすめします。

本記事を参考にWordPressサイトへプラグインの導入を検討される方へ

WordPressは古くから無料で配布されているサイト作成ツール(CMS)で、随時改良が加えられており、さまざまなバージョンが存在します。

さらにWordPressを動かすためのプログラムであるPHP、サイトのデータを保存しておくためのデータベースについても様々なバージョンがあります。

そしてWordPress本体同様にプラグインについてもさまざまなバージョンが存在します。

本記事を参考にプラグインの導入をお考えの方は、以下に留意の上でインストールするようにしてください。

  • テスト環境での動作に基づいた紹介記事ですので、すべての環境で正常に動作するかどうかは不明です
    ※本記事の内容についてはページ内に記載しているプラグインバージョンのものになります。現在のバージョンと異なる場合、機能などが異なる場合があります。
    ※また、テスト環境、テストしたプラグインバージョン等の表示が本文内にない場合、ページタイトル下にある最終更新日当時の情報となりますので、現在のバージョンでは全く違う機能となっているかも知れません。
  • プラグインに無料版と有料版(Pro版)がある場合、特に記載がなければ無料版の情報のみを紹介しています
  • このページでプラグインを使用する際に必要なショートコードやコードなどは、コピーして使用することができますが、環境によっては記号などが文字化けすることがあります。コピーしたのに動作しない場合は特に「”」「’」などの記号を入力し直してみてください。
  • プラグイン本体の動作不具合や質問などは公式サイトのフォーラムなどで行ってください(ここでは質問にお答えすることはできません)

【Theme Structure Visualiser】プラグインの設定画面や表示の日本語化と翻訳

【Theme Structure Visualiser】プラグインは設定項目が少ないので特に必要ないと思います

【Theme Structure Visualiser】プラグインのインストールと設定

インストール方法

インストールはプラグインの新規追加でプラグイン名を入力して検索してインストールするか、WordPressのプラグイン公式配布ページからダウンロード後、管理画面からアップロードインストールしてください(プラグインの公式ページは本ページ内記載のリンクをクリック、もしくは、WordPress公式サイトで検索してください)。

WordPressを使い始めて間もない方(初心者の方)は、より詳細なプラグインのインストール手順や、インストール時に起こる問題などへの対処方法をまとめた【WordPress】プラグインのインストール&追加方法とエラー対処の方法も併せてご覧ください。

【Theme Structure Visualiser】プラグインの基本的な使い方

設定はダッシュボードから「設定」→「TSV Options」で行います。

項目は表示されるファイル名の背景色・文字色の2つです。

フロントエンドでテーマやプラグインのどのプログラムが動いているかを可視化できるプラグイン「Theme Structure Visualiser」|Knowledge Base

プラグインのテスト環境&個人的評価

最後に【Theme Structure Visualiser】を動作確認した際の環境と個人的な評価を書いておきます。導入の検討や参考になれば幸いです。

テストした環境

  • テストサーバー:カラフルボックス
  • WordPressのバージョン:4.9.0
  • PHPのバージョン:7.0
  • テーマ:Simplicity2 バージョン2.3.0g
  • プラグインのバージョン:本記事で紹介しているバージョン 1.0.1/最新バージョン 1.0.1
  • 公式サイト(wordpress.org上):https://wordpress.org/plugins/theme-structure-visualiser/
  • 公式サイト(作者サイト):

個人的な評価・感想ほか

  1. 設定のしやすさ:★★★★★
  2. 使いやすさ:★★★★★
  3. おすすめ度:★★★★★

設定画面で色の指定ができますが、テスト環境では色を変更して更新するとエラーが出ました(そのままフロントエンドを表示すると設定した色にはなります)。

また、プラグインを適用して表示したフロントエンドには確かに使われているPHPファイルが表示されて便利なのですが、リンクが設定されていながらリンクをクリックしてもページがリロードされるだけになっています。

更にログアウトした状態(通常の訪問者の状態)でもPHPファイル情報が表示されてしまうのでデザイン崩れのまま、ファイル情報を表示したままになってしまいます。この情報を使うのは管理者だけだと思うので、ユーザー権限による制限が設けられればなおいいかなぁと思いました。

この3点が改善されればカスタマイズする側にとって非常に有用なプラグインだと思います。

サイトへの支援をお願いします

最後までお読みいただきありがとうございました。本記事の内容がお役に立てましたら幸いです。
今後もよりよい情報を提供し続けることができるよう、投げ銭によるサイトへの支援、およびSNSによる拡散をお願いします

作者:

☆最後までお読みいただきありがとうございました。記事作者のひまあーとです。
☆Wordpressでサイトをカスタマイズしていく上で有用な情報を配信しつつ、「ココナラ」でサイトカスタマイズのお手伝い、不具合の修復、サイト引っ越し代行などをさせていただいております。

年齢:40代 趣味/園芸・ペット・卓球