ワードプレスのget_all_post_type_supports関数の使用方法・解説

概要

get_all_post_type_supports 関数は、指定した投稿タイプがサポートする機能（サポート項目）を取得するための関数です。これにより、特定の投稿タイプに対して有効な機能やオプションを確認できます。この関数は、カスタム投稿タイプやプラグインの開発時によく使用されます。

よく使われるシナリオ

1. カスタム投稿タイプの機能を確認する際。
2. 投稿タイプのサポート機能を動的に変更する場合。
3. 投稿編集画面のカスタマイズ時に、特定のサポートを確認するため。
4. プラグイン内での条件分岐処理に使用。
5. テーマ開発における投稿タイプの機能確認。
6. コンテンツの表示方法を変更する際のチェック機能として。
7. プラグインの互換性テスト時に使用。
8. 管理画面でのカスタムメタボックスの表示制御。

構文

get_all_post_type_supports( string $post_type = 'post' )

パラメータ

• $post_type (string) : 投稿タイプのスラッグ。指定しない場合は 'post' がデフォルト。

戻り値

• (array) : 指定した投稿タイプがサポートする機能のリスト。

関連する関数

• get_post_type_support
• register_post_type

使用可能なバージョン

get_all_post_type_supports 関数は、WordPress 3.0 以降で使用可能です。

コアファイルのパス

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. 投稿タイプの機能リストを取得する

   $supports = get_all_post_type_supports('page');
   print_r($supports);
   

   このコードは、’page’ 投稿タイプがサポートする機能のリストを取得し、表示します。

2. カスタム投稿タイプのサポートを確認する

   if (in_array('thumbnail', get_all_post_type_supports('custom_post'))) {
      echo 'カスタム投稿はサムネイルをサポートしています。';
   }
   

   このコードは、カスタム投稿タイプがサムネイル機能をサポートしているかどうかを確認します。

3. 投稿タイプのサポート項目をループで表示

   $supports = get_all_post_type_supports('post');
   foreach ($supports as $support) {
      echo $support . '<br>';
   }
   

   このコードは、’post’ 投稿タイプがサポートする機能をループで表示します。

4. 特定のサポートがあるかチェック

   if (array_key_exists('editor', get_all_post_type_supports('custom_post'))) {
      // 投稿タイプが 'editor' サポートを持つ場合の処理
   }
   

   このコードでは、特定の投稿タイプが ‘editor’ 機能をサポートしているかを確認します。

5. サポート項目のカスタム表示

   $supports = get_all_post_type_supports('post');
   echo '<ul>';
   foreach ($supports as $key => $value) {
      echo '<li>' . esc_html($key) . '</li>';
   }
   echo '</ul>';
   

   このコードは、取得したサポート項目をリスト形式で表示します。