WordPress functions.php

ショートコードは、記事の中に [名前] と書くと、決めた内容に置きかわるしくみです。

functions.php に「中身を返す関数」を作り、add_shortcode() で名前を付けて登録します。

/*----------------------------------------------------
 ショートコード：[my_hello name="山田"] 基本の形
----------------------------------------------------*/
function my_shortcode_hello( $atts ) {
	$atts = shortcode_atts( array( 'name' => 'ゲスト' ), $atts, 'my_hello' );
	return 'こんにちは、' . esc_html( $atts['name'] ) . 'さん';
}
add_shortcode( 'my_hello', 'my_shortcode_hello' );

[my_hello]
→ こんにちは、ゲストさん

[my_hello name="山田"]
→ こんにちは、山田さん

/*----------------------------------------------------
 ショートコード：[my_ad] 記事の中に広告を出す
----------------------------------------------------*/
function my_shortcode_ad() {
	static $script_done = false;

	$client = 'ca-pub-0000000000000000'; // 自分のサイト運営者 ID
	$slot   = '0000000000';              // 広告ユニットの ID

	$html = '';
	if ( ! $script_done ) {
		// 広告を読み込む script は、ページに 1 回だけ出す
		$html       .= '<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=' . esc_attr( $client ) . '" crossorigin="anonymous"></script>';
		$script_done = true;
	}
	$html .= '<ins class="adsbygoogle" style="display:block; text-align:center;" data-ad-layout="in-article" data-ad-format="fluid"'
		. ' data-ad-client="' . esc_attr( $client ) . '" data-ad-slot="' . esc_attr( $slot ) . '"></ins>'
		. '<script>(adsbygoogle = window.adsbygoogle || []).push({});</script>';

	return $html; // echo ではなく return で返す
}
add_shortcode( 'my_ad', 'my_shortcode_ad' );

[my_ad]

記事の中の、広告を出したいところに書きます。

前はこの記事で、広告のコードを echo で出していました。この書き方だと、[ad] を本文の途中に書いても、広告は本文のいちばん上に出ます。ショートコードの関数は、出したい文字を return で返します。

2 つのショートコードで使う「公開中の記事だけを取り出す」関数を先に作り、それを使って URL を返します。

/*----------------------------------------------------
 公開中の記事だけを取り出す（[my_link]・[my_linka] で使う）
----------------------------------------------------*/
function my_shortcode_public_post( $id ) {
	$id = absint( $id );
	if ( ! $id ) {
		return null; // get_post( 0 ) は今の記事を返すので、0 は「なし」にする
	}
	$post = get_post( $id );
	if ( ! $post || 'publish' !== get_post_status( $post ) || post_password_required( $post ) ) {
		return null; // 下書き・非公開・パスワード付きは出さない
	}
	return $post;
}

/*----------------------------------------------------
 ショートコード：[my_link id="123"] 記事の URL を出す
----------------------------------------------------*/
function my_shortcode_link( $atts ) {
	$atts = shortcode_atts( array( 'id' => 0 ), $atts, 'my_link' );
	$post = my_shortcode_public_post( $atts['id'] );
	if ( ! $post ) {
		return '';
	}
	return esc_url( get_permalink( $post ) );
}
add_shortcode( 'my_link', 'my_shortcode_link' );

[my_link id="92"]

→ https://functions.fs-create.net/archives/92

/*----------------------------------------------------
 ショートコード：[my_linka id="123" text="文字"] 記事へのリンク（a タグ）を出す
----------------------------------------------------*/
function my_shortcode_linka( $atts ) {
	$atts = shortcode_atts( array( 'id' => 0, 'text' => '' ), $atts, 'my_linka' );
	$post = my_shortcode_public_post( $atts['id'] );
	if ( ! $post ) {
		return '';
	}
	$text = '' !== $atts['text'] ? $atts['text'] : get_the_title( $post );
	return '<a href="' . esc_url( get_permalink( $post ) ) . '">' . esc_html( wp_strip_all_tags( $text ) ) . '</a>';
}
add_shortcode( 'my_linka', 'my_shortcode_linka' );

[my_linka id="92"]
→ <a href="https://functions.fs-create.net/archives/92">記事の題</a>

[my_linka id="92" text="こちら"]
→ <a href="https://functions.fs-create.net/archives/92">こちら</a>

前の書き方との違い

確かめた結果

このサイトの作業環境（WordPress 7.1.3・PHP 8.3）で、試しの記事（公開・下書き・非公開）を作り、ログインしていない訪問者として表示して試しました。試しの記事は、終わったあとに消しました。

<?php echo do_shortcode( '[my_ad]' ); ?>
<?php echo do_shortcode( '[my_linka id="92"]' ); ?>

<?php // 自分で作った関数なら、直接呼ぶほうが速い ?>
<?php echo my_shortcode_linka( array( 'id' => 92 ) ); ?>

do_shortcode() に文字を渡すと、ショートコードを置きかえた結果が返ります。

自分で作ったショートコードなら、関数を直接呼んでも同じ結果になり、文字を調べる手間がないぶん速くなります。

• add_shortcode()
• shortcode_atts()
• do_shortcode()
• Shortcodes（プラグインの手引き）