Fix 13776: Format is already registered to handle class name

[gziolo]

Description

Fixes #13776.

Custom formats are logging this error:

gutenberg/packages/rich-text/src/register-format-type.js

Line 95 in 01be7ac

`Format "${ formatTypeForBareElement.name }" is already registered to handle bare tag name "${ settings.tagName }".`

even when classNames were defined.

To Reproduce
Steps to reproduce the behavior:

1. Format type with a class name A and tag name B gets registered.
2. Another format type without any class name but the same tag name B gets registered.

Example format type to test with:

const { registerFormatType } = window.wp.richText;
const { RichTextToolbarButton } = window.wp.editor;

registerFormatType( 'wk/no-icon', {
	edit( { isActive } ) {
		return (
			<RichTextToolbarButton
				icon={ 'editor-link' }
				title={ 'Link ohne Icon' }
				isActive={ isActive }
				/>
		);
	},
  	tagName: 'a',
  	className: 'without-icon',
  	title: 'Link ohne Icon'
} );

Props to @pascalknecht for sharing.

Expected behavior
No error logs and all format types are properly registered. In the example provided core link should be there.

Screenshots

[technote-space]

This PR will also fix #13687

[ellatrix]

Do you think this is something that should still be part of WordPress 5.2?

[gziolo]

Thanks @ellatrix, Good catch 👍

[gziolo]

Do you think this is something that should still be part of WordPress 5.2?

Yes, it seems like a major inconvenience for plugin developers.

[pbiron]

Do you think this is something that should still be part of WordPress 5.2?

Yes, it seems like a major inconvenience for plugin developers.

Looks like this did not make it into 5.2. I'm using 5.2-RC1-45273 and I still get the error.

[aduth]

Looks like this did not make it into 5.2. I'm using 5.2-RC1-45273 and I still get the error.

That's correct. It did not make it for 5.2 . I would assume it could be included in a subsequent minor release (5.2.x), which if I recall correctly from a previous #core dev chat should follow not-long-after the upcoming major release.

[swinggraphics]

There is an official tutorial in the documentation here with code. One expects that tagName could be set to something like "span" or "strong" or "a", but the "already registered to handle bare tag name" error comes up. How are we to add classes to existing elements, or create multiple custom formats using spans?

[mahnunchik]

Any news? I've the same error with a tag.

[mattmilburn]

@mahnunchik I fixed this issue by providing a non-null className in the format settings. I had it set to null at first but using a string value for className got rid of that error. I'm curious if that would help resolve it for you.

[mahnunchik]

@mattmilburn Thank you! Wordpress 5.3 and not null className helps me.