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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

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

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

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。