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



お勧め

サイトヘルス機能を使ってみた(2019年4月12日 更新)

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

管理者ページに文言を表示する(2012年4月19日 更新)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

Widgets on dashboard:プラグイン作ってみました(2014年5月7日 更新)

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

5.7の機能拡張:投稿一覧画面向けのフィルター(2021年2月18日 更新)

昨日、予定通り公開された「WordPress 5.7 Beta 3(以降Beta 3)」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。