Skip to content

(perf): Register icon collections #527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
firestar300 wants to merge 7 commits into
base: master
Choose a base branch
from
+59 −31
Open

(perf): Register icon collections #527

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fc16a92
refactor(Icon): gate icon hooks on WP 7.1 APIs in boot()
firestar300 Nov 4, 2026
b92149a
fix(Icon): derive icon slugs with sanitize_title()
firestar300 Nov 4, 2026
479331e
perf(Icon): rely on core for SVG file path resolution
firestar300 Nov 4, 2026
d72f966
perf(Icon): cache collection SVG file lists with transients
firestar300 Nov 4, 2026
dd07254
fix(Icon): skip registering collections with no SVG files
firestar300 Nov 4, 2026
a3a176a
refactor(Icon): drop redundant unregister API existence check
firestar300 Nov 4, 2026
bb513f4
perf(Icon): skip SVG list cache via wp_get_development_mode()
firestar300 Nov 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 59 additions & 31 deletions inc/Services/Icon.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ public function register( Service_Container $container ): void {}
* @param Service_Container $container Service container.
*/
public function boot( Service_Container $container ): void {
if ( ! function_exists( 'wp_register_icon_collection' ) || ! function_exists( 'wp_register_icon' ) ) {
return;
}

add_action( 'init', [ $this, 'register_icon_collections' ] );
add_action( 'init', [ $this, 'unregister_core_icon_collection' ], 20 );
}
Expand All @@ -40,10 +44,6 @@ public function get_service_name(): string {
* @return void
*/
public function register_icon_collections(): void {
if ( ! function_exists( 'wp_register_icon_collection' ) || ! function_exists( 'wp_register_icon' ) ) {
return;
}

$collections = apply_filters(
'bff_icon_collections',
[
Expand Down Expand Up @@ -73,10 +73,6 @@ public function register_icon_collections(): void {
* @return void
*/
public function unregister_core_icon_collection(): void {
if ( ! function_exists( 'wp_unregister_icon_collection' ) ) {
return;
}

if ( ! apply_filters( 'bff_unregister_core_icon_collection', true ) ) {
return;
}
Expand All @@ -91,13 +87,21 @@ public function unregister_core_icon_collection(): void {
* @return void
*/
private function register_collection( string $collection_slug, array $collection_args ): void {
if ( ! function_exists( 'wp_register_icon_collection' ) ) {
$source_subdir = isset( $collection_args['source_subdir'] ) ? (string) $collection_args['source_subdir'] : '';

if ( '' === $source_subdir ) {
return;
}

$source_subdir = isset( $collection_args['source_subdir'] ) ? (string) $collection_args['source_subdir'] : '';
$icons_directory = $this->resolve_icons_directory( $source_subdir );

if ( '' === $source_subdir ) {
if ( null === $icons_directory ) {
return;
}

$svg_files = $this->get_collection_svg_files( $icons_directory );

if ( [] === $svg_files ) {
return;
}

Expand All @@ -109,21 +113,55 @@ private function register_collection( string $collection_slug, array $collection
]
);

$icons_directory = $this->resolve_icons_directory( $source_subdir );
foreach ( $svg_files as $svg_file ) {
$this->register_icon_file( $collection_slug, $svg_file );
}
}

if ( null === $icons_directory ) {
return;
/**
* Returns SVG file paths for a collection directory, with transient caching outside theme development mode.
*
* @param string $icons_directory Validated absolute path to a collection icons directory.
*
* @return list<string>
*/
private function get_collection_svg_files( string $icons_directory ): array {
if ( in_array( wp_get_development_mode(), [ 'theme', 'all' ], true ) ) {
return $this->glob_svg_files( $icons_directory );
}

$directory_mtime = filemtime( $icons_directory );
if ( false === $directory_mtime ) {
$directory_mtime = 0;
}

$cache_key = 'bff_icon_svg_files_' . md5( $icons_directory . ':' . (string) $directory_mtime );
$cached = get_transient( $cache_key );

if ( is_array( $cached ) ) {
return $cached;
}

$svg_files = $this->glob_svg_files( $icons_directory );

set_transient( $cache_key, $svg_files, WEEK_IN_SECONDS );

return $svg_files;
}

/**
* @param string $icons_directory Validated absolute path to a collection icons directory.
*
* @return list<string>
*/
private function glob_svg_files( string $icons_directory ): array {
$svg_files = glob( $icons_directory . '/*.svg' );

if ( false === $svg_files ) {
return;
return [];
}

foreach ( $svg_files as $svg_file ) {
$this->register_icon_file( $collection_slug, $svg_file );
}
return $svg_files;
}

/**
Expand Down Expand Up @@ -163,18 +201,8 @@ private function resolve_icons_directory( string $source_subdir ): ?string {
* @return void
*/
private function register_icon_file( string $collection_slug, string $svg_file ): void {
if ( ! function_exists( 'wp_register_icon' ) ) {
return;
}

$real_file = realpath( $svg_file );

if ( false === $real_file || ! is_readable( $real_file ) ) {
return;
}

$icon_slug = pathinfo( $real_file, PATHINFO_FILENAME );
$icon_slug = preg_replace( '/[^a-z0-9-]/', '', strtolower( (string) $icon_slug ) );
$icon_slug = pathinfo( $svg_file, PATHINFO_FILENAME );
$icon_slug = sanitize_title( (string) $icon_slug );

if ( '' === $icon_slug ) {
return;
Expand All @@ -192,7 +220,7 @@ private function register_icon_file( string $collection_slug, string $svg_file )
'bff_icon_properties',
[
'label' => $label,
'file_path' => $real_file,
'file_path' => $svg_file,
],
$icon_name,
$collection_slug
Expand Down
Loading