wordpressでショートコードを作成する

こんばんは。きわさです。

今回はwordpressのショートコードについてです。

ショートコードとは

wordpressで記事を投稿するときに動的に内容を出力する機能、でしょうか。あるいは動作を呼び出すための短いコードとでもいうのでしょうか。

ショートコードは例えば
[testcode]などのように、”[“と”]“で文字を括った形で記述します。

すると記事では、[testcode]の代わりに、対応する処理によって出力された内容が表示されるというわけです。

説明ではわかりにくいので実際にショートコードを作成してみます。

ショートコードを作成

functions.phpを編集します。
今回はtestcodeというショートコードを用意します。

add_shortcode('testcode', 'testFunction');

add_shortcode()によってショートコードと関数を紐づけます。
これはtestcodeというコードでtestFunctionという関数を呼び出すということです。

それでは次に、呼び出されるtestFunctionを用意します。

function testFunction() {
    $str = "TEST MESSAGE";
    return $str;
}

これはただ単に”TEST MESSAGE”という文言を返却している関数です。

これでショートコードは完成です。
あとは記事内で[testcode]と記述すれば、testFunctionが呼ばれ、その戻り値であるTEST MESSAGEが[testcode]と置き換わるわけです。

今回はテストコードですが、実際はこの関数で動的に内容を生成し戻り値として返してあげればよいのです。
これは結構便利そうですね。