Try add Post Type Archive in Link UI and Navigation Link via new Post Type Archive Search Handler

lib/compat/wordpress-6.8/class-gutenberg-rest-post-archive-search-handler.php

@@ -0,0 +1,121 @@
+<?php
+/**
+ * REST API: WP_REST_Post_Archive_Search_Handler class
+ *
+ * @package WordPress
+ * @subpackage REST_API
+ * @since 6.8.0
+ */
+
+/**
+ * Core class representing a search handler for Post Archives in the REST API.
+ *
+ * @since 6.8.0
+ *
+ * @see WP_REST_Search_Handler
+ */
+class Gutenberg_REST_Post_Archive_Search_Handler extends WP_REST_Search_Handler {
+
+	/**
+	 * Constructor.
+	 *
+	 * @since 6.8.0
+	 */
+	public function __construct() {
+		$this->type = 'post-type-archive';
+	}
+
+	/**
+	 * Searches post-type archives for a given search request.
+	 *
+	 * @since 6.8.0
+	 *
+	 * @param WP_REST_Request $request Full REST request.
+	 * @return array {
+	 *     Associative array containing found IDs and total count for the matching search results.
+	 *
+	 *     @type int[]               $ids   Found post archive IDs.
+	 *     @type int $total The number of post-type archives found.
+	 * }
+	 */
+	public function search_items( WP_REST_Request $request ) {
+
+		$search_term = $request['search'];
+		$page        = (int) $request['page'];
+		$per_page    = (int) $request['per_page'];
+
+		$args = array(
+			'public'       => true,
+			'has_archive'  => true, // ensure only posts with archive are considered.
+			'show_in_rest' => true,
+			'_builtin'     => false,
+		);
+
+		$post_types = get_post_types( $args );
+		$found_ids  = array();
+
+		if ( ! empty( $post_types ) ) {
+			foreach ( $post_types as $post_type ) {
+				// Check if the search term matches the post type name.
+				if ( empty( $search_term ) || stripos( $post_type, $search_term ) !== false ) {
+					$found_ids[] = $post_type;
+				}
+			}
+		}
+
+		return array(
+			self::RESULT_IDS   => array_slice( $found_ids, ( $page - 1 ) * $per_page, $per_page ),
+			self::RESULT_TOTAL => count( $found_ids ),
+		);
+	}
+
+	/**
+	 * Prepares the search result for a given post archive ID.
+	 *
+	 * @since 6.8.0
+	 *
+	 * @param int   $id     Term ID.
+	 * @param array $fields Fields to include for the post archive.
+	 * @return array {
+	 *     Associative array containing fields for the post-archive based on the `$fields` parameter.
+	 *
+	 *     @type id     $id    Optional. Post Archive Slug.
+	 *     @type string $title Optional. Post Archive name.
+	 *     @type string $url   Optional. Post Archive permalink URL.
+	 * }
+	 */
+	public function prepare_item( $id, array $fields ) {
+
+		$post_type = get_post_type_object( $id );
+
+		$data = array();
+
+		if ( in_array( WP_REST_Search_Controller::PROP_ID, $fields, true ) ) {
+			$data[ WP_REST_Search_Controller::PROP_ID ] = $id;
+		}
+		if ( in_array( WP_REST_Search_Controller::PROP_TITLE, $fields, true ) ) {
+			$data[ WP_REST_Search_Controller::PROP_TITLE ] = $post_type->labels->archives;
+		}
+		if ( in_array( WP_REST_Search_Controller::PROP_URL, $fields, true ) ) {
+			$data[ WP_REST_Search_Controller::PROP_URL ] = get_post_type_archive_link( $id );
+		}
+
+		if ( in_array( WP_REST_Search_Controller::PROP_TYPE, $fields, true ) ) {
+			$data[ WP_REST_Search_Controller::PROP_TYPE ] = sprintf( '%s-%s', $post_type->name, __( 'archive' ) );
+		}
+
+		return $data;
+	}
+
+	/**
+	 * Prepares links for the search result of a given ID.
+	 *
+	 * @since 6.8.0
+	 *
+	 * @param int $id Item ID.
+	 * @return array[] Array of link arrays for the given item.
+	 */
+	public function prepare_item_links( $id ) {  // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+		return array();
+	}
+}

lib/experimental/rest-api.php

@@ -20,6 +20,9 @@ function gutenberg_register_block_editor_settings() {
 add_action( 'rest_api_init', 'gutenberg_register_block_editor_settings' );
 
 
+
+
+
 /**
  * Shim for get_sample_permalink() to add support for auto-draft status.
  *

lib/load.php

@@ -49,6 +49,7 @@ function gutenberg_is_experiment_enabled( $name ) {
 	// WordPress 6.8 compat.
 	require __DIR__ . '/compat/wordpress-6.8/block-comments.php';
 	require __DIR__ . '/compat/wordpress-6.8/class-gutenberg-rest-comment-controller-6-8.php';
+	require __DIR__ . '/compat/wordpress-6.8/class-gutenberg-rest-post-archive-search-handler.php';
 
 	// Plugin specific code.
 	require_once __DIR__ . '/class-wp-rest-global-styles-controller-gutenberg.php';

lib/rest-api.php

@@ -37,3 +37,13 @@ function gutenberg_register_edit_site_export_controller_endpoints() {
 	$edit_site_export_controller->register_routes();
 }
 add_action( 'rest_api_init', 'gutenberg_register_edit_site_export_controller_endpoints' );
+
+
+/**
+ * Registers REST search handler for Post Type Archives.
+ */
+function gutenberg_register_post_archive_rest_search_handler( $handlers ) {
+	$handlers[] = new Gutenberg_REST_Post_Archive_Search_Handler();
+	return $handlers;
+}
+add_filter( 'wp_rest_search_handlers', 'gutenberg_register_post_archive_rest_search_handler' );

packages/block-editor/src/components/link-control/search-item.js

@@ -13,6 +13,7 @@ import {
 	file,
 	home,
 	verse,
+	customPostType,
 } from '@wordpress/icons';
 import { __unstableStripHTML as stripHTML } from '@wordpress/dom';
 import { safeDecodeURI, filterURLForDisplay, getPath } from '@wordpress/url';
@@ -41,18 +42,16 @@ function SearchItemIcon( { isURL, suggestion } ) {
 				icon = verse;
 			}
 		}
+	} else {
+		icon = customPostType;
 	}
 
-	if ( icon ) {
-		return (
-			<Icon
-				className="block-editor-link-control__search-item-icon"
-				icon={ icon }
-			/>
-		);
-	}
-
-	return null;
+	return (
+		<Icon
+			className="block-editor-link-control__search-item-icon"
+			icon={ icon }
+		/>
+	);
 }
 
 /**
@@ -155,6 +154,10 @@ function getVisualTypeName( suggestion ) {
 		return 'blog home';
 	}
 
+	if ( suggestion.kind === 'post-type-archive' ) {
+		return 'archive';
+	}
+
 	// Rename 'post_tag' to 'tag'. Ideally, the API would return the localised CPT or taxonomy label.
 	return suggestion.type === 'post_tag' ? 'tag' : suggestion.type;
 }

packages/block-library/src/navigation-link/index.php

@@ -371,6 +371,7 @@ function block_core_navigation_link_filter_variations( $variations, $block_type
  * @return array
  */
 function block_core_navigation_link_build_variations() {
+
 	$post_types = get_post_types( array( 'show_in_nav_menus' => true ), 'objects' );
 	$taxonomies = get_taxonomies( array( 'show_in_nav_menus' => true ), 'objects' );
 
@@ -392,6 +393,27 @@ function block_core_navigation_link_build_variations() {
 				$variations[] = $variation;
 			}
 		}
+
+		// If any of the post types have `has_archive` set to true then add a post-type-archive variation.
+		$has_archive = array_filter(
+			$post_types,
+			function ( $post_type ) {
+				return $post_type->has_archive;
+			}
+		);
+
+		if ( $has_archive ) {
+			$variation    = array(
+				'name'        => 'post-type-archive',
+				'title'       => __( 'Post Type Archive Link' ),
+				'description' => __( 'A link to a post type archive' ),
+				'attributes'  => array(
+					'type' => 'all',
+					'kind' => 'post-type-archive',
+				),
+			);
+			$variations[] = $variation;
+		}
 	}
 	if ( $taxonomies ) {
 		foreach ( $taxonomies as $taxonomy ) {

packages/block-library/src/navigation-link/link-ui.js

@@ -63,6 +63,9 @@ export function getSuggestionsQuery( type, kind ) {
 			if ( kind === 'taxonomy' ) {
 				return { type: 'term', subtype: type };
 			}
+			if ( kind === 'post-type-archive' ) {
+				return { type: 'post-type-archive' };
+			}
 			if ( kind === 'post-type' ) {
 				return { type: 'post', subtype: type };
 			}

packages/core-data/src/fetch/__experimental-fetch-link-suggestions.ts

@@ -21,7 +21,7 @@ export type SearchOptions = {
 	/**
 	 * Filters by search type.
 	 */
-	type?: 'attachment' | 'post' | 'term' | 'post-format';
+	type?: 'attachment' | 'post' | 'term' | 'post-format' | 'post-type-archive';
 	/**
 	 * Slug of the post-type or taxonomy.
 	 */
@@ -240,6 +240,33 @@ export default async function fetchLinkSuggestions(
 		);
 	}
 
+	if ( ! type || type === 'post-type-archive' ) {
+		queries.push(
+			apiFetch< SearchAPIResult[] >( {
+				path: addQueryArgs( '/wp/v2/search', {
+					search,
+					page,
+					per_page: perPage,
+					type: 'post-type-archive',
+				} ),
+			} )
+				.then( ( results ) => {
+					return results.map( ( result ) => {
+						return {
+							id: result.id,
+							url: result.url,
+							title:
+								decodeEntities( result.title || '' ) ||
+								__( '(no title)' ),
+							type: `${ result.type }`,
+							kind: 'post-type-archive',
+						};
+					} );
+				} )
+				.catch( () => [] ) // Fail by returning no results.
+		);
+	}
+
 	const responses = await Promise.all( queries );
 
 	let results = responses.flat();

packages/core-data/src/fetch/test/__experimental-fetch-link-suggestions.js

@@ -86,6 +86,16 @@ jest.mock( '@wordpress/api-fetch', () =>
 							'http://localhost:8888/wp-content/uploads/2022/03/test-pdf.pdf',
 					},
 				] );
+			case '/wp/v2/search?search=&per_page=20&type=post-type-archive':
+				return Promise.resolve( [
+					{
+						id: 'books',
+						title: 'All Books',
+						url: 'http://wordpress.local/books/',
+						type: 'books-archive',
+						kind: 'post-type-archive',
+					},
+				] );
 			default:
 				return Promise.resolve( [
 					{
@@ -187,7 +197,7 @@ describe( 'fetchLinkSuggestions', () => {
 		);
 	} );
 
-	it( 'returns suggestions from post, term, post-format and media', () => {
+	it( 'returns suggestions from post, term, post-format, media and post-type-archive', () => {
 		return fetchLinkSuggestions( '', {} ).then( ( suggestions ) =>
 			expect( suggestions ).toEqual( [
 				{
@@ -232,6 +242,13 @@ describe( 'fetchLinkSuggestions', () => {
 					type: 'attachment',
 					kind: 'media',
 				},
+				{
+					id: 'books',
+					title: 'All Books',
+					url: 'http://wordpress.local/books/',
+					type: 'books-archive',
+					kind: 'post-type-archive',
+				},
 			] )
 		);
 	} );