get_block_categories

説明

array get_block_categories( WP_Post | WP_Block_Editor_Context $post_or_block_editor_context )
ブロックタイプの全カテゴリーを取得する。

パラメータ

  • $post_or_block_editor_context
    投稿情報またはWP_Block_Editor_Contextオブジェクトを指定。

返り値

ブロックタイプのカテゴリー情報(連想配列)を格納した配列を返す。

注意

ブロックタイプのカテゴリー情報は、キー'slug'、'title'、'icon'を持つ連想配列となる。

[5.8.0]もともと管理画面向けの関数だったが、バージョン5.8.0では/wp-includes/block-editor.phpファイルに移動され、どこでも使用できるようになった。その際、パラメータにはWP_Block_Editor_Contextオブジェクトが指摘可能になった。

[5.8.0]'block_categories'フィルターが非推奨になり、代わりとして'block_categories_all'フィルターがある。


使用例

  • ブロックタイプの全カテゴリーを取得する
    $categories = get_block_categories( $post );

フィルター

[5.8.0]カテゴリー情報を格納した配列を返す前に'block_categories_all'フィルターを呼び出す。パラメータ$default_categoriesにはカテゴリー情報を格納した配列を、$block_editor_contextにはWP_Block_Editor_Contextオブジェクトが格納されている。
$block_categories = apply_filters( 'block_categories_all', $block_categories, $block_editor_context );
[5.0.0]カテゴリー情報を格納した配列を返す前に'block_categories'フィルターを呼び出す。パラメータ$block_categoriesにはカテゴリー情報を格納した配列を、$postには投稿情報が格納されている。
$block_categories = apply_filters( 'block_categories', $block_categories, $post );

アクション

直接実行するアクションはありません。

ソースファイル

[5.0.0]/wp-admin/include/post.php [5.8.0]/wp-includes/block-editor.php

最終更新 : 2021年08月17日 15:02



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。