Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/whatwedo/whatwedo-acf-cleaner

WordPres Plugin: Cleanup old metadata created by Advanced Custom Fields
https://github.com/whatwedo/whatwedo-acf-cleaner

acf acf-field cleaner cleanup metadata plugin wordpress wordpress-plugin wp

Last synced: 9 days ago
JSON representation

WordPres Plugin: Cleanup old metadata created by Advanced Custom Fields

Awesome Lists containing this project

README 

        
=== whatwedo ACF Cleaner ===

Contributors:      whatwedo, marcwieland95, trilliput

Tags:              admin, advanced custom fields, acf, cleanup, cleaner, metadata

Requires at least: 5.5

Tested up to:      6.6.2

Requires PHP:      7.0

Stable tag:        1.2.2

License:           MIT

License URI:       https://opensource.org/licenses/MIT



Cleanup old metadata created by Advanced Custom Fields.



== Description ==



We analyze the post of the selected post types against the ACF groups in use. Afterwards we remove all data from deleted groups.

There's a dry run available (discovery) to see how many fields would get removed. On the actual cleanup you get prompted because it can't be undone (so make a backup first).



== Screenshots ==

1. The option page for the plugin. You can find it in "Tools / ACF Cleaner"

2. On every post type with unused data the following metabox is shown



== Installation ==



The plugin can be found it the WordPress Plugin Directory. Search for "ACF Cleaner".



= Manual Installation =



1. Upload the entire `/wwd-acf-cleaner` directory to the `/wp-content/plugins/` directory.

2. Activate "whatwedo ACF Cleaner" through the 'Plugins' menu in WordPress.

3. Do a database backup manually or use a third party tool

4. Go to "Tools / ACF Cleaner"

4. Select the post types you want to clean and run it



== Frequently Asked Questions ==



= What about conditional fields =

Conditional fields are not taken in account at this point. This is probably also the issue why there's nothing like this baked into the ACF plugin itself. Down the road it gets pretty complex.



= Output the names of the deleted fields =

We are aware that it would be handy to know which exact fields will get deleted, so the user can analyzing the actual data. This could be integrated in a future release.

We already know the name of the fields and we're also returning them from the server. Since they're a lot of unordered data, we don't do something proper with those in the frontend .



= Support more than just post meta =

ACF allows fields for term meta, user meta etc and not just post meta. This plugin only works with post meta for now.

There's a ticket in the WordPress Support page for this: https://wordpress.org/support/topic/support-more-than-just-post-meta/. We're happy to accept pull requests.



== Contribute ==



Developed with ♥ by [whatwedo](https://whatwedo.ch) in Bern.

Thanks to [TrilipuT](https://github.com/TrilipuT) for contributing.



This plugin was initially created for our own usage to clean a big database from old ACF data.



Check out the [GitHub repository](https://github.com/whatwedo/whatwedo-acf-cleaner) and submit pull requests or open issues



== Changelog ==



= 1.2.2 (2024-10-01) =

* Test if everything still works with WordPress 6.6 and PHP 8.3 and bump versions for the WP repo



= 1.2.1 (2023-05-25) =

* Prevent error when no clone field is used (thanks to [melcarthus](https://wordpress.org/support/topic/undefined-array-key-_clone/) for reporting)



= 1.2.0 (2023-04-20) =

* Find more orphans (repeater and clone fields)

* Improve loading of plugin when included via a theme

* Return notice when Advanced Custom Fields is not installed

* Show more CPT in the list (also not public once are visible now)



= 1.1.0 (2022-07-14) =

* Add single post metabox with detailed info for unused fields (thanks to [TrilipuT](https://github.com/TrilipuT))

* More precise unused fields detection added (thanks to [TrilipuT](https://github.com/TrilipuT))

* Add check if Advanced Custom Fields is installed (thanks to [sebastian_a](https://profiles.wordpress.org/sebastian_a/)) for reporting it



= 1.0.0 (2020-02-22) =

* First release