Allow custom block prefix

Author: ErikBernskiold

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file. This projec
 
 ## [Unreleased]
 
+## [2.1.0] - 2021-09-22
+
+### Changed
+
+- Now allows registering of a custom block prefix instead of the default `bm`.
+
 ## [2.0.3] - 2021-07-30
 
 ### Fixed

README.md

@@ -24,7 +24,25 @@ class My_Plugin {
 }
 ```
 
-# Required Folder Structure
+### Defining a custom block prefix
+The trait will default to using the 'bm' prefix for blocks. Blocks are named with a prefix to scope them to the project they are a part of. This also influences how the script and style handles are registered ($prefix-block-$block_name).
+
+Your project probably requires its custom prefix. You can set it on the main plugin class like so:
+
+```
+use BernskioldMedia\WP\Block_Plugin_Support\Traits\Has_Blocks;
+
+class My_Plugin {
+
+    use Has_Blocks;
+    
+    // Set my custom block prefix.
+    protected static string $block_prefix = 'my-prefix';
+
+}
+```
+
+## Required Folder Structure
 
 The trait assumes the following folder structure:
 
@@ -34,14 +52,15 @@ The trait assumes the following folder structure:
 
 `languages/` is the location of the translation files. The handle and domain are both set to `{$block_prefix}-{$block_name}`.
 
-# Required Methods
+## Required Methods
 
 The trait relies on two methods to be implemented.
 
 - `get_url()` should return the URL to the plugin directory.
 - `get_path()` should return the path to the plugin directory.
+- `get_textdomain()` should return the string plugin textdomain.
 
-# Hooks & Filters
+## Hooks & Filters
 
 We strive to make all code easily customizable with plenty of filters and hooks as needed. You never know when or why you might need that simple one-off customization.
 

src/Traits/Has_Blocks.php

@@ -8,8 +8,9 @@
  * Designed to extend a core plugin file that is a plugin
  * that provides blocks for output.
  *
- * @property array $conditional_blocks An array of blocks that are only loaded if the corresponding class name exists. blockname => classname.
- * @property array $dynamic_blocks An array of blocks that are dynamic, meaning they use PHP to load on the frontend. blockname => classname.
+ * @property array  $conditional_blocks An array of blocks that are only loaded if the corresponding class name exists. blockname => classname.
+ * @property array  $dynamic_blocks     An array of blocks that are dynamic, meaning they use PHP to load on the frontend. blockname => classname.
+ * @property string $block_prefix       The prefix for all the blocks in this plugin.
  *
  * @package BernskioldMedia\WP\Block_Plugin_Support\Traits
  */
@@ -43,7 +44,8 @@ public function register_blocks(): void {
 			$asset_meta = include static::get_path() . 'dist/blocks/' . $name . '.asset.php';
 
 			// Register the script with WordPress.
-			wp_register_script( 'bm-block-' . $name, static::get_url( 'dist/blocks/' . $name . '.js' ), $asset_meta['dependencies'], $asset_meta['version'], true );
+			wp_register_script( static::get_block_prefix() . '-block-' . $name, static::get_url( 'dist/blocks/' . $name . '.js' ), $asset_meta['dependencies'],
+				$asset_meta['version'], true );
 
 			// Register the block. Dynamic blocks get their callback.
 			if ( isset( static::$dynamic_blocks[ $name ] ) ) {
@@ -55,29 +57,28 @@ public function register_blocks(): void {
 				register_block_type( $directory, [
 					'render_callback' => [ static::$dynamic_blocks[ $name ], 'render' ],
 				] );
-			} else {
+			}
+			else {
 				register_block_type( $directory );
 			}
 
 			// Load translations.
-			wp_set_script_translations( 'bm-block-' . $name, static::get_textdomain(), static::get_path( 'languages/' ) );
+			wp_set_script_translations( static::get_block_prefix() . '-block-' . $name, static::get_textdomain(), static::get_path( 'languages/' ) );
 		}
 	}
 
 	/**
-	 * Get the URL to the plugin folder, or the specified
-	 * file relative to the plugin folder home.
-	 */
-	abstract public static function get_url( string $file = '' ): string;
-
-	/**
-	 * Get the path to the plugin folder, or the specified
-	 * file relative to the plugin folder home.
+	 * Get the prefix that we use when registering the blocks. To set your
+	 * own prefix, just define the protected static string $block_prefix property
+	 * on your base plugin class.
+	 *
+	 * @return string
 	 */
-	abstract public static function get_path( string $file = '' ): string;
+	protected static function get_block_prefix(): string {
+		if ( property_exists( static::class, 'block_prefix' ) ) {
+			return static::$block_prefix;
+		}
 
-	/**
-	 * Get the textdomain for the plugin.
-	 */
-	abstract public static function get_textdomain(): string;
+		return 'bm';
+	}
 }