Download the PHP package pfaciana/brain-monkey-doubles without Composer

On this page you can find all versions of the php package pfaciana/brain-monkey-doubles. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of pfaciana/brain-monkey-doubles

Informations about the package brain-monkey-doubles

Brain Monkey Doubles

Testing a WordPress plugin without booting WordPress means faking the WP functions and hooks your code calls. Brain Monkey is the standard library for that. Brain Monkey Doubles fills two gaps it leaves:

Brain Monkey basics: it stubs WordPress functions with when(), asserts calls with expect(), and tracks hooks with Filters\expectApplied / Actions\expectDone — all without loading WordPress. See its docs.

Installing

Requires PHP ≥ 8.1 and brain/monkey ^2.7. Examples below use Pest 4.

Setting up

Wire it into your test bootstrap. Doubles::setUp() runs before Monkey\setUp(), and teardown unwinds in reverse. This enables every double; the function helpers below also work under plain Brain Monkey.

Order matters. Doubles::setUp() defines add_filter and friends itself. Call it after Monkey\setUp() (or with real WordPress loaded) and it throws RuntimeException because add_filter already exists.

Process isolation

Brain Monkey Doubles defines WordPress hook functions such as add_filter() and apply_filters() in PHP's global namespace. PHP cannot unload global functions once they are defined, so Doubles::tearDown() resets hook state but does not remove those functions.

Do not bootstrap real WordPress later in the same PHP process after enabling Doubles. If a suite mixes Brain Monkey tests and real WordPress integration tests, run them in separate PHPUnit/Pest processes, separate commands, or separate CI jobs.

Doubling functions

Brain Monkey's when() and expect() don't compose: once when() stubs a function, calling expect() on that same function silently no-ops — the mock is never routed, so the assertion fails quietly at teardown. These two helpers fix that. Import the namespace:

Helper vs Brain Monkey Why it exists
stub($name) a re-callable alias of Functions\when() a later layer (a file's beforeEach) overrides an earlier global one
expect($name) Functions\expect() that survives a stub forces the Patchwork re-route BM skips once when() owns the function

stub() sets a function's baseline, and it's re-callable — define broad defaults globally, then override them in a narrower scope. It returns Brain Monkey's FunctionStub, so the full when() API works: justReturn(), returnArg(), alias(), justEcho(), echoArg().

Scope Helper Purpose
Global beforeEach stub() baseline behavior for all tests
File beforeEach stub() again override it for one file
it() expect() assert calls/args for one test

expect() asserts a function even when a stub() / when() baseline already exists, and returns the Mockery expectation for chaining:

Heads-up: call Functions\expect() (namespace-qualified), never use function BrainMonkey\Functions\expect;. A bare function import shadows Pest's global expect() and breaks every expect()->toBe() in the file.

Caveat: once asserted this way, the function is fully owned by the mock for the rest of the test — the when() baseline no longer answers other arguments.

Doubling hooks

The 'hooks' double runs your registered callbacks for real — vanilla Brain Monkey records hooks but never fires them. So your plugin's hooks behave in a test the way they do in WordPress.

Say your plugin registers a filter:

Load it before each test. From here the test bodies only fire hooks and assert — add_filter stays in the plugin, where it belongs:

A filter actually runs. Fire it; your callback transforms the value:

Assert it was applied. expectApplied is the everyday check — was the filter applied, with these args:

Check it's wired up — without running it. has_filter asks only whether the hook was registered:

Count how many times it ran. did_filter returns the number of times the hook fired:

Actions mirror filters: add_action / do_action, asserted with Actions\expectDone, counted with did_action.

vs vanilla Brain Monkey

Call Vanilla Brain Monkey Brain Monkey Doubles
add_filter / add_action recorded, callback never runs recorded and registered to run
apply_filters returns input unchanged runs the real callback chain
do_action no-op (counts only) runs the real callbacks
expectApplied()->andReturn() overrides the return overrides the return (callbacks skipped)
has_filter / did_action / current_filter partial full WP behavior

Covered functions

The full WordPress hook API is shimmed. Each is defined only if it doesn't already exist, so a real WP function of the same name wins.

Filters

Function Behavior
add_filter($hook, $cb, $priority = 10, $accepted_args = 1) Registers $cb in real WP_Hook; tracked as added
apply_filters($hook, $value, ...$args) Runs the callback chain; return expectation overrides
apply_filters_ref_array($hook, $args) Same, args passed as an array
has_filter($hook, $cb = false, $priority = false) Real registration check (priority or bool)
remove_filter($hook, $cb, $priority = 10) Removes from WP_Hook; tracked as removed
remove_all_filters($hook, $priority = false) Clears callbacks and Brain Monkey's added-records
current_filter() / doing_filter($hook = null) Current hook name / is-it-running
did_filter($hook) Times applied
apply_filters_deprecated($hook, $args, $version, ...) Tracked + applied even with no callbacks

Actions

Function Behavior
add_action($hook, $cb, $priority = 10, $accepted_args = 1) Like add_filter
do_action($hook, ...$args) Runs callbacks, increments count, tracked as done
do_action_ref_array($hook, $args) Same, args passed as an array
has_action($hook, $cb = false, $priority = false) Alias of has_filter
remove_action($hook, $cb, $priority = 10) Removes; tracked as an action removal
remove_all_actions($hook, $priority = false) Clears callbacks + added-records
current_action() / doing_action($hook = null) Aliases of current_filter / doing_filter
did_action($hook) Times fired
do_action_deprecated($hook, $args, $version, ...) Tracked + fired even with no callbacks

The special all hook also runs before the named hook for apply_filters, apply_filters_ref_array, do_action, and do_action_ref_array, using WordPress's direct-call and ref-array argument shapes.

remove_action and remove_filter track separately: a filter-removal expectation won't be satisfied by remove_action, and vice versa.

Asserting WP functions vs Expecting Brain Monkey methods

Filters\ WP equivalent Actions\ WP equivalent Args
expectAdded() add_filter() expectAdded() add_action() $hook_name
expectApplied() apply_filters() expectDone() do_action() $hook_name
doing() doing_filter() doing() doing_action() $hook_name
applied() did_filter() did() did_action() $hook_name
expectRemoved() remove_filter() expectRemoved() remove_action() $hook_name
has() has_filter() has() has_action() $hook_name, $cb, $priority

Reference

BrainMonkey\Doubles is the facade for the WordPress doubles. setUp()'s argument selects which to enable — the extension point for future doubles; 'hooks' is the only one today. (The BrainMonkey\Functions helpers above are independent and need only Brain Monkey.)

Method Does
Doubles::setUp(array $doubles = ['hooks']) Enable doubles. Throws on an unknown name
Doubles::tearDown() Clear hook state and disable all doubles
Doubles::reset() Clear hook state between tests, keep doubles enabled
Doubles::isEnabled(string $double): bool Whether a double is on

Call Doubles::setUp() before Monkey\setUp() — it throws RuntimeException if add_filter is already defined.

All versions of brain-monkey-doubles with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
brain/monkey Version ^2.7
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package pfaciana/brain-monkey-doubles contains the following files

Loading the files please wait ...