概要
get_post_format_string 関数は、投稿フォーマットに関連する文字列を取得するために使用されます。この関数は特にカスタムテーマを作成する際に、投稿フォーマットに合わせた出力を行いたい場合に役立ちます。主要な機能として以下のような用途があります：
- 投稿フォーマットに応じた表示スタイルの選択
- 投稿フォーマットに基づくカスタムメッセージの生成
- 投稿タイプに応じて異なるテンプレートを选择する
- 投稿フォーマット一覧の作成
- 管理画面での投稿フォーマットの表示
- ショートコードによるフォーマットに応じたコンテンツの出力
- AJAXリクエスト時の投稿フォーマットの取得
- ユーザーインターフェースでのフォーマット選択肢の動的表示
構文
get_post_format_string( $format );
パラメータ
$format(string) : 投稿フォーマットのスラッグ（例： ‘standard’, ‘aside’, ‘gallery’ など）
戻り値
- (string) : 投稿フォーマットに関連付けられた文字列を返します。該当するフォーマットが存在しない場合は、デフォルトの文字列を返します。
関連する関数
使用可能なバージョン
get_post_format_string は WordPress 2.8 以降で利用可能です。
コアファイルのパス
wp-includes/post.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプル1 – 投稿フォーマットを取得して表示する
このサンプルコードは、現在の投稿の投稿フォーマットに応じたメッセージを表示します。
$format = get_post_format();
if ($format) {
echo get_post_format_string($format);
} else {
echo '標準フォーマットです';
}
サンプル2 – フォーマットに応じて異なるスタイルを適用
このコードは、投稿フォーマットに基づいて異なるCSSクラスを追加します。
$format = get_post_format();
$class = $format ? $format : 'standard';
echo '<div class="' . esc_attr($class) . '">投稿内容</div>';
サンプル3 – 投稿フォーマット一覧を作成
この中で全ての投稿フォーマット名を列挙して表示します。
$formats = get_post_format_strings();
foreach ($formats as $key => $value) {
echo '<p>' . esc_html($value) . '</p>';
}
サンプル4 – 特定のフォーマット用にカスタムメッセージを用意
特定の投稿フォーマット専用のメッセージを表示します。
$format = get_post_format();
$message = get_post_format_string($format);
if ($format === 'video') {
echo 'この投稿には動画が含まれています。';
} else {
echo $message;
}
サンプル5 – フォーマットに応じた条件分岐
このサンプルでは、フォーマットに応じて出力内容を変更します。
$format = get_post_format();
if ($format === 'gallery') {
echo 'ギャラリーフォーマットの投稿です！';
} else {
echo get_post_format_string($format);
}
すべてのサンプルコードは著作権フリーのものであり、説明も分かりやすくしています。