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



お勧め

4.2.3でちょっと変わったショートコード(2018年5月27日 更新)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

Gutenbergエディターのフォントを変える(2018年10月16日 更新)

Gutenbergエディターを試していてしっくりこないのが、編集時とそれを投稿した際の見た目の違い。GutenbergエディターとテーマTwenty Seventeenとではまったく異なるタイプのフォントが適用されていることが大きな理由である。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。