feat: new Curated List block, block pattern, and map functionality

includes/class-newspack-listings-api.php

@@ -1,15 +1,16 @@
 <?php
 /**
- * Newspack Listings Core.
+ * Newspack Listings API.
  *
- * Registers custom post types and taxonomies.
+ * Custom API endpoints for Newspack Listings.
  *
  * @package Newspack_Listings
  */
 
 namespace Newspack_Listings;
 
 use \Newspack_Listings\Newspack_Listings_Core as Core;
+use \Newspack_Listings\Utils as Utils;
 
 defined( 'ABSPATH' ) || exit;
 
@@ -115,26 +116,34 @@ public static function get_items( $request ) {
 			return new \WP_REST_Response(
 				array_map(
 					function( $post ) use ( $fields ) {
+						$response = [
+							'id'    => $post->ID,
+							'title' => $post->post_title,
+						];
 
-						// If $fields includes meta, get all Newspack Listings meta fields.
-						$post_meta = [];
+						// If $fields includes excerpt, get the post excerpt.
+						if ( in_array( 'excerpt', $fields ) ) {
+							$response['excerpt'] = wpautop( get_the_excerpt( $post->ID ) );
+						}
+
+						// If $fields includes media, get the featured image + caption.
+						if ( in_array( 'media', $fields ) ) {
+							$response['media'] = [
+								'image'   => get_the_post_thumbnail_url( $post->ID, 'medium' ),
+								'caption' => get_the_post_thumbnail_caption( $post->ID ),
+							];
+						}
 
+						// If $fields includes meta, get all Newspack Listings meta fields.
 						if ( in_array( 'meta', $fields ) ) {
-							$post_meta = array_filter(
-								get_post_meta( $post->ID ),
-								function( $key ) {
-									return is_numeric( strpos( $key, 'newspack_listings_' ) );
-								},
-								ARRAY_FILTER_USE_KEY
-							);
+							$post_meta = Core::get_meta_values( $post->ID, $post->post_type );
+
+							if ( ! empty( $post_meta ) ) {
+								$response['meta'] = $post_meta;
+							}
 						}
 
-						return [
-							'id'      => $post->ID,
-							'title'   => $post->post_title,
-							'content' => wpautop( get_the_excerpt( $post->ID ) ),
-							'meta'    => $post_meta,
-						];
+						return $response;
 					},
 					$query->posts
 				),

includes/class-newspack-listings-blocks.php

@@ -1,8 +1,8 @@
 <?php
 /**
- * Newspack Listings Core.
+ * Newspack Listings Blocks.
  *
- * Registers custom post types and taxonomies.
+ * Custom Gutenberg Blocks for Newspack Listings.
  *
  * @package Newspack_Listings
  */
@@ -18,6 +18,10 @@
  * Sets up custom blocks for listings.
  */
 final class Newspack_Listings_Blocks {
+	/**
+	 * Slug for the block pattern category.
+	 */
+	const NEWSPACK_LISTINGS_BLOCK_PATTERN_CATEGORY = 'newspack-listings-patterns';
 
 	/**
 	 * The single instance of the class.
@@ -43,53 +47,53 @@ public static function instance() {
 	 * Constructor.
 	 */
 	public function __construct() {
-		add_filter( 'block_categories', [ __CLASS__, 'update_block_categories' ] );
 		add_action( 'enqueue_block_editor_assets', [ __CLASS__, 'manage_editor_assets' ] );
+		add_action( 'admin_init', [ __CLASS__, 'register_block_pattern_category' ], 10 );
+		add_action( 'admin_init', [ __CLASS__, 'register_block_patterns' ], 11 );
 		add_action( 'init', [ __CLASS__, 'manage_view_assets' ] );
 	}
 
 	/**
 	 * Enqueue editor assets.
 	 */
 	public static function manage_editor_assets() {
-		if ( Core::is_curated_list() || Core::is_listing() ) {
-			wp_enqueue_script(
-				'newspack-listings-editor',
-				NEWSPACK_LISTINGS_URL . 'dist/editor.js',
-				[],
-				NEWSPACK_LISTINGS_VERSION,
-				true
-			);
-
-			$post_type = get_post_type();
-
-			wp_localize_script(
-				'newspack-listings-editor',
-				'newspack_listings_data',
-				[
-					'post_type'   => get_post_type_object( $post_type )->labels->singular_name,
-					'post_types'  => Core::NEWSPACK_LISTINGS_POST_TYPES,
-					'meta_fields' => Core::get_meta_fields( $post_type ),
-				]
-			);
-
-			wp_register_style(
-				'newspack-listings-editor',
-				plugins_url( '../dist/editor.css', __FILE__ ),
-				[],
-				NEWSPACK_LISTINGS_VERSION
-			);
-			wp_style_add_data( 'newspack-listings-editor', 'rtl', 'replace' );
-			wp_enqueue_style( 'newspack-listings-editor' );
-		}
+		wp_enqueue_script(
+			'newspack-listings-editor',
+			NEWSPACK_LISTINGS_URL . 'dist/editor.js',
+			[],
+			NEWSPACK_LISTINGS_VERSION,
+			true
+		);
+
+		$post_type = get_post_type();
+
+		wp_localize_script(
+			'newspack-listings-editor',
+			'newspack_listings_data',
+			[
+				'post_type_label' => get_post_type_object( $post_type )->labels->singular_name,
+				'post_type'       => $post_type,
+				'post_types'      => Core::NEWSPACK_LISTINGS_POST_TYPES,
+				'meta_fields'     => Core::get_meta_fields( $post_type ),
+			]
+		);
+
+		wp_register_style(
+			'newspack-listings-editor',
+			plugins_url( '../dist/editor.css', __FILE__ ),
+			[],
+			NEWSPACK_LISTINGS_VERSION
+		);
+		wp_style_add_data( 'newspack-listings-editor', 'rtl', 'replace' );
+		wp_enqueue_style( 'newspack-listings-editor' );
 	}
 
 	/**
 	 * Enqueue front-end assets.
 	 */
 	public static function manage_view_assets() {
+		// Do nothing in editor environment.
 		if ( is_admin() ) {
-			// In editor environment, do nothing.
 			return;
 		}
 
@@ -127,22 +131,59 @@ public static function manage_view_assets() {
 	}
 
 	/**
-	 * Add custom block category.
-	 *
-	 * @param array $categories Default Gutenberg categories.
-	 * @return array
+	 * Register custom block pattern category for Newspack Listings.
 	 */
-	public static function update_block_categories( $categories ) {
-		return array_merge(
-			$categories,
-			[
-				[
-					'slug'  => 'newspack-listings',
-					'title' => __( 'Newspack Listings', 'newspack-listings' ),
-				],
-			]
+	public static function register_block_pattern_category() {
+		return register_block_pattern_category(
+			self::NEWSPACK_LISTINGS_BLOCK_PATTERN_CATEGORY,
+			[ 'label' => __( 'Newspack Listings', 'newspack-listings' ) ]
 		);
 	}
+
+	/**
+	 * Register custom block patterns for Newspack Listings.
+	 * These patterns should only be available for certain CPTs.
+	 */
+	public static function register_block_patterns() {
+		// Block pattern config.
+		$block_patterns = [
+			'business' => [
+				'post_types' => [
+					Core::NEWSPACK_LISTINGS_POST_TYPES['marketplace'],
+					Core::NEWSPACK_LISTINGS_POST_TYPES['place'],
+				],
+				'settings'   => [
+					'title'       => __( 'Business Listing', 'newspack-listings' ),
+					'categories'  => [ self::NEWSPACK_LISTINGS_BLOCK_PATTERN_CATEGORY ],
+					'description' => _x(
+						'Business description, website and social media links, and hours of operation.',
+						'Block pattern description',
+						'newspack-listings'
+					),
+					'content'     => '<!-- wp:columns --><div class="wp-block-columns"><!-- wp:column {"width":66.66} --><div class="wp-block-column" style="flex-basis:66.66%"><!-- wp:paragraph --><p>Consectetur a urna hendrerit scelerisque suspendisse inceptos scelerisque neque parturient a mi adipiscing euismod mus. Ad felis morbi magna augue consectetur eleifend sit sem habitant suspendisse posuere amet felis adipiscing a himenaeos ipsum vivamus dictum vestibulum lacus consectetur vestibulum erat dignissim per sem integer. Cras class ac adipiscing inceptos a enim porta a elit scelerisque tincidunt hac ad netus accumsan parturient conubia vestibulum nec quisque parturient interdum fringilla curabitur cras sociosqu interdum. Porta aenean id a mus consectetur lacus lacus ut parturient sapien ut a sociosqu potenti ridiculus non tristique cursus a at parturient condimentum a duis convallis per. Dictum elementum ultricies ac risus vestibulum adipiscing placerat imperdiet malesuada scelerisque dictum mus adipiscing a at at fermentum scelerisque nisl a dignissim suscipit sapien taciti nulla curabitur vestibulum.</p><!-- /wp:paragraph --></div><!-- /wp:column --><!-- wp:column {"width":33.33} --><div class="wp-block-column" style="flex-basis:33.33%"><!-- wp:jetpack/map {"mapCenter":{"lng":-122.41941550000001,"lat":37.7749295},"mapHeight":null} -->
+					<div class="wp-block-jetpack-map" data-map-style="default" data-map-details="true" data-points="[]" data-zoom="13" data-map-center="{&quot;lng&quot;:-122.41941550000001,&quot;lat&quot;:37.7749295}" data-marker-color="red" data-show-fullscreen-button="true"></div>
+					<!-- /wp:jetpack/map --><!-- wp:jetpack/contact-info --><div class="wp-block-jetpack-contact-info"><!-- wp:jetpack/address /--><!-- wp:jetpack/email /--><!-- wp:jetpack/phone /--></div><!-- /wp:jetpack/contact-info --><!-- wp:buttons --><div class="wp-block-buttons"><!-- wp:button {"className":"is-style-fill"} --><div class="wp-block-button is-style-fill"><a class="wp-block-button__link" href="https://newspack.pub">Visit our website</a></div><!-- /wp:button --></div><!-- /wp:buttons --><!-- wp:social-links --><ul class="wp-block-social-links"><!-- wp:social-link {"url":"https://newspack.pub","service":"wordpress"} /--><!-- wp:social-link {"url":"https://facebook.com","service":"facebook"} /--><!-- wp:social-link {"url":"https://twitter.com","service":"twitter"} /--><!-- wp:social-link {"url":"https://instagram.com","service":"instagram"} /--><!-- wp:social-link {"service":"linkedin"} /--><!-- wp:social-link {"service":"youtube"} /--></ul><!-- /wp:social-links --><!-- wp:separator {"className":"is-style-wide"} --><hr class="wp-block-separator is-style-wide"/><!-- /wp:separator --><!-- wp:heading {"level":4} --><h4>Hours of Operation</h4><!-- /wp:heading --><!-- wp:jetpack/business-hours /--></div><!-- /wp:column --></div><!-- /wp:columns -->',
+				],
+			],
+		];
+
+		/**
+		 * Register block patterns for particular post types. We need to get the post type using the
+		 * post ID from $_REQUEST since the global $post is not available inside the admin_init hook.
+		 * If we can't determine the current post type, just register the patterns anyway.
+		 */
+		$post_id           = isset( $_REQUEST['post'] ) ? sanitize_text_field( $_REQUEST['post'] ) : null; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$current_post_type = ! empty( $post_id ) && function_exists( 'get_post_type' ) ? get_post_type( $post_id ) : null;
+
+		foreach ( $block_patterns as $pattern_name => $config ) {
+			if ( empty( $current_post_type ) || in_array( $current_post_type, $config['post_types'] ) ) {
+				$pattern = register_block_pattern(
+					'newspack-listings/' . $pattern_name,
+					$config['settings']
+				);
+			}
+		}
+	}
 }
 
 Newspack_Listings_Blocks::instance();