[New block] bookmark and bookmark count #69660

sarthaknagoshe2002 · 2025-03-22T17:19:38Z

What?

This PR adds a bookmarking/favorites system for WordPress posts, allowing users to save posts for later reading. The feature includes:

A Bookmark Block for single posts and Query Loops.
A Counter Block to display the number of saved posts.
A Bookmarks Archive Template to list bookmarked posts.
Support for non-logged-in users via Local storage.

Closes #59524

Why?

Currently, WordPress lacks a built-in way for users to bookmark or favorite posts for later reading. This is an essential feature for content-heavy sites, similar to YouTube’s Watch Later or social media Saved Posts features.

How?

Bookmark Block
- Adds a two-state button (selected/deselected).
- Currently supports 3 icons - heart, bookmark & star ( Icons are aimed to be used as wish list, bookmark or like posts).
- Works inside single posts and Query Loops.
Counter Block
- Displays the number of bookmarked posts.
- Can be placed in menus or elsewhere for quick access.
- Redirects to "/favorites" on click. ( Can be made customisable )
Bookmarks Archive Template
- A dedicated template to list all saved posts.
Support for Non-Logged-In Users
- Uses local storage store bookmarks.
- Doesn't use object storage as a fallback since the interactivity API's state serves the same purpose.
- Ensures visitors can bookmark posts without needing an account.

Testing Instructions

Add the Bookmark Block to a post or Query Loop.
Click the bookmark icon to save/un-save posts.
Add the Counter Block to display the total number of saved posts.
Visit the Bookmarks Archive to view saved posts.
Test functionality for logged-in users and guests.

Note

The choice of icons is subjective & open to all kinds of discussions.
The value of argument $src in wp_register_script() is supposed to be like @wordpress/script_path which didn't seemed to work for me, it will be rectified as per feedback & guidance.
A lot of customisation can be added like the archive URL, More Icons, Post_per_page for the template, Customisable text, Template customisation, etc. But to keep things simple I feel that these customisations can be added later.

Screenshots or screencast

Editor side

editor.mov

Logged out users

Screen.Recording.2025-03-22.at.10.31.41.PM.mov

Logged in users

logged.in.mov

github-actions · 2025-03-22T17:19:54Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @rawdolphe.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Unlinked contributors: rawdolphe.

Co-authored-by: sarthaknagoshe2002 <sarthaknagoshe2002@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: adamsilverstein <adamsilverstein@git.wordpress.org>
Co-authored-by: dhanson-wp <dhansondesigns@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

sarthaknagoshe2002 · 2025-03-24T14:39:54Z

@Mamaduka, @adamsilverstein & @gziolo I’d love to get your feedback on this PR!

Mamaduka · 2025-03-24T15:40:37Z

As far as I'm aware, all the new blocks are on hold for the time being. Please take a look at the discussion in #58773.

sarthaknagoshe2002 · 2025-03-24T17:05:39Z

In looking through past issues and PRs for new blocks added to the default block library, I see that each block is considered individually based on perceived need, functionality, quality, and accessibility. So we're planning to build some of these new blocks first.

@Mamaduka, as I understand it, new blocks—other than those listed in #58773—are not considered a priority since they don’t focus on individual needs. However, I believe these blocks should be included in the list, as they serve important functions and have broad use cases, such as bookmarks or wish lists, which could benefit a wide range of bloggers and large entities like news agencies.

Mamaduka · 2025-03-24T17:10:41Z

@sarthaknagoshe2002, the new block guidelines need to be written/updated. Unfortunately, currently, everyone is busy with the release.

Until such guidelines are published, the referenced issue is all we have, and I would be hesitant to approve new blocks. This doesn't mean that work here should stop; I'm just trying to set the right expectations.

sarthaknagoshe2002 · 2025-03-24T17:14:43Z

@Mamaduka Okay then, in the meantime, we can refine this further and discuss any shortcomings. 😇🙌🏻

Mamaduka

It's been a while since I've built anything similar, but I've left some surface notes regarding the code.

I think the best example of a Likes plugin I can remember in the WP ecosystem is this one - https://github.com/wearerequired/rest-likes. I'm sure we can learn a lot from it. cc @ocean90

Mamaduka · 2025-03-24T17:25:33Z

packages/block-library/src/bookmark/all-bookmarked.php

Sorry, I don't really understand what the point of this page is.

This basically acts like an archive page which would display all the posts bookmarked/liked by the user at a single place

Mamaduka · 2025-03-24T17:27:27Z

packages/block-library/src/bookmark/index.php

+	add_rewrite_rule( '^favorites/?$', 'index.php?pagename=favorites', 'top' );
+	add_rewrite_rule( '^favorites/page/([0-9]+)/?$', 'index.php?pagename=favorites&paged=$matches[1]', 'top' );
+	flush_rewrite_rules();


Block shouldn't register any rewrite rules or flush them. Calling flush_rewrite_rules on init is a bad practice.

Mamaduka · 2025-03-24T17:28:57Z

packages/block-library/src/bookmark/index.php

+function block_core_bookmark_load_favorites_template( $template ) {
+	global $wp;
+	if ( isset( $wp->query_vars['pagename'] ) && 'favorites' === $wp->query_vars['pagename'] ) { // Ensure it's set
+		status_header( 200 );
+		if ( ! is_user_logged_in() ) {
+			wp_register_script( 'core-bookmarks-logged-out-user', '/wp-content/plugins/gutenberg/packages/block-library/src/bookmark/bookmarks-logged-out-user.js', array(), filemtime( '/wp-content/plugins/gutenberg/packages/block-library/src/bookmark/bookmarks-logged-out-user.js' ), true );
+			wp_enqueue_script( 'core-bookmarks-logged-out-user' );
+		}
+		return 'wp-content/plugins/gutenberg/packages/block-library/src/bookmark/all-bookmarked.php';
+	}
+	return $template;
+}
+add_filter( 'template_include', 'block_core_bookmark_load_favorites_template' );


This goes against Site Editor principles, which require a PHP template to display the data.

The issue mentions that this feature should also work for logged out users.
In that case the data will be stored on local storage, which would require a semi-ready template & a JS to read the local storage & add it to the page.

If the Site Editor principles doesn't allow that then what could be a better work around to achieve the aforementioned?

I think Query Block or some other template can be used for logged-in users. If the decision is to introduce a new template, then that should be handled in the core.

Currently, PR seems to be trying to do too much at once. Maybe it's better to start with minimal requirements for the block(s), see if it gets approved and then work on enhancements, like logged-out user support.

Currently, PR seems to be trying to do too much at once.

@sarthaknagoshe2002 maybe you can reduce this PR to just the Bookmark block itself, then have separate PRs for each "feature" on top of that, eg counter block, archive template and non logged in user support.

@adamsilverstein On it! 😇🙌🏻

Mamaduka · 2025-03-24T17:30:05Z

packages/block-library/src/bookmark/index.php

+/**
+ * Sets the page name.
+ *
+ * @since 6.8.0
+ */
+function block_core_bookmark_set_favorites_page_title( $title ) {
+	global $wp;
+	if ( isset( $wp->query_vars['pagename'] ) && 'favorites' === $wp->query_vars['pagename'] ) {
+		$title['title'] = 'Favorite Posts';
+	}
+	return $title;
+}
+add_filter( 'document_title_parts', 'block_core_bookmark_set_favorites_page_title' );


I'm guessing this updates the document title tag. All human-readable user-facing strings need to be translated.

sarthaknagoshe2002 · 2025-04-28T18:12:14Z

As per the feedbacks I have created 3 different PRs for each feature & also addressed a few feedbacks 😇

sarthaknagoshe2002 added 6 commits March 18, 2025 20:17

add both bookmark & bookmark-count blocks

036283f

Fix: update config

f48cdc3

Feat: add fixtures

7bf975b

Fix: Optimize logic & handle edge cases

02d7d35

Fix: handle all post types

787c1dd

Fix: fallback for URL params

58e60e3

sarthaknagoshe2002 requested review from spacedmonkey, ajitbohra, fabiankaegy, juanmaguitar and ndiego as code owners March 22, 2025 17:19

sarthaknagoshe2002 added 2 commits March 22, 2025 23:11

Fix: PHPCS coding standards

59c6dcd

Fix: bookmark-count.json fixture

7c5356f

t-hamano added the New Block Suggestion for a new block label Mar 23, 2025

Mamaduka added the [Type] Enhancement A suggestion for improvement. label Mar 24, 2025

Mamaduka requested changes Mar 24, 2025

View reviewed changes

This was referenced Apr 28, 2025

[New block] bookmark #70010

Open

[New block] bookmark archive #70011

Open

[New block] bookmark count #70012

Open

Mamaduka closed this Apr 29, 2025

[New block] bookmark and bookmark count #69660

[New block] bookmark and bookmark count #69660

Uh oh!

Conversation

sarthaknagoshe2002 commented Mar 22, 2025

What?

Why?

How?

Testing Instructions

Note

Screenshots or screencast

Editor side

Logged out users

Logged in users

Uh oh!

github-actions bot commented Mar 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unlinked Accounts

Uh oh!

sarthaknagoshe2002 commented Mar 24, 2025

Uh oh!

Mamaduka commented Mar 24, 2025

Uh oh!

sarthaknagoshe2002 commented Mar 24, 2025

Uh oh!

Mamaduka commented Mar 24, 2025

Uh oh!

sarthaknagoshe2002 commented Mar 24, 2025

Uh oh!

Mamaduka left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sarthaknagoshe2002 commented Apr 28, 2025

Uh oh!

Uh oh!

github-actions bot commented Mar 22, 2025 •

edited

Loading