wordpressの投稿画面におけるechoとreturnの違い

Question

PHPでショートコードを作成し、投稿画面に入れて出力した際に関する質問です。

ここでは仮に[shortcode1][shortcode2][shortcode3]という3つのショートコードがあったとして、これらのショートコードの中身を全て出力をechoで行った際に、投稿画面に

<h4>ショートコードだよ!</h4> [shortcode1] [shortcode2] [shortcode3]

といれると、実際の表示では

[shortcode1]
[shortcode2]
[shortcode3]

<h4>ショートコードだよ!</h4>

とショートコードの内容が上にきてしまいます。しかし、ショートコードの中身を全て変数に入れて
returnで出力すると、

<h4>ショートコードだよ!</h4> [shortcode1] [shortcode2] [shortcode3]

としっかり投稿画面に入れた順番で表示されます。

これってなぜこうなるのか仕組みがわかる方いらっしゃいましたらご教授ください。
(wordpressってそういう仕様なんだよとかでも構いません(笑))

Comments

[kei344]

質問文のコードはそれぞれコードブロックで囲んでいただけませんか？ ```（バッククオート3つ）で囲み、前後に改行をいれるか、コードを選択して「<code>」ボタンを押すとコードブロックになります。

Answer 1

英語版stackoverflowのほうに似たような質問がありました。

Wordpress using echo vs return in shortcode function

の中の回答にあります下記が本件の回答になると思います。

one does output immediately, the other returns the text to the calling function, leaving it up to that calling function to handle the output. they're NOT the same and NOT functionally equivalent.

一方はすぐに出力され、もう一方は出力を処理するためにその呼び出し関数に任せて、呼び出し関数にテキストを返します。 彼らは同じではなく、機能的に同等ではありません。

要約すると

• echoはそのコードを通った際に出力

＞＞一方はすぐに出力され

• returnは結果を返却（出力は実行先の仕事）

＞＞出力を処理するためにその呼び出し関数に任せて、呼び出し関数にテキストを返します

Wordpressの仕様ではなくPHPの言語仕様ですね。
追記：
PHPはサーバーサイドの言語としてHTML（クライアントサイド）出力より前に実行されるため
特にWordpressのようにfunctionからショートコードを生成している場合、echoすると書いたHTMLより上部に出力されることとなります。