WP Manifestindependent plugin directory
manifest / developer / block-usage-finder

Block Usage Finder

WordPress debugging tool that lists which blocks are used on which posts, including blocks that are no longer registered.

by Sami Ahmed Siddiqui · github.com/samiahmedsiddiqui/block-usage-finder · website

★ 0stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/samiahmedsiddiqui/block-usage-finder/archive/refs/heads/main.zip
Updates itself. It ships its own updater, so new versions appear under Dashboard → Updates.
Readme github.com/samiahmedsiddiqui/block-usage-finder ↗

A WordPress debugging tool that shows which blocks are used on which posts, including blocks whose plugin or theme code has been removed.

Find it under Tools > Block Usage.

Features

  • Scan one post type or all of them, with a multi-select post status filter (published, draft, private and so on).
  • Includes patterns (synced patterns), navigation menus, templates and template parts. Templates and template parts are listed only when they have been customized and saved in the database.
  • Show only blocks that are not registered, to find content left behind by removed plugins or themes.
  • Optionally include core blocks, which are hidden by default.
  • Filter by block name, sort by name, number of posts or total uses, and group by namespace. These work on the finished scan, with no rescan.
  • Each block lists the posts that use it, how many times, and an edit link. Long lists are collapsed.
  • A totals row shows how many blocks are listed and how many are not registered.
  • Export the listed results as a CSV file, one row per block and post.
  • The scan runs in batches of 100 posts with a progress message and a Stop button, so large sites do not time out.
  • Nested blocks are counted.
  • A WP-CLI command for servers, see below.
  • Scan results are not cached or stored. Each scan reads the current content, and no options are saved.
  • Update notices on the Plugins page come from this repository's releases.

WP-CLI

wp block-usage-finder scan --only-missing
wp block-usage-finder scan --post-type=page --status=publish,draft --block=acf/ --format=csv

Options: --post-type (a post type or all, the default), --status (comma-separated, default publish), --block, --only-missing, --with-core and --format (table, csv, json, yaml or count). It prints one row per block and post.

Requirements

  • WordPress 6.0 or later
  • PHP 7.4 or later
  • A user with the manage_options capability

Installation

  1. Download the latest zip from the releases page.
  2. In WordPress, go to Plugins > Add New Plugin > Upload Plugin, choose the zip and activate it.

The folder inside the zip must be named block-usage-finder. Do not use the green Code > Download ZIP button, because it names the folder block-usage-finder-main.

Updates

The plugin checks this repository's latest release through WordPress's normal update check, so a new release shows as an update on the Plugins page, with one-click and automatic updates. The check is a request to the GitHub API, made when WordPress checks for plugin updates.

To turn it off:

add_filter( 'block_usage_check_updates', '__return_false' );

To update with WP-CLI:

wp plugin install https://github.com/samiahmedsiddiqui/block-usage-finder/releases/latest/download/block-usage-finder.zip --force

Development

composer install
composer lint

License

GPL-2.0-or-later. See LICENSE.