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



お勧め

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

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

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

ツイート引用が簡単になる仕組み(2012年6月8日 更新)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。