東京のホームページ制作・運用・コンサルティング会社

Blog

WordPressでショートコード化をするメリット・方法

自分の勉強もかねてモジュール(カタマリ)をショートコード化してみたのでこの記事ではショートコード化について書きました。

なぜショートコード化するのか

ショートコード化するメリットを考えました。大きく2つの観点からメリットがあります

  • 保守性が上がり、モジュールの修正が容易になる
  • コードがコンパクトにまとまるのでコードの視認性が上がる

保守性が上がり、モジュールの修正が容易になる

一番大きな目的は保守性を上げるためです。

例えば様々なページに同じモジュールを使っていてるとき、そのモジュールに変更があったとします。
もしショートコードを使っていないと各ページのモジュールをひとつひとつ変更していかなければなりません。

しかしショートーコード化しておけばもとのモジュールを一つ直すだけで各ページのすべてのモジュールが修正されます。

保守性が上がり、モジュールの修正が容易になる

コードがコンパクトにまとまるのでコードの視認性が上がる

ショートコードにすることで、とても長く複雑なコードが1行にまとまります。
コードがとても長いモジュールでもショートコードにしてしまえば、どこでそのコードが使っているかがわかりやすくなります。

サイトを修正する際、カタマリが分かりやすくなり、コードの修正箇所がすぐに判断できるようになります。

以上踏まえて、保守性と視認性の観点からよく使うモジュールほどショートカット化する価値があると言えます。

具体的なショートコードの作り方、使い方

ショートコードを登録する

Wordpressのショートコードを追加するadd_shortcodeというタグを使用します。
add_shortcode(ショートコードの名前、使いたい関数)を入れて実装します。

functions.phpにコードを書きます。

  
    function sampleFunc() {
        return "<h2>これは見出しです</h2>";
    }
    add_shortcode('sample', 'sampleFunc');
  

ショートコードを使う

テキストエディタ

Wordpressのテキストエディタであれば、[shortcode名]を入れれば登録したコードが表示されます。今回だと[sample]です。

テンプレートファイル

テンプレートファイルに直接書き込む場合はdo_shortcodeというタグを使えば登録したものを出力できます。

    
        <?php echo do_shortcode( '[sample]' ) ?>
    
  

まとめ

ショートコード化をすることによって、作業効率があがるので様々な場所で使うモジュールはどんどんショートコード化をして効率を上げていきたいですね。

また複雑なadd_shortcodeを使う案件がありましたら、記事にまとめたいと思います。

Soichiro
ホームページで成果を
出すためのアイデアを
紹介しています。
Soichiroについて
購読