【WordPress】ショートコード作成とプラグイン化の方法を簡単解説

単純に”本日を「年月日」の形式で表示するだけ”、
といった【引数なしのショートコード】を考えてみる。

【想定するショートコード】

[show_today]

• １）ショートコード名：show_today とした
• ２）引数：なし
• ３）ショートコードの結果：「xx年xx月xx日」の形式で本日を表示する

このショートコードを実現するには、例えば以下のようなコードになりますね。

【ショートコードのコード例】

function jin_shortcode_show_today() {
  	// WordPressのタイムゾーンに合わせた日付取得（wp_date）に変更
  	return wp_date( 'Y年m月d日' );
}

// 安全なタイミング（init）でショートコードを登録する
function jin_register_shortcode_today() {
  	add_shortcode( 'show_today', 'jin_shortcode_show_today' );
}
add_action( 'init', 'jin_register_shortcode_today' );

• 1行目：関数名を「jin_shortcode_show_today」とした（引数無し）
• 3行目：xxxx年xx月xx日の形式で本日を返す（表示させる）
• 8行目：ショートコード名（show_today）と、
  それに対して実行する関数名（jin_shortcode_show_today）を書く

（メモ）命名規則（関数名や変数名など）

• 変数、アクション、関数の名前にはアルファベット小文字を使う。
• camelCase は使わない
  （複数の単語で命名する場合、単語の区切りを明確にするために単語の先頭を大文字する、という形は使わない）
• 単語を区切る場合にはアンダースコア（ _ ）を使う
• 不必要に変数名を省略しない（分かりやすくするため）

参照）
・ワードプレス：PHPコーディング規約（ワードプレス公式）
（⇒「命名規則」より）

関連）
・日付と時刻の書式（ワードプレス公式）

引数が1つと言えば、芸能人をよく扱うトレンド記事や、
そうでなくても人物のプロフィールを書く場合に良くある「生年月日からの年齢表示」がありますね。

1つの引数（生年月日）を与えることで、
現在の年齢を計算して表示するショートコードを考えてみる。

（これを入れておくと、年が変わった時の記事更新がいらなくて楽！笑）

【想定するショートコード】

[cal_age ymd="20010102"]

• １）ショートコード名：cal_age　とする
• ２）引数：ymd（の１つ）のみとする
• ３）ymd：生年月日の形式を、年（4ケタの西暦）+月（2桁）+日（2桁）とする
• ４）ショートコードの結果：「xx歳」と「歳」を付けて返す

これを実際のショートコードとして書いてみると
たとえば以下のようになりますね。

【ショートコードのコード例】

function jin_shortcode_cal_age( $args ) {
  	$a = shortcode_atts(
  		array(
  			'ymd' => 'none',
  		),
  		$args
  	);

  	// 未定義エラー（Warning）を防ぐためissetで存在チェック
  	$birtydate = isset( $a['ymd'] ) ? $a['ymd'] : 'none';

  	if ( 'none' === $birtydate ) {
  		$age = '不明';
  	} else {
  		// 安全で現代的なDateTimeクラスによる年齢計算に刷新
  		try {
  			$b_date = new DateTime( $birtydate );
  			$t_date = new DateTime( wp_date( 'Y-m-d' ) );
  			$interval = $b_date->diff( $t_date );
  			$age = $interval->y . '歳';
  		} catch ( Exception $e ) {
  			$age = '不明';
  		}
  	}

  	return $age;
  }

  // 安全なタイミング（init）で登録
  function jin_register_shortcode_age() {
  	add_shortcode( 'cal_age', 'jin_shortcode_cal_age' );
  }
  add_action( 'init', 'jin_register_shortcode_age' );

• 1行目：
  ショートコードで実行される関数名を「jin_shortcode_cal_age」とし、引数を連想配列「$args」で受け取ります。
• 2～5行目：
  shortcode_atts() を使って引数をチェックし、結果を配列「$a」に入れます。
• 10行目：
  現在のPHP環境でエラー（Warning）が出ないよう、isset() を使って引数 ymd の値が安全に存在するかチェックしながら取り出します。
• 12行目：
  誕生日が指定されていない（初期値のままの）場合には「不明」とします。
• 14行目～22行目：
  【重要】安全で現代的なDateTimeクラスを使い、現在の年月日（wp_dateで取得）と誕生日の日付を比較して、正確な年齢を計算します。
• 26行目：
  計算された年齢（xx歳）を画面に返します。
• 29行目～32行目：
  【重要】WordPressの初期化（init）のタイミングに合わせて、ショートコード名（cal_age）と実行する関数を安全に登録します。

引数が必要なショートコードでは、上の2行目～4行目のように shortcode_atts() を使い、存在しない引数が指定されたり、そもそも引数が無かったりする場合を考慮する必要がある、っていうのがポイントになりますね。

参照）
関数リファレンス/shortcode atts

関連）
・日付と時刻の書式（ワードプレス公式）
・DateTimeクラス（php公式）

引数が2つ以上でも上の例同様 shortcode_atts() を使って、引数のチェックはしっかり行います。

複数の引数を使う場合というと、
例えば、商標系の記事（物販アフィリエイト系の記事）でよくありそうな、

・商品の初回購入価格がxxx円
・2回目以降の価格がyyy円
・最低購入回数といった縛りが3回

みたいな場合、
最低購入回数購入時の合計金額から、
1回あたりの金額（その商品の１つあたりの平均価格）を出す、

といった計算がありますね。

【想定するショートコード】

[heikin_tanka shokai="980" nikaime="1980" shibari="3"]

• １）ショートコード名：heikin_tanka とする
• ２）引数：３つ
  ・shokai（初回のお値段）、
  ・nikaime（2回目以降のお値段）、
  ・shibari（最低購入回数といった縛りの回数）
• ３）shokai, nikaime, shibari：単純に数値で入れる
• ４）ショートコードの結果：
  千円以上の場合には「x,xxx円」と3桁区切りの「,」を付け、
  最後に「円」を付けて返す

さて引数が3つになりましたが、引数が1つの場合とやり方は同じで、
実際のコードはたとえば以下のような感じ。

【ショートコードのコード例】

function jin_shortcode_heikin_tanka( $args ) {
  	$a = shortcode_atts(
  		array(
  			'shokai'  => '0',
  			'nikaime' => '0',
  			'shibari' => '1',
  		),
  		$args
  	);

  	// 各属性を安全に取得（未定義エラー対策）
  	$price1  = isset( $a['shokai'] ) ? $a['shokai'] : '0';
  	$price2  = isset( $a['nikaime'] ) ? $a['nikaime'] : '0';
  	$shibari = isset( $a['shibari'] ) ? $a['shibari'] : '1';

  	if ( $shibari < 1 ) {
  		$heikin = 'shibari は1以上にしてね';
  	} else {
  		$heikin = round( ( $price1 + $price2 * ( $shibari - 1 ) ) / $shibari );
  		$heikin = number_format( $heikin ) . '円';
  	}

  	return $heikin;
  }

  // 安全なタイミング（init）で登録
  function jin_register_shortcode_tanka() {
  	add_shortcode( 'heikin_tanka', 'jin_shortcode_heikin_tanka' );
  }
  add_action( 'init', 'jin_register_shortcode_tanka' );

• 1行目：
  ショートコードで実行される関数名を「jin_shortcode_heikin_tanka」とし、3つの引数を連想配列「$args」で受け取ります。
• 2行目～9行目：
  shortcode_atts() を使って引数をチェックし、結果を配列「$a」に入れます。
• 12行目～14行目：
  【重要】現在のPHP環境でエラー（Warning）が出ないよう、isset() を使って、指定された3つの属性（引数）の値が安全に存在するかチェックしながら取り出します。
• 16,17行目：
  19行目の割り算で「0で割るエラー」が起きないよう、購入回数（shibari）が1未満の場合のエラーチェックを入れておきます。
• 19行目：
  最低購入回数分を購入したときの平均単価を計算します。（round関数を使って四捨五入）
• 20行目：
  number_format関数を使って数値を3桁区切り（ , ）にし、最後に「円」を付けて画面に返します。
• 26行目～29行目：
  【重要】WordPressの初期化（init）のタイミングに合わせて、ショートコード名（heikin_tanka）と実行する関数を安全に登録します。

参照）
関数リファレンス/shortcode atts

関連）
・round関数（php公式）
・number_format関数（php公式）

このショートコードの実際の動作を試してみると、以下のようになりますね。

※）ショートコードをコピペで記事中に貼り付けると、
自動的にショートコードブロックに貼り付けられます。
（テスト環境はワードプレス5.8.2：テーマはCocoon)）

動作を試した年月日が「2021年11月15日」なので、そのように表示されました。

初回の購入金額を300円、
2回目以降の価格を3,000円、
最低購入回数を3回としたので、
1回あたりの価格の計算は以下になります。

3回合計金額 ＝ 300円（初回）＋3,000円×2（2回目、3回目）
＝ 6,300円。

この3回合計金額を3で割るので、2,100円。

正しく動作できてますね。