',
'label' => my_fs()->get_text_inline( 'Help Scout', 'helpscout' ),
'desc' => my_fs()->get_text_inline( 'Rendering Help Scout\'s beacon for easy support access', 'permissions-helpscout' ),
'priority' => 16,
);
return $permissions;
}
my_fs()->add_filter( 'permission_list', 'add_helpscount_permission' );
```
note
The `'priority'` parameter determines the visual order of the permission on the permissions list. The default permissions priorities are: `5`, `10`, `13`, and `20`. So when using `15`, the SDK will add the permission just before the last one (between permission `13` and `20`).
### `templates/connect.php`[](#templatesconnectphp "Direct link to templatesconnectphp")
Filters the HTML of the opt-in screen. This is a powerful filter that allows you to fully customize the opt-in screen.
```
function change_file_template_connect( $html ) {
$html .= 'Some custom HTML added to the opt-in screen
';
return $html;
}
my_fs()->add_filter( 'templates/connect.php', 'change_file_template_connect' );
```
## Actions Hooks[](#actions-hooks "Direct link to Actions Hooks")
Actions enable developers to execute custom code at specific points during the product’s execution. To add an action, use the following method from the Freemius instance:
```
my_fs()->add_action( string $tag, callable $function_to_add, $priority = 10, $accepted_args = 1 );
```
This method signature is similar to WordPress' [add\_action](https://developer.wordpress.org/reference/functions/add_action/) function. The following actions are available:
### `after_license_change`[](#after_license_change "Direct link to after_license_change")
Executed after a license change occurs.
```
my_fs()->add_action( 'after_license_change', 'my_fs_log_after_license_change', 10, 2 );
function my_fs_log_after_license_change( $status, $plan ) {
error_log( print_r( 'License status: ' . $status, true ) );
error_log( print_r( 'Plan:', true ) );
error_log( print_r( $plan, true ) );
}
```
### `after_license_activation`[](#after_license_activation "Direct link to after_license_activation")
Executed after a license activation occurs. Example:
```
my_fs()->add_action( 'after_license_activation', 'my_fs_after_license_activation' );
function my_fs_after_license_activation() {
// Handle successful activation.
}
```
On execution, this hook returns two arguments:
* The status as a string, depending on the license change type (e.g., `changed`).
* The plan object with a schema similar to the [retrieve a plan](https://docs.freemius.com/api/plans/retrieve) API endpoint.
### `after_license_deactivation`[](#after_license_deactivation "Direct link to after_license_deactivation")
Executed after a license deactivation occurs. Example:
```
my_fs()->add_action( 'after_license_deactivation', 'my_fs_after_license_deactivation' );
function my_fs_after_license_deactivation( $license ) {
if ( ! empty( $license->id ) ) {
// Success, do something with the license.
} else {
// Failure, handle the error.
// echo $license->error->code;
// echo $license->error->message;
}
}
```
On execution, the hook provides a license object with a schema similar to the [retrieve a license](https://docs.freemius.com/api/licenses/retrieve) API endpoint.
### `after_plans_sync`[](#after_plans_sync "Direct link to after_plans_sync")
Runs after the product's plans are synchronized with Freemius.
### `after_account_details`[](#after_account_details "Direct link to after_account_details")
Triggered after account details on the “Account” page are outputted (before the billing and payments sections).
### `after_account_user_sync`[](#after_account_user_sync "Direct link to after_account_user_sync")
Executed after user account synchronization.
### `after_account_plan_sync`[](#after_account_plan_sync "Direct link to after_account_plan_sync")
Runs after account plan synchronization.
### `before_account_load`[](#before_account_load "Direct link to before_account_load")
Triggered before an account is loaded.
### `after_account_connection`[](#after_account_connection "Direct link to after_account_connection")
Executed after a successful activation connection (when an account is successfully created).
### `account_email_verified`[](#account_email_verified "Direct link to account_email_verified")
Triggered when an account email address is verified.
### `account_page_load_before_departure`[](#account_page_load_before_departure "Direct link to account_page_load_before_departure")
Executed before finishing the loading of the Account page.
### `before_account_delete`[](#before_account_delete "Direct link to before_account_delete")
Runs before an account is deleted.
### `after_account_delete`[](#after_account_delete "Direct link to after_account_delete")
Executed after an account is deleted.
### `sdk_version_update`[](#sdk_version_update "Direct link to sdk_version_update")
Triggered after the SDK version is updated.
### `plugin_version_update`[](#plugin_version_update "Direct link to plugin_version_update")
Executed after the product version is updated.
### `initiated`[](#initiated "Direct link to initiated")
Runs after the Freemius SDK is initialized.
### `after_init_plugin_registered`[](#after_init_plugin_registered "Direct link to after_init_plugin_registered")
Runs after the Freemius SDK is initialized and the user is registered.
### `after_init_plugin_anonymous`[](#after_init_plugin_anonymous "Direct link to after_init_plugin_anonymous")
Runs after the Freemius SDK is initialized and the user is anonymous.
### `after_init_plugin_pending_activations`[](#after_init_plugin_pending_activations "Direct link to after_init_plugin_pending_activations")
Runs after the Freemius SDK is initialized and the user’s activation is pending confirmation.
### `after_init_addon_registered`[](#after_init_addon_registered "Direct link to after_init_addon_registered")
Runs after the Freemius SDK is initialized for an add-on and the user is registered.
### `after_init_addon_anonymous`[](#after_init_addon_anonymous "Direct link to after_init_addon_anonymous")
Runs after the Freemius SDK is initialized for an add-on and the user is anonymous.
### `after_init_addon_pending_activations`[](#after_init_addon_pending_activations "Direct link to after_init_addon_pending_activations")
Runs after the Freemius SDK is initialized for an add-on and the user’s activation is pending confirmation.
### `after_premium_version_activation`[](#after_premium_version_activation "Direct link to after_premium_version_activation")
Triggered after a premium version of the product is activated.
### `after_free_version_reactivation`[](#after_free_version_reactivation "Direct link to after_free_version_reactivation")
Executed after reactivating the free version of the product.
### `after_uninstall`[](#after_uninstall "Direct link to after_uninstall")
Runs after the product is uninstalled.
### `before_admin_menu_init`[](#before_admin_menu_init "Direct link to before_admin_menu_init")
Runs before the product’s menu and submenus are added.
## More action hooks[](#more-action-hooks "Direct link to More action hooks")
We have more action hooks related to the:
* [Opt-In Screen](https://freemius.com/help/help/documentation/wordpress-sdk/customization/opt-in-screen/.md#advanced-opt-in-customization-actions)
## Checking if a hook is registered[](#checking-if-a-hook-is-registered "Direct link to Checking if a hook is registered")
Just like in WordPress core, the Freemius SDK instance provides a `has_filter()` method, which you can use to check whether a specific hook has been registered. This works for both actions and filters. The method signature is:
```
my_fs()->has_filter( string $tag, callable|bool $function_to_check );
```
You can omit the second parameter to check for any registered filter or action.
Awesome Plugin