【WordPress】ショートコードで外部PHPファイルを読み込む

2023年9月6日

ショートコードを使って、コールバック関数で定義したPHPを実行できたのが前回です。

【WordPress】ショートコードでカスタムフィールドの値を投稿内で表示する

カスタムフィールドを自作した場合、表示するには呼び出すためのコードを書かないと、フロントエンドで ...

https://pirock-oq.info/post-58/

これで満足してたのですが、データの一覧表示も必要だと思い。

じゃあテンプレートファイルの編集・・・とも思ったのですが。

表示したいのは1つの固定ページのさらに1部分で、全体のデザインを変える気がなかったので。

専用のPHPファイルを作成し、ショートコードで読み込めないかなと。

ちょっと試してみることに。

Contents

1. テンプレートファイルの読み込みのget_template_part()
2. ショートコードのコールバック関数の引数を利用する
3. テンプレートファイル作成以外でも

テンプレートファイルの読み込みのget_template_part()

最初に調べて見て見つかったのは、ワードプレス関数のget_template_part()を使った方法。

確かにテンプレートファイルの読み込みで使用しているので、外部ファイルの読み込みにも利用できるんだなぁと。

Luxeritas開発者のるなさんが投稿している内容なので、掲載してくださっているコード中盤のadd_shortcode()以降を調整すれば良いかなと思いましたが。

get_template_part()の読み込みはrequireで行われるそうで。

閲覧者の少ない時間帯でのアップロードを考えているとはいえ、何かしらの間違いがあってfatal errorを吐き出されたらやだなぁと。

・・・メンテナンス時間を別で作れという話なんですがｗ

ショートコードのコールバック関数の引数を利用する

ということで、このようなコードで実装することに。

add_shortcode( 'test_list',function( $args, $contents ){
  extract( shortcode_atts( array(
      'file' => 'test-list.php',
      ), $args ) );

  ob_start();
  include( get_stylesheet_directory() . '/ディレクトリ名/' . $file );
  return ob_get_clean();
  return $contents;
}, 99);

ショートコードを追加するadd_shortcode()のコールバック関数には、$attsという連想配列が用意されています。

連想配列にextract()を使用し配列の属性を変数として扱うことで、ショートコードで指定した値をショートコードの関数に渡していたということなんですねー。

今回はそこに外部PHPファイル名を指定し、$fileという変数を扱える用にしています。

そして、ob_start()とob_get_clean()の間で、一時的な処理として相対パスで指定した場所のファイルをincludeで読み込んでいます。

これで無事ショートコード[test-list]を使用して、外部ファイルを読み込むことができました。