fix: prevent author information from displaying author block for unsu…

…pported Custom Post Types & show notice to user
WordPress · Nov 19, 2024 · 7555d97 · 7555d97
1 parent f6e6e45
commit 7555d97
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 3 deletions.
diff --git a/packages/block-library/src/post-author-name/edit.js b/packages/block-library/src/post-author-name/edit.js
@@ -12,17 +12,22 @@ import {
 	InspectorControls,
 	useBlockProps,
 } from '@wordpress/block-editor';
-import { useSelect } from '@wordpress/data';
+import { useSelect, useDispatch } from '@wordpress/data';
 import { __ } from '@wordpress/i18n';
 import { store as coreStore } from '@wordpress/core-data';
 import { PanelBody, ToggleControl } from '@wordpress/components';
+import { store as noticesStore } from '@wordpress/notices';
+import { useEffect, useRef } from '@wordpress/element';
 
 function PostAuthorNameEdit( {
+	isSelected,
 	context: { postType, postId },
 	attributes: { textAlign, isLink, linkTarget },
 	setAttributes,
 } ) {
-	const { authorName } = useSelect(
+	const { createNotice } = useDispatch( noticesStore );
+	const noticeDisplayedRef = useRef( false );
+	const { authorName, supportsAuthor } = useSelect(
 		( select ) => {
 			const { getEditedEntityRecord, getUser } = select( coreStore );
 			const _authorId = getEditedEntityRecord(
@@ -33,11 +38,30 @@ function PostAuthorNameEdit( {
 
 			return {
 				authorName: _authorId ? getUser( _authorId ) : null,
+				supportsAuthor:
+					select( coreStore ).getPostType( postType )?.supports
+						?.author ?? false,
 			};
 		},
 		[ postType, postId ]
 	);
 
+	useEffect( () => {
+		// The extra `! noticeDisplayedRef.current` check avoids duplicate notices in development mode (React.StrictMode).
+		if ( ! supportsAuthor && ! noticeDisplayedRef.current && isSelected ) {
+			createNotice(
+				'warning',
+				__(
+					'The current post type does not support authors. The Post Author Name block will not be displayed.'
+				),
+				{
+					isDismissible: true,
+				}
+			);
+			noticeDisplayedRef.current = true;
+		}
+	}, [ supportsAuthor, createNotice, isSelected ] );
+
 	const blockProps = useBlockProps( {
 		className: clsx( {
 			[ `has-text-align-${ textAlign }` ]: textAlign,

diff --git a/packages/block-library/src/post-author-name/index.php b/packages/block-library/src/post-author-name/index.php
@@ -26,6 +26,10 @@ function render_block_core_post_author_name( $attributes, $content, $block ) {
 		return '';
 	}
 
+	if ( ! post_type_supports( get_post_type( $block->context['postId'] ), 'author' ) ) {
+	    return '';
+	}
+
 	$author_name = get_the_author_meta( 'display_name', $author_id );
 	if ( isset( $attributes['isLink'] ) && $attributes['isLink'] ) {
 		$author_name = sprintf( '<a href="%1$s" target="%2$s" class="wp-block-post-author-name__link">%3$s</a>', get_author_posts_url( $author_id ), esc_attr( $attributes['linkTarget'] ), $author_name );

diff --git a/packages/block-library/src/post-author/edit.js b/packages/block-library/src/post-author/edit.js
@@ -23,6 +23,8 @@ import {
 import { useSelect, useDispatch } from '@wordpress/data';
 import { __ } from '@wordpress/i18n';
 import { store as coreStore } from '@wordpress/core-data';
+import { store as noticesStore } from '@wordpress/notices';
+import { useEffect, useRef } from '@wordpress/element';
 
 const minimumUsersForCombobox = 25;
 
@@ -37,8 +39,10 @@ function PostAuthorEdit( {
 	attributes,
 	setAttributes,
 } ) {
+	const { createNotice } = useDispatch( noticesStore );
+	const noticeDisplayedRef = useRef( false );
 	const isDescendentOfQueryLoop = Number.isFinite( queryId );
-	const { authorId, authorDetails, authors } = useSelect(
+	const { authorId, authorDetails, authors, supportsAuthor } = useSelect(
 		( select ) => {
 			const { getEditedEntityRecord, getUser, getUsers } =
 				select( coreStore );
@@ -52,6 +56,9 @@ function PostAuthorEdit( {
 				authorId: _authorId,
 				authorDetails: _authorId ? getUser( _authorId ) : null,
 				authors: getUsers( AUTHORS_QUERY ),
+				supportsAuthor:
+					select( coreStore ).getPostType( postType )?.supports
+						?.author ?? false,
 			};
 		},
 		[ postType, postId ]
@@ -72,6 +79,22 @@ function PostAuthorEdit( {
 		} );
 	}
 
+	useEffect( () => {
+		// The extra `! noticeDisplayedRef.current` check avoids duplicate notices in development mode (React.StrictMode).
+		if ( ! supportsAuthor && ! noticeDisplayedRef.current && isSelected ) {
+			createNotice(
+				'warning',
+				__(
+					'The current post type does not support authors. The Post Author block will not be displayed.'
+				),
+				{
+					isDismissible: true,
+				}
+			);
+			noticeDisplayedRef.current = true;
+		}
+	}, [ supportsAuthor, createNotice, isSelected ] );
+
 	const blockProps = useBlockProps( {
 		className: clsx( {
 			[ `has-text-align-${ textAlign }` ]: textAlign,

diff --git a/packages/block-library/src/post-author/index.php b/packages/block-library/src/post-author/index.php
@@ -26,6 +26,10 @@ function render_block_core_post_author( $attributes, $content, $block ) {
 		return '';
 	}
 
+	if ( ! post_type_supports( get_post_type( $block->context['postId'] ), 'author' ) ) {
+	    return '';
+	}		
+
 	$avatar = ! empty( $attributes['avatarSize'] ) ? get_avatar(
 		$author_id,
 		$attributes['avatarSize']