概要
get_post_format_strings 関数は、投稿フォーマット名の一覧を取得するために使用される関数です。WordPressでは、投稿フォーマットを使用することで、異なる形式のコンテンツを特徴づけたり、表示方法を変更したりすることができます。以下はこの関数がよく使われる機能の例です。
- テーマのカスタマイズ: 投稿フォーマットに応じたデザインを実装する際に使用。
- カスタムクエリ: 投稿フォーマットに基づいてコンテンツを取得するため。
- プラグイン作成: 投稿フォーマットを特集する新しい機能の追加。
- 投稿一覧の表示: 投稿フォーマット別に一覧を整理する。
- ウィジェットの強化: ウィジェット内で異なる投稿フォーマットを区別。
- レイアウトの調整: 表示するコンテンツの形式を変更する際の調整。
- SEO対策: 特定の投稿フォーマットを強調することで検索エンジンにアピール。
- 管理画面のカスタマイズ: 投稿フォーマットに基づいた表示を管理画面で行う。
構文
get_post_format_strings();
パラメータ
この関数にはパラメータはありません。
戻り値
この関数は、サポートされている投稿フォーマット名の一覧を含む配列を返します。
関連する関数
バージョン情報
この関数は、WordPress 3.1.0 から利用可能です。
コアファイルのパス
wp-includes/post.php
サンプルコード
サンプルコード1: 投稿フォーマット名の取得
$formats = get_post_format_strings();
print_r($formats);
このサンプルコードは、投稿フォーマット名の一覧を取得し、その内容を画面に表示します。
サンプルコード2: 特定の投稿フォーマットを表示
if (in_array('aside', get_post_format_strings())) {
echo "この投稿はアサイド形式です！";
}
このサンプルコードは、アサイド形式の投稿が存在するかをチェックし、存在する場合はメッセージを表示します。
サンプルコード3: フォーマット別にスタイルを適用
$formats = get_post_format_strings();
foreach ($formats as $format) {
if (has_post_format($format)) {
echo "<div class='{$format}'>この投稿は{$format}形式です。</div>";
}
}
このサンプルコードは、各投稿フォーマットに対して異なるスタイルの<div>を生成します。
サンプルコード4: 投稿フォーマットのフィルター
add_filter('post_format', 'custom_post_format');
function custom_post_format($format) {
$formats = get_post_format_strings();
return in_array($format, $formats) ? $format : 'standard';
}
このサンプルコードは、投稿フォーマットがリストに含まれている場合はそのフォーマットを返し、そうでない場合は ‘standard’ を返します。
サンプルコード5: 投稿フォーマットをナビゲーションに表示
$formats = get_post_format_strings();
echo '<ul>';
foreach ($formats as $format) {
echo "<li><a href='" . get_post_format_link($format) . "'>{$format}</a></li>";
}
echo '</ul>';
このサンプルコードは、登録された投稿フォーマットをリストとして表示し、それぞれのフォーマットへのリンクを生成します。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
非推奨または削除されたバージョン
get_post_format_strings 関数は、特定のバージョンで非推奨または削除された記録はありません。