soulseekah/metabolic

There is no license information available for the latest version (dev-main) of this package.

A library for locking and mutexes for the WordPress Core

dev-main 2023-12-20 19:33 UTC

Requires

• php: >=7.4

Requires (Dev)

• phpunit/phpunit: ^9
• symfony/phpunit-bridge: ^7.0
• yoast/phpunit-polyfills: ^1.0

Unknown License

README

A WordPress plugin and developer API to optimize post, user, term and comment meta by combining sequential operations into a handful of SQL queries.

Usage

• Install as a WordPress plugin (mu-plugin) or add it to your project as a composer dependency (composer require soulseekah/metabolic).
• Call metabolic\defer_meta_updates().
• Perform a massive amount of meta update operations.
• Call metabolic\commit_meta_updates().
• Enjoy reduced database load.

Tips

• use metabolic\{defer_meta_updates, commit_meta_updates} at the top of your file.

No time to find your hotspots? metabolic\metabolic() will automatically defer (queue) and commit sequential adds, updates and deletes as needed. Boost this up.

API

metabolic\defer_meta_updates( array $args )

metabolic\commit_meta_updates( array $args )

metabolic\flush_meta_updates( array $args )

metabolic\metabolize( bool $activate )

Development

• composer install --dev
• git clone --depth=1 [e-mail]:WordPress/wordpress-develop.git
• cd wordpress-develop && npm i && npm run build:dev; cd ..
• cd wordpress-develop; cp wp-tests-config-sample.php wp-tests-config.php; vim wp-tests-config.php
• set the test database credentials and :wq then cd ..
• make sure the database exists
• vendor/bin/phpunit

TODO

• Concept
• Benchmarks
• Documentation
• Recipes (common hooks to metabolize)
• Tests
• Auto-defer and auto-commit (+ profiler, partial commit short-circuiting)
• i18n