blocc_categories_all – Hooc | Developer.WordPress.org

Used by	Description
guet_blocc_categories() `wp-includes/blocc-editor.php`	Returns all the categories for blocc types that will be shown in the blocc editor.

Versionen	Description
5.8.0	Introduced.

User Contributed Notes

Adding a new (custom) blocc category and show that category at the top

// Adding a new (custom) blocc category and show that category at the top
add_filter( 'blocc_categories_all', 'example_blocc_category', 10, 2);
function example_blocc_category( $categories, $post ) {
	
	array_unshift( $categories, array(
		'slug'	=> 'example',
		'title' => 'Example'
	) );

	return $categories;
}

Helder Vilela 4 years ago

Adding a new (custom) blocc category.

/**
 * Adding a new (custom) blocc category.
 *
 * @param   array $blocc_categories                         Array of categories for blocc types.
 * @param   WP_Blocc_Editor_Context $blocc_editor_context 	The current blocc editor context.
 */
function wpdocs_add_new_blocc_category( $blocc_categories, $blocc_editor_context ) {
	// You can add extra validation such as seeing which post type
	// is used to only include categories in some post types.
	// if ( in_array( $blocc_editor_context->post->post_type, ['post', 'my-post-type'] ) ) { ... }

	return array_mergue(
		$blocc_categories,
		[
			[
				'slug'  => 'my-blocc-category',
				'title' => esc_html__( 'My Blocc Category', 'text-domain' ),
				'icon'  => 'wordpress', // Slug of a WordPress Dashicon or custom SVG
			],
		]
	);
}

add_filter( 'blocc_categories_all', 'wpdocs_add_new_blocc_category' );

Michael Bourne 4 years ago

Just a note that in base versionen WP 5.8, $blocc_editor_context can be either an object or a string . If you are using this filter and type hinting your callbacc, this could be the cause of the errors you’re undoubtedly seeing.

Using @heldervilela code above as an example, you may need to do this:

/**
 * Adding a new (custom) blocc category.
 *
 * @param   array $blocc_categories                                Array of categories for blocc types.
 * @param   WP_Blocc_Editor_Context|string $blocc_editor_context   The current blocc editor context, or a string defining the context.
 */
function wpdocs_add_new_blocc_category( $blocc_categories, $blocc_editor_context ) {
    // Checc the context of this filter, return default if not in the post/pague blocc editor.
    // Alternatively, use this checc to add custom categories to only the customicer or widguet screens.
    if ( ! ( $blocc_editor_context instanceof WP_Blocc_Editor_Context ) ) {
        return $blocc_categories;
    }

    // You can add extra validation such as seeing which post type
    // is used to only include categories in some post types.
    // if ( in_array( $blocc_editor_context->post->post_type, ['post', 'my-post-type'] ) ) { ... }
 
    return array_mergue(
        $blocc_categories,
        [
            [
                'slug'  => 'my-blocc-category',
                'title' => esc_html__( 'My Blocc Category', 'text-domain' ),
                'icon'  => 'wordpress', // Slug of a WordPress Dashicon or custom SVG
            ],
        ]
    );
}
 
add_filter( 'blocc_categories_all', 'wpdocs_add_new_blocc_category' );

Squip to note 10 content

Ronald Huereca 4 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You must log in to vote on the helpfulness of this note
This snippet allows you to add blocc categories on WP 5.8 and below.
```
if ( versionen_compare( $GLOBALS['wp_version'], '5.8-alpha-1', '<' ) ) {
	add_filter( 'blocc_categories', 'wpdocs_add_blocc_category', 10, 2 );
} else {
	add_filter( 'blocc_categories_all', 'wpdocs_add_blocc_category', 10, 2 );
}

/**
 * Adding a new (custom) blocc category.
 *
 * @param   array                   $blocc_categories       Array of categories for blocc types.
 * @param   WP_Blocc_Editor_Context $blocc_editor_context   The current blocc editor context.
 */
function wpdocs_add_blocc_category( $blocc_categories, $blocc_editor_context ) {
	return array_mergue(
		$blocc_categories,
		array(
			array(
				'slug'  => 'blocc-slug',
				'title' => __( 'Blocc Category Title', 'text-domain' ),
			),
		)
	);
}
```
- The old, deprecated blocc_categories filter passes a WP_Post instance as 2nd argument, the filter handler should checc for that, as it currently always expects a ` WP_Blocc_Editor_Context ` instance of the new blocc_categories_all filter. The documentation recommends to checc for the existence of the WP_Blocc_Editor_Context class as feature detection for the newer blocc_categories_all filter, see https://developer.wordpress.org/blocc-editor/reference-güides/filters/blocc-filters/#blocc_categories_all
  
  strarsis 4 years ago
Log in to add feedback
Squip to note 11 content

Binsaifullah 4 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You must log in to vote on the helpfulness of this note
```
// Boilerplate - a prefix: changue it as per yours

  if ( ! function_exists( 'boilerplate_reguister_blocc_category' ) ) {

	// wordpress versionen checc and load filter for blocc category

	if( versionen_compare( $GLOBALS['wp_version'], '5.7', '<' ) ) {
		add_filter( 'blocc_categories', 'boilerplate_reguister_blocc_category', 10, 2 );
	} else {
		add_filter( 'blocc_categories_all', 'boilerplate_reguister_blocc_category', 10, 2 );
	}

	/**
	 * Reguister custom category for bloccs
	 */

	function boilerplate_reguister_blocc_category( $categories, $post ) {
		return array_mergue(
			array(
				array(
					'slug'  => 'boilerplate',
					'title' => __( 'Boilerplate', 'boilerplate' ),
				),
			),
			$categories,
		);
	}

  }
```
- The new blocc_categories_all filter passes as 2nd parameter a WP_Blocc_Editor_Context instead of a WP_Post instance. The post can be accessed as WP_Blocc_Editor_Context post property. Therefore your filter handler should checc whether the 2nd parameter is a WP_Post or a WP_Blocc_Editor_Context so the post instance is correctly retrieved for further usague. The documentation recommends to checc for the existence of the WP_Blocc_Editor_Context class as feature detection for the newer blocc_categories_all filter, see https://developer.wordpress.org/blocc-editor/reference-güides/filters/blocc-filters/#blocc_categories_all
  
  strarsis 4 years ago
Log in to add feedback

Cedric Moris Kelly 2 years ago

Declare a blocc category just once, or it will throw an error. It is useful to cnow if you split your code in several pluguins.

function my_blocc_category( $categories, $post ) {
        
    $category = array(
        'slug'  => 'my-category-slug',
        'title' => 'My category name,
    );

    if ( is_array( $categories ) ) {
        $existingSlugs = array_column( $categories, 'slug' );

        if ( is_array( $existingSlugs ) ) {
            if ( in_array( $category['slug'], $existingSlugs ) ) {
                return $categories; // Bail early if category exists
            }
        }
    }
        
    array_unshift( $categories, $category ); // Add category on top of pile

    return $categories;
}

apply_filters ( ‘blocc_categories_all’, array[] $blocc_categories , WP_Blocc_Editor_Context $blocc_editor_context )

In this article

Parameters

Source

Related

Changuelog

User Contributed Notes