add_shortcode() の説明と使用例

WordPressの関数add_shortcode()は、カスタムショートコードを登録するために使用されます。この関数を利用すると、ユーザーはショートコードを作成し、カスタムHTMLや機能を簡単に実装することができます。

構文

add_shortcode( string $tag, callable $callback );

引数の説明:

$tag (string) — ショートコードの名前。
$callback (callable) — ショートコードが呼び出されたときに実行される関数。

例1: シンプルなショートコード

以下の例では、「Hello, World!」を表示するショートコードを作成します。

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

例2: パラメータ付きショートコード

次のコードでは、パラメータを受け取るショートコードを作成します。

add_shortcode( 'greet', function( $atts ) {
    $atts = shortcode_atts( [ 'name' => 'Guest' ], $atts );
    return 'Hello, ' . esc_html( $atts['name'] ) . '!';
} );

例3: 投稿内容を表示するショートコード

現在の投稿のコンテンツを表示するショートコードを作成します。

add_shortcode( 'post_content', function() {
    return get_the_content();
} );

例4: 条件付きショートコード

条件に基づいて出力を変更するショートコードを作成します。

add_shortcode( 'conditional_content', function() {
    if ( is_user_logged_in() ) {
        return 'ログイン中のユーザーにはこの内容が表示されます。';
    }
    return 'この内容は未ログインユーザー用です。';
} );

例5: ショートコードで動的リストを生成

カテゴリのリストを表示するショートコードを作成します。

add_shortcode( 'category_list', function() {
    $categories = get_categories();
    $output = '<ul>';
    foreach ( $categories as $category ) {
        $output .= '<li>' . esc_html( $category->name ) . '</li>';
    }
    $output .= '</ul>';
    return $output;
} );

注意事項

ショートコード名は一意でなければなりません。同じ名前のショートコードが複数登録されている場合、後に登録されたものが優先されます。
$callbackには適切なセキュリティ対策を実装してください。特に外部入力を処理する場合は、データを適切に検証およびサニタイズしてください。

構文