Hooks reference: actions

Last updated Oct 3, 20268 min read

All hooks are named wpmcf/{area}/{event}. This page lists the actions (things that happened, or places to add something). Filters are on Hooks reference: filters.

Plan tells which build fires the hook. Free hooks are in every build. Pro hooks exist only in builds that contain Pro code and fire only on a licensed or trial site (their features are described in the plans).
Arguments are listed in order. Always declare the number of arguments you use: add_action( 'wpmcf/...', $callback, 10, 2 ).
A listener that throws is caught by the plugin's fault guard for plugin-owned listeners only. Write your own callbacks defensively: an exception in a callback of yours can interrupt the request that fired the hook.
Actions that exist for registration (register_pages, variables/register, field_types/register ...) fire once per request when the registry is first used. Attach your listener early (when your plugin file loads, or on plugins_loaded).

Lifecycle

Hook	Plan	Arguments	Fires
`wpmcf/booted`	Free	`Plugin $plugin`	After every module has registered and booted (on `plugins_loaded`, priority 10). The plugin's services are ready.
`wpmcf/activate`	Free	none	On plugin activation, after the database schema and settings are set up.
`wpmcf/deactivate`	Free	none	On plugin deactivation, after scheduled actions are removed and rewrite rules flushed.

php

add_action( 'wpmcf/booted', function () {
    // wpmcf_get_field() and the other functions are ready from here.
} );

Variables

`wpmcf/variables/register`


Plan	Free
Arguments	`VariableRegistry $registry`
Fires	Once, when the variable registry is first built after boot (or at `wpmcf/booted` priority 99 if the registry was built earlier).
Use	Add namespaces, filters and functions.

php

add_action( 'wpmcf/variables/register', function ( $registry ) {
    $registry->registerFilter( 'shout', fn ( $v ) => strtoupper( (string) $v ) . '!' );
} );

Full example: PHP API. A listener attached after the registry was built never runs; register on wpmcf_variable_registry() directly instead.

Admin screens

Hook	Plan	Arguments	Fires
`wpmcf/admin/register_pages`	Free	`AdminPageRegistry $registry`	While the plugin builds its admin menu. Add a screen with `$registry->add( new AdminPage( … ) )`. The first registration of an ID wins.
`wpmcf/admin/enqueue_page`	Free	`AdminPage $page`	After a plugin screen's script has been enqueued and `wpmcfData` localized. Add scripts that extend that screen (for example Pro settings tabs).
`wpmcf/admin/search_sources`	Free	`SearchRegistry $registry`	On each request of the header search (`GET wpmcf/v1/admin/search`). Add a source with `$registry->add( $id, $label, callable )`; the callable returns `SearchItem` objects (title, URL, meta). At most 5 matches per source are shown.
`wpmcf/settings/register_sections`	Free	`SettingsSectionRegistry $sections`	When the Settings screen data is built. `$sections->add( $id, $label, $position = 50 )` adds a tab (its contents come from the JS filter `wpmcf.settings.tabs`).

php

add_action( 'wpmcf/admin/enqueue_page', function ( $page ) {
    if ( $page->id === 'settings' ) {
        wp_enqueue_script( 'my-settings-tab', plugins_url( 'tab.js', __FILE__ ), [ 'wp-hooks' ], '1.0', true );
    }
} );

Database

Hook	Plan	Arguments	Fires
`wpmcf/database/migration_ran`	Free	`string $id`, `int $batch`	After one migration's `up()` has run and been recorded.
`wpmcf/database/migration_rolled_back`	Free	`string $id`	After a migration's `down()` has run.

Field types, field groups and fields

Hook	Plan	Arguments	Fires
`wpmcf/field_types/register`	Free	`FieldTypeRegistry $registry`	When the field type registry loads (first use in a request), after the built-in types. `$registry->add( $type )` or `$registry->define( $id, fn () => $type )` (built on first use).
`wpmcf/field_groups/changed`	Free	`string $key`, `string $prefix`	After a field group definition is saved or deleted. `$key` is the group key; `$prefix` is the settings-key prefix of the store (`field_group_` for field groups). Cached definitions were already invalidated.
`wpmcf/field_groups/register`	Free	none	Once per request, when code-registered field groups are collected. Call `wpmcf_register_field_group( array )` inside it.
`wpmcf/fields/copy_object`	Free	`int $from_id`, `int $to_id`	Listened to by the plugin, not fired by it. Fire it from a duplicate-post tool to copy the field rows of one post to another.

php

// After your plugin duplicates a post:
do_action( 'wpmcf/fields/copy_object', $original_id, $copy_id );

Post types, taxonomies and options pages

Hook	Plan	Arguments	Fires
`wpmcf/post_types/before_register`	Free	`string $name`, `array $definition`	Just before a stored post type is passed to `register_post_type()`.
`wpmcf/post_types/after_register`	Free	`string $name`, `array $definition`	Right after it was registered.
`wpmcf/post_types/changed`	Free	`string $name`	After a post type definition is saved or deleted.
`wpmcf/taxonomies/before_register`	Free	`string $name`, `array $definition`	Just before `register_taxonomy()`. Not fired when the taxonomy already exists.
`wpmcf/taxonomies/after_register`	Free	`string $name`, `array $definition`	Right after it was registered.
`wpmcf/taxonomies/changed`	Free	`string $name`	After a taxonomy definition is saved or deleted.
`wpmcf/options_pages/changed`	Free	`string $slug`	After an options page definition is saved or deleted.
`wpmcf/options_pages/values_saved`	Free	`string $slug`, `array $result`	After values on an options page were stored: on the options page screen (when at least one group saved) and by `wpmcf_update_option_field()` (once per page that shows the group). `$result` is `['page' => string, 'saved' => int, 'failed' => string[] group labels, 'missing' => string[]]`.

php

add_action( 'wpmcf/post_types/after_register', function ( $name, $definition ) {
    if ( $name === 'book' ) {
        add_post_type_support( 'book', 'page-attributes' );
    }
}, 10, 2 );

Global Data

Hook	Plan	Arguments	Fires
`wpmcf/global_data/saved`	Free	`array $variables`	After Global Data was saved on its screen or with `wpmcf_update_global()`. `$variables` is the full list of variables as stored (key, label, type, value, ...). Page caches are cleared from this signal.

Page cache purging

The plugin purges the page caches of WP Rocket, LiteSpeed Cache, W3 Total Cache, WP Super Cache, WP Fastest Cache, SiteGround Optimizer, Breeze and WP Engine after content it controls changes. You can feed that mechanism or follow it.

Hook	Plan	Arguments	Fires
`wpmcf/cache/purge`	Free (also fired by Pro)	`string\|string[] $urls`	Listened to by the plugin, and fired by Programmatic SEO when generated pages change. Fire it to purge URLs; with an empty list or no argument everything is purged. Calls are collected and sent once at the end of the request.
`wpmcf/cache/purge_post`	Free (also fired by Pro)	`int $post_id`	Listened to by the plugin; fired after a value of a post is written with `wpmcf_update_field()` and after a pSEO page is converted. Purges that post's permalink.
`wpmcf/cache/purged`	Free	`string[] $urls`, `bool $all`	After the page caches were asked to purge. `$urls` is empty when `$all` is `true`.

php

do_action( 'wpmcf/cache/purge', [ home_url( '/pricing/' ) ] );   // one URL
do_action( 'wpmcf/cache/purge' );                                // everything

Turn the whole mechanism off with the wpmcf/cache/enabled filter or the Settings option.

Background tasks

Tasks are the plugin's background jobs (imports, schema changes, Pro generation runs). Each fires after it happens; none of them changes the outcome.

Hook	Plan	Arguments	Fires
`wpmcf/tasks/finished`	Free	`int $task_id`, `string $type`, `array $state`	When a task finished all its batches. `$state` is the final state its handler returned.
`wpmcf/tasks/failed`	Free	`int $task_id`, `string $type`, `string $message`, `TaskDTO $task`	When a task failed for good (out of retry attempts). `$task` is the task as it was before the failure was stored.
`wpmcf/tasks/deleted`	Free	`int $task_id`, `string $type`, `TaskDTO $task`	After a task was deleted, even in the middle of a run. A handler removes what the run left behind (files, working tables).

Admin columns

Hook	Plan	Arguments	Fires
`wpmcf/admin_columns/registered`	Free	`AdminColumns $columns`, `string $kind`, `string $subtype`	After field columns were added to a list table. `$kind` is `post`, `term` or `user`; `$subtype` is the post type or taxonomy (empty for users). Extensions attach their own list tools here.

Page builders

Hook	Plan	Arguments	Fires
`wpmcf/builders/components`	Free	`ComponentRegistry $registry`	The first time the builder component registry is used. `$registry->add( $component )` adds a component to every supported builder.

Forms (Pro)

Hook	Plan	Arguments	Fires
`wpmcf/forms/submitted`	Pro	`FormDTO $form`, `int $object_id`, `string $kind`	After a front-end form stored its entry and sent its notification. `$object_id` is the post, user or data table row ID. `$kind` is `post`, `user_profile`, `user_register` or `entry`.
`wpmcf/forms/connected_submission`	Pro	`ConnectionDTO $connection`, `int $row_id`, `Submission $submission`	After a submission of another form plugin (Gravity Forms, Contact Form 7, WPForms, Fluent Forms) was stored in a data table through a connection.

php

add_action( 'wpmcf/forms/submitted', function ( $form, $object_id, $kind ) {
    if ( $kind === 'entry' ) {
        wp_mail( get_option( 'admin_email' ), 'New entry', 'Row ' . $object_id );
    }
}, 10, 3 );

Data tables (Pro)

Hook	Plan	Arguments	Fires
`wpmcf/data_tables/row_saved`	Pro	`string $table_key`, `int $row_id`, `string $operation`, `string $origin`	After a row was inserted or updated. `$operation` is `insert` or `update`; `$origin` is `api`, `admin`, `form`, `connection` or `pseo`.
`wpmcf/data_tables/rows_deleted`	Pro	`string $table_key`, `int[] $ids`	After rows were deleted. `$ids` is empty when the table was emptied.
`wpmcf/data_tables/synced`	Pro	`string $table_key`, `array $summary`	After a CSV import or a feed sync finished. `$summary` is `['type' => ..., 'mode' => ..., 'rows' => int, 'failed' => int]` (a feed adds its type, an import has type `import`). Generation tasks that read the table update their pages.
`wpmcf/data_tables/deleted`	Pro	`string $table_key`	After a data source and its table were deleted. Modules drop what they stored for it (for example its feed).

Programmatic SEO (Pro)

Hook	Plan	Arguments	Fires
`wpmcf/pseo/run_finished`	Pro	`int $task_id`, `array $summary`	A generation run completed. `$summary` has `created`, `updated`, `unchanged`, `conflicts`, `shadowed`, `removed`, `limited` (counts) and `finished_at` (UTC). AI enrichment starts from this signal.
`wpmcf/pseo/pages_changed`	Pro	`string[] $paths`	Generated pages changed outside a run (status, hand edits, a source row, AI text). `$paths` lists changed page paths; empty means "unknown, treat everything as changed". Caches are cleared from this signal.
`wpmcf/pseo/pages_deleted`	Pro	`int $task_id`	All generated pages of a task were removed because the task was reset or its identity changed.
`wpmcf/pseo/task_deleted`	Pro	`int $task_id`	A task and its pages were deleted.
`wpmcf/pseo/page_converted`	Pro	`int $post_id`, `int $page_id`	A generated page became a regular post.
`wpmcf/pseo/page_served`	Pro	`VirtualPage $page`	A generated page is being served (status 200 sent). The multilingual module switches language here.

php

add_action( 'wpmcf/pseo/page_converted', function ( $post_id, $page_id ) {
    update_post_meta( $post_id, '_converted_from_pseo', $page_id );
}, 10, 2 );

Internal scheduled actions

These are Action Scheduler hooks the plugin schedules for its own batches (group wpmcf). They are listed so you recognize them in Tools › Scheduled Actions. Do not call or remove them.

Hook	Argument	Runs
`wpmcf/tasks/run`	task ID	One batch of a background task
`wpmcf/tasks/watchdog`	none	Every 15 minutes: re-queues active tasks whose run was cut off
`wpmcf/fields/schema_change`	field group key	A large table change that runs in the background
`wpmcf/field_groups/code_sync`	none	Imports code-registered field groups when their hash changed
`wpmcf/acf/migrate`	none	The ACF migration

wpmcf_fs_loaded is fired by the bootstrap after the Freemius licensing layer has loaded (do_action( 'wpmcf_fs_loaded' )). It uses an underscore, not a slash, because the licensing layer owns it.

Was this page helpful?

Still stuck? Contact support