@automattic/newspack-blocks 1.37.0 → 1.48.0

package/src/blocks/author-list/view.php

@@ -0,0 +1,175 @@
+<?php
+/**
+ * Server-side render functions for the Author List block.
+ *
+ * @package WordPress
+ */
+
+/**
+ * Dynamic block registration.
+ */
+function newspack_blocks_register_author_list() {
+	$block_json = json_decode(
+		file_get_contents( __DIR__ . '/block.json' ), // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+		true
+	);
+
+	register_block_type(
+		'newspack-blocks/' . $block_json['name'],
+		[
+			'attributes'      => $block_json['attributes'],
+			'render_callback' => 'newspack_blocks_render_block_author_list',
+		]
+	);
+}
+
+/**
+ * Block render callback.
+ *
+ * @param array $attributes Block attributes.
+ */
+function newspack_blocks_render_block_author_list( $attributes ) {
+	if ( ! class_exists( 'WP_REST_Newspack_Author_List_Controller' ) ) {
+		return;
+	}
+
+	// Gather attributes.
+	$exclude_ids         = array_map(
+		function( $exclusion ) {
+			return (int) $exclusion['value'];
+		},
+		$attributes['exclude']
+	);
+	$exclude_empty       = $attributes['excludeEmpty'];
+	$author_roles        = $attributes['authorRoles'];
+	$author_type         = $attributes['authorType'];
+	$is_columns          = 'columns' === $attributes['layout'];
+	$number_of_columns   = $attributes['columns'];
+	$show_separators     = $attributes['showSeparators'];
+	$separator_sections  = $attributes['separatorSections'];
+	$avatar_hide_default = $attributes['avatarHideDefault'];
+	$params              = [
+		'author_type'  => $author_type,
+		'author_roles' => $author_roles,
+		'exclude'      => $exclude_ids, // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_exclude
+		'fields'       => [ 'id', 'name', 'bio', 'email', 'social', 'avatar', 'url' ],
+	];
+
+	if ( $exclude_empty ) {
+		$params['exclude_empty'] = true;
+	}
+
+	if ( $avatar_hide_default ) {
+		$params['avatar_hide_default'] = true;
+	}
+
+	$author_list_controller = new WP_REST_Newspack_Author_List_Controller();
+	$authors                = $author_list_controller->get_all_authors( $params );
+
+	$anchor_id = uniqid();
+
+	if ( empty( $authors ) ) {
+		return;
+	}
+
+	// Enqueue required front-end assets.
+	Newspack_Blocks::enqueue_view_assets( 'author-list' );
+	Newspack_Blocks::enqueue_view_assets( 'author-profile' );
+
+	// Class names for the list container.
+	$container_classes = [ 'newspack-blocks__author-list-container' ];
+	if ( $is_columns ) {
+		$container_classes[] = 'is-columns';
+		$container_classes[] = 'columns-' . (string) $number_of_columns;
+	}
+
+	ob_start();
+	?>
+	<div class="wp-block-newspack-blocks-author-list <?php echo esc_attr( $attributes['className'] ); ?>">
+
+	<?php
+	// Columns WITH alphabetical separator sections.
+	if ( $is_columns && $show_separators && $separator_sections ) :
+		// Associative array to store authors chunked by alphabet, if separatorSections is true.
+		$chunked_authors = [];
+		foreach ( $authors as $author ) {
+			$first_letter = strtoupper( substr( $author['last_name'], 0, 1 ) );
+			if ( ! isset( $chunked_authors[ $first_letter ] ) ) {
+				$chunked_authors[ $first_letter ] = [];
+			}
+			$chunked_authors[ $first_letter ][] = $author;
+		}
+
+		foreach ( $chunked_authors as $separator_letter => $separator_authors ) :
+			?>
+			<h2
+				class="newspack-blocks__author-list-separator"
+				id="newspack-blocks__author-list-separator__<?php echo esc_attr( $anchor_id ); ?>__<?php echo esc_attr( $separator_letter ); ?>"
+			>
+				<?php echo esc_html( $separator_letter ); ?>
+			</h2>
+			<ul class="<?php echo esc_attr( implode( ' ', $container_classes ) ); ?>">
+				<?php
+				foreach ( $separator_authors as $author ) :
+					$author_card = Newspack_Blocks::template_include(
+						'author-profile-card',
+						[
+							'attributes' => $attributes,
+							'author'     => $author,
+						]
+					);
+					?>
+					<li class="newspack-blocks__author-list-item">
+						<?php echo wp_kses_post( $author_card ); ?>
+					</li>
+				<?php endforeach; ?>
+			</ul>
+		<?php endforeach; ?>
+		<?php
+		// List view or columns without alphabetical separator sections.
+	else :
+		$separators = [];
+		?>
+
+		<ul class="<?php echo esc_attr( implode( ' ', $container_classes ) ); ?>">
+			<?php
+			foreach ( $authors as $author ) :
+				$first_letter   = strtoupper( substr( $author['last_name'], 0, 1 ) );
+				$show_separator = ! in_array( $first_letter, $separators, true );
+
+				if ( $show_separator ) {
+					$separators[] = $first_letter;
+				}
+
+				$author_card = Newspack_Blocks::template_include(
+					'author-profile-card',
+					[
+						'attributes' => $attributes,
+						'author'     => $author,
+					]
+				);
+
+				if ( $show_separators && $show_separator ) :
+					?>
+					<li class="newspack-blocks__author-list-item">
+						<h2
+							class="newspack-blocks__author-list-separator"
+							id="newspack-blocks__author-list-separator__<?php echo esc_attr( $anchor_id ); ?>__<?php echo esc_attr( $first_letter ); ?>"
+						>
+							<?php echo esc_html( $first_letter ); ?>
+						</h2>
+					</li>
+				<?php endif; ?>
+				<li class="newspack-blocks__author-list-item">
+					<?php echo wp_kses_post( $author_card ); ?>
+				</li>
+			<?php endforeach; ?>
+		</ul>
+	<?php endif; ?>
+	</div>
+	<?php
+
+	return ob_get_clean();
+}
+
+add_action( 'init', 'newspack_blocks_register_author_list' );

package/src/blocks/author-list/view.scss

@@ -0,0 +1,46 @@
+.wp-block-newspack-blocks-author-list {
+	.newspack-blocks__author-list-container {
+		list-style: none;
+		margin-left: 0;
+		margin-right: 0;
+		padding-left: 0;
+		padding-right: 0;
+
+		.newspack-blocks__author-list-item {
+			display: inline-block;
+			margin-bottom: 2.5rem;
+			width: 100%;
+		}
+	}
+
+	.is-columns {
+		column-width: auto;
+		page-break-inside: avoid;
+		break-inside: avoid;
+	}
+
+	.columns-2 {
+		column-count: 2;
+	}
+
+	.columns-3 {
+		column-count: 3;
+	}
+
+	.columns-4 {
+		column-count: 4;
+	}
+
+	.columns-5 {
+		column-count: 5;
+	}
+
+	.columns-6 {
+		column-count: 6;
+	}
+
+	h2.newspack-blocks__author-list-separator {
+		margin-bottom: 0;
+		margin-top: 0;
+	}
+}

package/src/blocks/author-profile/block.json

@@ -26,6 +26,10 @@
 			"type": "boolean",
 			"default": true
 		},
+		"textSize": {
+			"type": "string",
+			"default": "medium"
+		},
 		"showAvatar": {
 			"type": "boolean",
 			"default": true
@@ -41,6 +45,10 @@
 		"avatarSize": {
 			"type": "number",
 			"default": 128
+		},
+		"avatarHideDefault": {
+			"type": "boolean",
+			"default": false
 		}
 	}
 }

package/src/blocks/author-profile/class-wp-rest-newspack-authors-controller.php

@@ -66,11 +66,13 @@ class WP_REST_Newspack_Authors_Controller extends WP_REST_Controller {
 	 * @return WP_REST_Response
 	 */
 	public function get_authors( $request ) {
-		$author_id = ! empty( $request->get_param( 'author_id' ) ) ? $request->get_param( 'author_id' ) : 0; // Fetch a specific user or guest author by ID.
-		$search    = ! empty( $request->get_param( 'search' ) ) ? $request->get_param( 'search' ) : null; // Fetch authors by search string.
-		$offset    = ! empty( $request->get_param( 'offset' ) ) ? $request->get_param( 'offset' ) : 0; // Offset results (for pagination).
-		$per_page  = ! empty( $request->get_param( 'per_page' ) ) ? $request->get_param( 'per_page' ) : 10; // Number of results to return per page. This is applied to each query, so the actual number of results returned may be up to 2x this number.
-		$fields    = ! empty( $request->get_param( 'fields' ) ) ? explode( ',', $request->get_param( 'fields' ) ) : [ 'id' ]; // Fields to get. Will return at least id.
+		$author_id           = ! empty( $request->get_param( 'authorId' ) ) ? $request->get_param( 'authorId' ) : 0; // Fetch a specific user or guest author by ID.
+		$search              = ! empty( $request->get_param( 'search' ) ) ? $request->get_param( 'search' ) : null; // Fetch authors by search string.
+		$offset              = ! empty( $request->get_param( 'offset' ) ) ? $request->get_param( 'offset' ) : 0; // Offset results (for pagination).
+		$per_page            = ! empty( $request->get_param( 'perPage' ) ) ? $request->get_param( 'perPage' ) : 10; // Number of results to return per page. This is applied to each query, so the actual number of results returned may be up to 2x this number.
+		$avatar_hide_default = ! empty( $request->get_param( 'avatarHideDefault' ) ) ? true : false; // Hide the default avatar if the user has no custom avatar.
+		$fields              = ! empty( $request->get_param( 'fields' ) ) ? explode( ',', $request->get_param( 'fields' ) ) : [ 'id' ]; // Fields to get. Will return at least id.
+		$include             = ! empty( $request->get_param( 'include' ) ) ? explode( ',', $request->get_param( 'include' ) ) : null; // Fetch authors by multiple IDs.
 
 		// Total number of users and guest authors.
 		$guest_author_total = 0;
@@ -89,13 +91,33 @@ class WP_REST_Newspack_Authors_Controller extends WP_REST_Controller {
 		if ( $author_id ) {
 			$guest_author_args['p'] = $author_id;
 		}
+		if ( $include ) {
+			$guest_author_args['post__in']            = $include;
+			$guest_author_args['ignore_sticky_posts'] = true;
+		}
 
-		$guest_authors      = new \WP_Query( $guest_author_args );
-		$guest_author_total = $guest_authors->found_posts;
+		$guest_authors      = get_posts( $guest_author_args );
+		$guest_author_total = count( $guest_authors );
+		$users              = [];
 
-		// Get standard WP users.
+		// If passed an author ID.
 		if ( $author_id ) {
-			$users = 0 === $guest_author_total ? [ get_user_by( 'id', $author_id ) ] : []; // If passed an author_id and we already found it as guest author, no need to run this query.
+			if ( 0 === $guest_author_total ) {
+				$user = get_user_by( 'id', $author_id ); // Get the WP user.
+
+				// We have a WP user, let's use it.
+				if ( $user ) {
+					// But wait, there's more! Let's see if this user is linked to a guest author.
+					$linked_guest_author = self::get_linked_guest_author( $user->user_login );
+
+					// If it is, let's use that instead.
+					if ( $linked_guest_author ) {
+						$guest_authors = [ $linked_guest_author ];
+					} else {
+						$users = [ $user ];
+					}
+				}
+			}
 		} else {
 			$user_args = [
 				'role__in' => [ 'Administrator', 'Editor', 'Author', 'Contributor' ],
@@ -110,6 +132,11 @@ class WP_REST_Newspack_Authors_Controller extends WP_REST_Controller {
 				$user_args['search'] = '*' . $search . '*';
 			}
 
+			// If passed an array of IDs.
+			if ( $include ) {
+				$user_args['include'] = $include;
+			}
+
 			$user_query = new \WP_User_Query( $user_args );
 			$users      = $user_query->get_results();
 			$user_total = $user_query->get_total();
@@ -118,8 +145,8 @@ class WP_REST_Newspack_Authors_Controller extends WP_REST_Controller {
 		// Format and combine results.
 		$combined_authors = array_merge(
 			array_reduce(
-				! empty( $guest_authors->posts ) ? $guest_authors->posts : [],
-				function( $acc, $guest_author ) use ( $fields ) {
+				! empty( $guest_authors ) ? $guest_authors : [],
+				function( $acc, $guest_author ) use ( $fields, $avatar_hide_default ) {
 					if ( $guest_author ) {
 						if ( class_exists( 'CoAuthors_Guest_Authors' ) ) {
 							$guest_author_data = [
@@ -147,7 +174,11 @@ class WP_REST_Newspack_Authors_Controller extends WP_REST_Controller {
 								}
 							}
 							if ( in_array( 'avatar', $fields, true ) && function_exists( 'coauthors_get_avatar' ) ) {
-								$guest_author_data['avatar'] = coauthors_get_avatar( $guest_author, 256 );
+								$avatar = coauthors_get_avatar( $guest_author, 256 );
+
+								if ( $avatar && ( false === strpos( $avatar, 'avatar-default' ) || ! $avatar_hide_default ) ) {
+									$guest_author_data['avatar'] = $avatar;
+								}
 							}
 							if ( in_array( 'url', $fields, true ) ) {
 								$guest_author_data['url'] = esc_urL(
@@ -167,7 +198,7 @@ class WP_REST_Newspack_Authors_Controller extends WP_REST_Controller {
 			),
 			array_reduce(
 				$users,
-				function( $acc, $user ) use ( $fields ) {
+				function( $acc, $user ) use ( $fields, $avatar_hide_default ) {
 					if ( $user ) {
 						$user_data = [
 							'id'         => intval( $user->data->ID ),
@@ -192,7 +223,11 @@ class WP_REST_Newspack_Authors_Controller extends WP_REST_Controller {
 							}
 						}
 						if ( in_array( 'avatar', $fields, true ) ) {
-							$user_data['avatar'] = get_avatar( $user->data->ID, 256 );
+							$avatar = get_avatar( $user->data->ID, 256 );
+
+							if ( $avatar && ( false === strpos( $avatar, 'avatar-default' ) || ! $avatar_hide_default ) ) {
+								$user_data['avatar'] = $avatar;
+							}
 						}
 						if ( in_array( 'url', $fields, true ) ) {
 							$user_data['url'] = esc_urL( get_author_posts_url( $user->data->ID ) );
@@ -223,6 +258,26 @@ class WP_REST_Newspack_Authors_Controller extends WP_REST_Controller {
 		return rest_ensure_response( $response );
 	}
 
+	/**
+	 * Given a WP user login, get the linked guest author, if any.
+	 *
+	 * @param string $user_login WP user login name.
+	 *
+	 * @return WP_Post|boolean Linked guest author in post form, or false if none.
+	 */
+	public static function get_linked_guest_author( $user_login ) {
+		$linked_guest_authors = get_posts(
+			[
+				'post_type'      => 'guest-author',
+				'posts_per_page' => 1,
+				'meta_key'       => 'cap-linked_account', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
+				'meta_value'     => $user_login, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value
+			]
+		);
+
+		return 0 < count( $linked_guest_authors ) ? reset( $linked_guest_authors ) : false;
+	}
+
 	/**
 	 * Get author email address and SVG icon, if available.
 	 *