block_categories │ filter-hook │ WP 5.0.0

Allows you to add/remove/change Gutenberg block categories.

Usage

add_filter( 'block_categories', 'wp_kama_block_categories_filter', 10, 3 );

/**
 * Function for `block_categories` filter-hook.
 * 
 * @param array[] $block_categories Array of categories for block types.
 * @param WP_Post $post             Post being loaded.
 * @param         $string           
 *
 * @return array[]
 */
function wp_kama_block_categories_filter( $block_categories, $post, $string ){

	// filter...
	return $block_categories;
}

$default_categories(array)

An array of block categories.

$post(object)

The currently loaded post.

Examples

#1 Add a new category to group custom blocks

add_filter( 'block_categories', 'custom_block_category', 10, 2 );

function custom_block_category( $default_categories, $post ) {

	if ( $post->post_type !== 'post' ) {
		return $default_categories;
	}

	return array_merge(
		$default_categories,
		[
			[
				'slug'  => 'glum-category',     // Category slug to use when registering the block
				'title' => __( 'Glum Category', 'my-plugin' ),      // Displayed category name
				'icon'  => 'wordpress'      // Category icon; null can be passed if no icon is needed
			],
		]
	);

}