Custom Taxonomies for Blocks

Description

Custom taxonomies that were developed prior to the release of WordPress 5.0 (the Gutenberg release) may not be compatible with the WordPress block editor.

Custom taxonomies require that the “show_in_rest” property be set to “true” in order to work with the block editor. “show_in_rest” was added with WordPress 4.7 and the integration of the WordPress JSON REST API. Sites using custom taxonomies that were created prior to this likely do not have this property set. Additionally, the default value for “show_in_rest” is “false” (this is poorly documented), ergo older custom taxonomies will not appear in the WordPress block editor interface.

This plugin will take any custom taxonomy where the “show_in_rest” feature is set to “false” and change it to “true”. It will not add any additional REST properties, such as “rest_base” or “rest_controller_class”. If you need those properties set for any reason, you will need to update your custom taxonomy where it is being registered.

Installation

  1. Upload the plugin to the /wp-content/plugins directory, or install the plugin through the WordPress plugins screen directly.
  2. Activate the plugin through the ‘Plugins’ screen in WordPress

FAQ

What does this plugin _do_, exactly?

This plugin will go through every registered custom taxonomy (any taxonomy that isn’t registered in wp-includes/taxonomy.php) and change the “show_in_rest” property from false to true. Doing so will enable older custom taxonomies to be accessed in the WordPress block editor.

Are there any settings for this plugin?

Not at present, but a later version of this plugin will allow site administrators to choose which custom taxonomies they want to enable for the block editor interface.

Does this plugin work with the Classic Editor plugin?

Since the Classic Editor plugin disables the WordPress block editor completely, there is no need for this plugin if Classic Editor is installed and activated.

If Classic Editor is installed and activated, this plugin will not run.

Contributors & Developers

“Custom Taxonomies for Blocks” is open source software. The following people have contributed to this plugin.

Contributors

Changelog

1.0

  • Initial submission to the WordPress plugin repository. Sets all custom taxonomies where “show_in_rest” is false to true so that they are compatible with the WordPress 5.* block editor interface.