概要
get_post_types関数は、WordPressで登録された投稿タイプ情報を列挙するために使用される関数です。この関数は、カスタム投稿タイプや標準の投稿タイプ（例：投稿、ページなど）を取得し、テーマやプラグイン内での使用が一般的です。特に、投稿タイプのリストを必要とする機能や、特定の投稿タイプに関連する処理を行う際によく使われます。
よく使われる機能の例
- カスタム投稿タイプの表示
- 投稿タイプのフィルタリング
- 投稿リストの作成
- ユーザーインターフェースのカスタマイズ
- 管理画面の設定
- 投稿タイプの関連情報の取得
- REST APIでの利用
- テーマやプラグインの設定画面の作成
構文
get_post_types( $args, $output, $operator );
パラメータ
$args(配列|string) : 出力する投稿タイプを指定する条件。デフォルトは空で、全ての投稿タイプが対象。$output(string) : 出力形式を指定。デフォルトは ‘names’（投稿タイプ名を返す）。他に ‘objects’を指定すると投稿タイプオブジェクトが返る。$operator(string) : 投稿タイプの出力条件を指定。’and’または ‘or’を選択可能。
戻り値
この関数は、指定された条件に基づいて投稿タイプの名前またはオブジェクトを返します。デフォルトでは、登録されたすべての投稿タイプの名前が配列として返されます。
関連する関数
使用可能なバージョン
この関数は、WordPress 2.9.0以降のバージョンで使用可能です。
コアファイルのパス
get_post_types関数は、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 |
非推奨または削除されたバージョン
get_post_types関数は、非推奨または削除されたバージョンはありません。