swiftmade/statamic-clear-assets

Deletes unused assets. Saves storage space.

v3.1.0 2024-08-06 09:43 UTC

Requires

• php: ^7.4|^8.0
• laravel/framework: ^7.30.3|^8.24|^9.0|^10.0|^11.0
• statamic/cms: ^3.0.0|^4.0|^5.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.8
• nunomaduro/collision: ^4.1|^5.0|^6.0|^8.1
• orchestra/testbench: ^5.0|^6.0|^7.0|^8.0|^9.0
• phpunit/phpunit: ^9.5|^10.0

MIT

• Ahmet Ozisik

README

Supports Statamic 3, 4 and 5.

Clean up unused images and assets from your Statamic site. Saves storage, keep things tidy.

The addon scans your entire content and users directory. If an asset is not referenced anywhere, it will be marked as unused. You can review the list of unused assets and delete them.

The addon is easy to configure. See the Configuration section below.

How to Install

You can search for this addon in the Tools > Addons section of the Statamic control panel and click install, or run the following command from your project root:

composer require swiftmade/statamic-clear-assets

How to Use

Simply run:

php please assets:clear

It will list all the assets that are not referenced anywhere in your content directory. You can delete them all at once, or one by one.

If you want to skip the interactive mode, you can use the --force flag:

# This will delete all the unused assets without asking for confirmation!
php please assets:clear --force=true

Configuration

To publish the config file, use:

php artisan vendor:publish --tag=statamic-clear-assets-config

Here's all of the configuration options with their defaults:

return [

    /**
     * Where should we look to see if assets are still referenced or not?
     * If you're referencing assets elsewhere in your codebase, add those paths here.
     * All paths are relative to the base_path()
     */
    'scan_folders' => [
        'content',
        'users',
    ],

    /**
     * All assets from these containers will be left alone.
     * You can see all your asset containers under content/assets folder.
     */
    'ignore_containers' => [
        'favicons',
        'social_images',
    ],

    /**
     * If we come across these filenames, we'll just leave them alone.
     * You can use "*" as a wildcard. eg: "IMAGE*.jpg" will ignore IMAGE1.jpg IMAGE23.jpg etc...
     */
    'ignore_filenames' => [
        //
    ],

    /**
     * You might not want to delete very fresh assets, as perhaps you want to use them soon.
     * Use this config to only detect and delete files older than x days.
     */
    'minimum_age_in_days' => 0,
];

Common Questions

It's deleting assets that I'm referencing in my antlers templates!

If you want to ignore the assets referenced in your views, add resources/views to the scan_folders config. Keep in mind that this will only work if the filename is mentioned verbatim in the code. If you are using variables or other logic to reference the asset, the addon might not be able to detect that the asset is being used.

How do I always keep PDF files?

Add *.pdf to the ignore_filenames config.

How do I always keep assets from a specific container?

Add the container's slug to the ignore_containers config.

How do I only delete assets older than 30 days?

Set minimum_age_in_days to 30 in the config.