WordPressに自作ショートコードを作成して埋め込む方法

WordPressにプラグインではなく、自作したPHPの処理のショートコードを埋め込みたい時がある。

わざわざプラグインを導入する必要のないような、ちょっとした処理をショートコード化しておくと色々と便利です。

「Shortcoder」のようなショートコード作成プラグインもありますが、全て自作でショートコードを作りたいというケースも多いので解説していきます。

ショートコードとは何か？
ショートコード用のPHPの関数を作成してみる
functions.phpの編集
投稿内にショートコードを追加
ショートコードの引数について
まとめ

ショートコードとは何か？

WordPressでは投稿や固定ページにエディタで文字や画像を書き込むことは出来ますが、投稿や固定ページにPHPのスクリプトを直接記述することはできません。

そこで、functions.phpという関数を書き込むためのPHPファイルに、自分で作成した関数（処理）をあらかじめ書き込んでおき、その関数を投稿内や固定ページから呼び出すことで、投稿や固定ページ内でPHPを実行することが可能になります。

そして、その関数を呼び出すためのコードをショートコード（ショートコードタグ）と呼びます。

例としては、お問い合わせフォームを作成するプラグイン「Contact Form 7」で作成したフォームを、固定ページに張り付ける際によく見る以下のショートコードなどが代表例です。

■ショートコードの例（contact-form-7）
[contact-form-7 id="xxxx" title="お問い合わせフォーム"]

ショートコードの書式は、角括弧（ブラケット）と呼ばれる[ ]を利用して関数名（およびその引数）を囲います。※[ ]で囲うことによりショートコードとして認識されます。

処理の流れとしては、[ ]で囲まれた文字列が投稿内や固定ページ内にある場合、functions.phpにその名前の関数が存在するか否かをチェックし、関数が存在した場合にはPHPが実行されるという流れになります。

ショートコード用のPHPの関数を作成してみる

それでは、PHPの関数を自作してみます。今回は例として、超簡単な「Hello, world! (現在日時)」を表示するというだけのhello_world_testという関数を作成します。

function hello_world_test() { 
    $datetime = current_time("Y-m-d H:i:s");
    $html = "Hello, world! ($datetime)";
    return $html;
}

function hello_world_test() {

$datetime = current_time("Y-m-d H:i:s");

$html = "Hello, world! ($datetime)";

return $html;

}

次に、このhello_world_testという関数をショートコードタグと関連づけるコードを作成します。

add_shortcode('short_code_hello_world_test', 'hello_world_test');

1	add_shortcode('short_code_hello_world_test', 'hello_world_test');

解説すると、short_code_hello_world_testというショートコードが見つかった場合にはhello_world_testというコールバック関数を実行せよという意味です。

まとめると以下のようになります。

function hello_world_test() { 
    $datetime = current_time("Y-m-d H:i:s");
    $html = "Hello, world! ($datetime)";
    return $html;
}
add_shortcode('short_code_hello_world_test', 'hello_world_test');

function hello_world_test() {

$datetime = current_time("Y-m-d H:i:s");

$html = "Hello, world! ($datetime)";

return $html;

}

add_shortcode('short_code_hello_world_test', 'hello_world_test');

functions.phpの編集

functions.phpが存在する場所

functions.phpは、WordPressのインストールディレクトリ以下の「wp-content/themes/テーマ名/」の中にあります。

functions.phpの編集方法と注意事項

functions.phpの編集は以下の3つの中の好きな方法で行ってください。

「Code Snippets」等のfunctions.php編集プラグインを利用する
WordPress管理画面で編集を行う
FTPクライアントソフトで編集を行う

上記の2または3により手動でfunctions.phpの編集を行う際は以下の2つは必ず行いましょう。

functions.phpを編集する際は子テーマのfunctions.phpを編集する
functions.phpは編集する前に必ずバックアップを取っておく

※当方は出来るだけインストールするプラグインの数を減らしたいのでFTPクライアントにて編集を行いました。

functions.phpに自作したコードを追加する場所

functions.phpが <?php から始まって ?> で終わっている場合は、最終行にある ?> の上の行に先ほど作成したコードを追加します。

<?php
...省略（元から記述されているコード）...
...省略（元から記述されているコード）...
...省略（元から記述されているコード）...

function hello_world_test() { 
    $datetime = current_time("Y-m-d H:i:s");
    $html = "Hello, world! ($datetime)";
    return $html;
}
add_shortcode('short_code_hello_world_test', 'hello_world_test');
?>

<?php

...省略（元から記述されているコード）...

function hello_world_test() {

$datetime = current_time("Y-m-d H:i:s");

$html = "Hello, world! ($datetime)";

return $html;

}

add_shortcode('short_code_hello_world_test', 'hello_world_test');

functions.phpの最終行に ?> が無い場合は、行に先ほど作成したコードを最後のほうに追加します。

<?php
...省略（元から記述されているコード）...
...省略（元から記述されているコード）...
...省略（元から記述されているコード）...

function hello_world_test() { 
    $datetime = current_time("Y-m-d H:i:s");
    $html = "Hello, world! ($datetime)";
    return $html;
}
add_shortcode('short_code_hello_world_test', 'hello_world_test');