独自のショートコードを定義する方法 [WordPress]

ショートコード API

参考：

Shortcode API | WordPress Codex [Official]

1 使い方
2 属性 (shortcode_atts)
3 囲み型ショートコード ($content)
4 属性値をエスケープする
5 記号をそのまま表示する
6 改行する
7 HTML をエスケープする
8 値を持たない属性値を使いたい
9 wpautop により不要な改行が入ってしまう
10 実装／関数／グローバル変数
11 Shortcoder
12 Snippy

使い方

add_shortcode：ショートコードを処理するフックを追加する
shortcode_exists：ショートコードを処理するフックが登録されているか確認する
remove_shortcode：ショートコードを処理するフックを削除する
remove_all_shortcodes：ショートコードを処理するフックを全て削除する

参考：

ショートコードの作成 | Web Design Leaves

WordPress のショートコードを自作してみる | webOpixel

WordPress ショートコードとは何か、自作する際に注意すべき３つの事 | いつも隣に IT のお仕事

便利なショートコードの基本的な書き方と使い方 | KERENOR ケレンオール

WordPress で複数のショートコードを作成し、投稿記事に呼び出す使い方 | ホワイトベアー株式会社

ショートコードを自作する方法。PHP デビューにも最適です | ぺらラボ

ショートコード API | WordPress Codex 日本語版

add_shortcode | WordPress 私的マニュアル

shortcode_exists | WordPress 私的マニュアル

remove_shortcode | WordPress 私的マニュアル

remove_all_shortcodes | WordPress 私的マニュアル

add_shortcode | WordPress Codex 日本語版

shortcode_exists | WordPress Codex 日本語版

remove_shortcode | WordPress Codex 日本語版

remove_all_shortcodes | WordPress Codex 日本語版

add_shortcode() | WordPress Developer Resources [Official]

属性 (shortcode_atts)

サポートする属性とそのデフォルト値を与えて、属性を処理する。サポートしない属性は無視される。

$atts = shortcode_atts( array(
    'id' => null,
    'name' => 'John',
), $atts, 'shortcode_name')
Code language: PHP (php)

参考：

便利なショートコードの基本的な書き方と使い方 | KERENOR

shortcode_atts と extract | 団地デバッグ

WordPress で引数ありのショートコードを作成する方法をとっても丁寧に説明します | いつも隣にITのお仕事

shortcode_atts | WordPress 私的マニュアル

shortcode_atts | WordPress Codex 日本語版

shortcode_atts() | WordPress Developer Resources [Official]

How to add attributes to a shortcode – WordPress Development Stack Exchange

Shortcode attributes don’t appear? – WordPress Development Stack Exchange

Shortcode empty attribute – WordPress Development Stack Exchange

囲み型ショートコード ($content)

参考：

WordPress の囲み型ショートコードの基本的な使い方 | bl6.jp

囲み型ショートコードと自己完結型ショートコード | WordPress Codex 日本語版

属性値をエスケープする

特殊文字を属性値で使用する場合は、数値参照文字を用いる。

文字	数値文字参照
[	[
]	]
“	"
‘	'

参考：

角括弧とクォートをエスケープして表示／ショートコードと属性値 | MaryCore

記号をそのまま表示する

function escape_short_code( $atts, $content = null ){
    $content = clean_pre($content);
    $content = trim($content);
    $content = str_replace("\t", "    ", $content);
    $content = str_replace("<", "&lt;", $content);
    $content = str_replace(">", "&gt;", $content);
    return "<code>" . $content . "</code>";
}
add_shortcode( 'code', 'escape_short_code' );
Code language: PHP (php)