WordPressのショートコード活用法とPHPサンプル

WordPressのショートコード
小ネタ君
WordPressをカスタマイズする際、ショートコードとPHPは非常に有効な手段です。本記事では、WordPressのショートコードの基本から応用まで、具体的なPHPコード例を交えながら解説します。
目次

ショートコードとは?

WordPressのショートコードは、特定の機能を簡単に呼び出すための便利なツールです。
ショートコードを使うことで、長いコードを書かずに短い文字列で複雑な処理を実行できます。

以下でショートコードの基本概念とそのメリットについて詳しく説明します。

ショートコードの基本概念

ショートコードは、角括弧 [ ] で囲まれた短いコードで、WordPressの投稿やページ内で使われます。
例えば、[gallery]と入力するだけでギャラリーを表示することができます。

ショートコードのメリット

ショートコードを使うことで、以下のようなメリットがあります。

  • 簡単に機能を追加:投稿やページに特定の機能を簡単に追加できます。
  • コードの再利用:一度作成したショートコードを何度でも再利用できます。
  • 管理の容易さ:一箇所でショートコードを管理できるため、メンテナンスが簡単です。

ショートコードの基本的な使い方

ショートコードの使い方は非常に簡単で、WordPressの投稿やページにショートコードを直接入力するだけです。以下で具体的な作成方法と使用方法を解説します。

ショートコードの作成方法

ショートコードを作成するためには、functions.phpファイルにショートコード用のコードを追加する必要があります。例えば、下記のようなコードです。

function my_shortcode() {
    return 'Hello, World!';
}
add_shortcode('mycode', 'my_shortcode');

このサンプルコードは、WordPressで使用できるカスタムショートコードを作成するものです。
以下に、コードの各部分について解説します。

function my_shortcode() { … }

この部分は、カスタムショートコードの機能を定義する関数です。関数名はmy_shortcodeで、ショートコードが実行されたときに返される内容を決定します。

この例では、単に'Hello, World!'というテキストを返しています。

return ‘Hello, World!’;

この行は、ショートコードが実行されたときに表示されるテキストを指定しています。
ここでは「Hello, World!」という文字列を返します。

add_shortcode(‘mycode’, ‘my_shortcode’);

WordPressにショートコードを登録する関数です。add_shortcode関数は2つの引数を取ります。
最初の引数はショートコードの名前(ここではmycode)、2つ目の引数は実行される関数の名前(ここではmy_shortcode)です。

この例では、[mycode]というショートコードをWordPressに追加し、このショートコードが使用されるとmy_shortcode関数が実行されるようになります。

ショートコードの使用方法

作成したショートコードを呼び出すには、WordPressの投稿やページに以下のように入力するだけです。
[mycode]
これにより、「Hello, World!」というテキストが表示されます。

PHPにショートコードを埋め込む方法

PHPコード内でショートコードを使用したい場合は、do_shortcode関数を使用します。
以下にその例を示します:

<?php
echo do_shortcode('[mycode]');
?>

このようにすることで、PHPコード内でもショートコードの出力を使用することができます。

PHPでショートコードを作成する方法

PHPでショートコードを作成する方法

ショートコードをカスタマイズする際には、PHPで独自のショートコードを作成することができます。
以下に、いくつかの例を紹介します。

簡単なPHPショートコードの例

まず、基本的なショートコードを作成する方法を紹介します。

function my_simple_shortcode() {
    return '<p>これはシンプルなショートコードです。</p>';
}
add_shortcode('simplecode', 'my_simple_shortcode');

パラメーターを使用したショートコード

ショートコードにパラメーターを追加すると、より柔軟に機能を提供できます。
以下は、パラメーターを使用したショートコードの例です。

function my_param_shortcode($atts) {
    $atts = shortcode_atts(
        array(
            'text' => 'デフォルトのテキスト',
        ), $atts, 'paramcode'
    );
    return '<p>' . esc_html($atts['text']) . '</p>';
}
add_shortcode('paramcode', 'my_param_shortcode');

このショートコードは、以下のように使用します:
[paramcode text="カスタムテキスト"]

このコードは、パラメーターを使用するカスタムショートコードを作成する方法を示しています。
以下に、コードの各部分について解説します。

function my_param_shortcode($atts) { … }

この部分は、パラメーターを受け取るカスタムショートコードの機能を定義する関数です。
関数名はmy_param_shortcodeで、$attsという引数を受け取ります。この引数は、ショートコードに渡された属性(パラメーター)を含む配列です。

$atts = shortcode_atts( array( ‘text’ => ‘デフォルトのテキスト’, ), $atts, ‘paramcode’ );

この行は、shortcode_atts関数を使って、ショートコードのデフォルト属性を設定します。shortcode_atts関数は、デフォルトの属性値、渡された属性、ショートコードの名前を引数として受け取ります。この例では、textという属性にデフォルト値として「デフォルトのテキスト」が設定されています。

return ‘<p>’ . esc_html($atts[‘text’]) . ‘</p>’;

この行は、ショートコードが実行されたときに返されるHTMLを生成します。
esc_html関数を使って、$atts['text']の値をエスケープ処理し、安全なHTMLとして出力します。

add_shortcode(‘paramcode’, ‘my_param_shortcode’);

この部分は、WordPressにショートコードを登録する関数です。add_shortcode関数は2つの引数を取ります。最初の引数はショートコードの名前(ここではparamcode)、2つ目の引数は実行される関数の名前(ここではmy_param_shortcode)です。

ショートコードのエスケープ処理

ショートコードのセキュリティを強化するためには、出力するデータをエスケープ処理することが重要です。

function my_secure_shortcode($atts) {
    $content = '安全なコンテンツ';
    return esc_html($content);
}
add_shortcode('securecode', 'my_secure_shortcode');

このコードは、出力をエスケープ処理するカスタムショートコードを作成する方法を示しています。
以下に、コードの各部分について解説します。

function my_secure_shortcode($atts) { … }

この部分は、エスケープ処理を行うカスタムショートコードの機能を定義する関数です。関数名はmy_secure_shortcodeで、ショートコードが実行されたときに返される内容を決定します。

$content = ‘安全なコンテンツ’;

この行は、ショートコードが返す内容を変数$contentに設定しています。
この例では、「安全なコンテンツ」というテキストを返します。

return esc_html($content);

この行は、esc_html関数を使って、$contentの値をエスケープ処理し、安全なHTMLとして出力します。これにより、ユーザーが意図しないスクリプトやHTMLが実行されるのを防ぎます。

add_shortcode(‘securecode’, ‘my_secure_shortcode’);

この部分は、WordPressにショートコードを登録する関数です。add_shortcode関数は2つの引数を取ります。最初の引数はショートコードの名前(ここではsecurecode)、2つ目の引数は実行される関数の名前(ここではmy_secure_shortcode)です。

おすすめのショートコードプラグイン

おすすめのショートコードプラグイン

ショートコードを簡単に活用するためのプラグインをいくつか紹介します。
これらのプラグインを使用することで、より簡単にショートコードを作成し、管理することができます。

Shortcodes Ultimateの使い方

Shortcodes Ultimateは、多くのショートコードを提供する人気のプラグインです。このプラグインをインストールすることで、ボタン、ギャラリー、タブなど、多様な機能を簡単に追加できます。

視覚的な要素を豊富に取り入れたいときや、コーディングなしで多機能な要素を追加したい場面で非常に便利です。

Contact Form 7とショートコード

Contact Form 7は、簡単にフォームを作成できるプラグインで、ショートコードを使ってフォームを任意の場所に表示できます。
お問い合わせフォームや申し込みフォームなど、ユーザーからの情報収集を行いたい場合に使用されます。

シンプルなインターフェースと高いカスタマイズ性が特徴です。

TablePressとショートコード

TablePressは、簡単にテーブルを作成できるプラグインで、ショートコードを使ってテーブルを表示します。

製品比較表やデータリスト、料金表など、視覚的に整ったテーブルを簡単に作成・管理したい場面で役立ちます。エクセルのような操作感で、データの入力・編集が行えます。

まとめ

小ネタ君
本記事では、WordPressでのショートコードの基本から応用までを解説しました。ショートコードを活用することで、より柔軟かつ効率的にサイトをカスタマイズできます。
ぜひ、PHPでのショートコード作成や便利なプラグインを活用して、WordPressの可能性を広げてください。

この記事を書いた人

日本でもっとも利用されているWordPressのサーバー移転&保守管理サービス『サイト引越し屋さん』のマーケティング事業部です。
本サイトの企画や制作、監修はサイト引越し屋さんが行っております。
>>サイト引越し屋さんサービスサイトはこちらです。

本サイトにてご提供している情報については、最新かつ正確な情報を提供するよう努力していますが、情報の正確性や完全性を保証するものではございません。また、コンテンツには一部プロモーションが含まれております。本サイトの情報を利用することによって生じたいかなる損害に対しても、当社は責任を負いかねます。情報をご利用される際は、ご自身の判断と責任において行っていただきますようお願い致します。

WordPressを運用されている方、必見!
  ↓ ↓ ↓
目次