Melapress

https://melapress.com/support/kb/
Admin
Melapress is a suite of WordPress security plugins including WP Activity Log, WP 2FA, Login...
Tokens:101,758
Snippets:1,115
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Display User 2FA Setup Notice Shortcode

Source: https://melapress.com/support/kb/wp-2fa-configure-2fa-front-end-page-wordpress

Use the [wp-2fa-setup-notice] shortcode to display a notification for users who need to configure Two-Factor Authentication. This notice informs users about the requirement and deadline for 2FA setup, inheriting styles from the theme.

```shortcode
[wp-2fa-setup-notice]
```

--------------------------------

### Customize 2FA Setup Form: Hide Preamble Text

Source: https://melapress.com/support/kb/wp-2fa-configure-2fa-front-end-page-wordpress

This shortcode parameter allows you to hide the default introductory text of the 2FA setup form. By setting `show_preamble` to 'false', you can replace the default text with your own custom messaging, giving you greater control over the user interface and branding of your 2FA configuration page.

```shortcode
[wp-2fa-setup-form show_preamble="false"]
```

--------------------------------

### Enable Login Page Notification using WP CLI

Source: https://melapress.com/support/kb/wp-cli-commands-wp-activity-log

This command enables a notification on the login page to indicate that WSAL is installed. It accepts a boolean to enable/disable and custom text to display. The default text highlights WSAL installation.

```bash
wp wsal_cli_commands login_page_notification --enabled=true --text="Your custom notification message"
```

--------------------------------

### Add 2FA Setup Form to Custom Page using Shortcode

Source: https://melapress.com/support/kb/wp-2fa-configure-2fa-front-end-page-wordpress

This shortcode allows you to embed the WP 2FA setup form directly into your custom user profile or dashboard pages. It provides a seamless way for users to configure their 2FA settings without accessing the WordPress admin area. This is useful for e-commerce sites, membership platforms, or any custom solution.

```shortcode
[wp-2fa-setup-form]
```

--------------------------------

### Customize 2FA Setup Form: Remove 'Currently Configured' Section

Source: https://melapress.com/support/kb/wp-2fa-configure-2fa-front-end-page-wordpress

This shortcode parameter allows you to hide the section that displays the user's currently configured 2FA methods. By setting `do_not_show_enabled` to 'true', you can simplify the form and remove this information if it's not relevant or desired for your specific user experience.

```shortcode
[wp-2fa-setup-form do_not_show_enabled="true"]
```

--------------------------------

### Customize 2FA Wizard Link in Notification Shortcode

Source: https://melapress.com/support/kb/wp-2fa-configure-2fa-front-end-page-wordpress

Specify a custom URL for the 'CONFIGURE 2FA NOW' button within the user 2FA notification shortcode. By adding the 'configure_2fa_url' parameter, you can direct users to a specific page for setup instead of the default wizard.

```shortcode
[wp-2fa-setup-notice configure_2fa_url="<a href="http://domain.com/custom-page">Configure 2FA</a>"]
```

--------------------------------

### Customize 2FA Setup Page Link (PHP)

Source: https://melapress.com/support/kb/wp-2fa-list-hooks

Use the `wp_2fa_setup_page_link` filter to specify a custom redirect URL for 2FA setup. This is useful for role-based redirection or custom front-end setups. The hook receives the default URL and should return the desired URL.

```php
add_filter( 'wp_2fa_setup_page_link', 'my_custom_setup_page_link', 10, 1 );
function my_custom_setup_page_link( $url ) {
    $user = wp_get_current_user();
    if ( in_array( 'author', (array) $user->roles ) ) {
        // The user has the "author" role.
        $url = ‘my-custom-slug’;
    }
    return $url;
}
```

--------------------------------

### Declare Namespace and Include Alert Manager (PHP)

Source: https://melapress.com/support/kb/wp-activity-log-create-custom-events

This snippet demonstrates how to declare the correct namespace and include the Alert Manager class from WP Activity Log at the beginning of a custom sensor file. This is a prerequisite for creating custom sensors.

```php
namespace WSAL\Plugin_Sensors;
use WSAL\Controllers\Alert_Manager;
```

--------------------------------

### Including New Sensor and Alert Files (PHP)

Source: https://melapress.com/support/kb/wp-activity-log-create-custom-events

This PHP code demonstrates how to include new custom sensor and alert files within your extension's main plugin file using WordPress actions. It utilizes require_once and the Classes_Helper::add_to_class_map function to register the new classes.

```php
add_action( 'wsal_sensors_manager_add', 
    /**
     * Adds sensors classes to the Class Helper
     *
     * @return void
     *
     * @since latest
     */
    function() {
        require_once __DIR__ . '/wp-security-audit-log/sensors/class-my-custom-sensor.php';
        Classes_Helper::add_to_class_map(
            array(
                'WSAL\Plugin_Sensors\My_Custom_Sensor' => __DIR__ . '/wp-security-audit-log/sensors/class-my-custom-sensor.php',
            )
        );
    }
);
add_action( 'wsal_custom_alerts_register',
    /**
     * Adds sensors classes to the Class Helper
     *
     * @return void
     *
     * @since latest
     */
    function() {
        require_once __DIR__ . '/wp-security-audit-log/class-my-custom-alerts.php';
        Classes_Helper::add_to_class_map(
            array(
                'WSAL\Custom_Alerts\My_Custom_Alerts' => __DIR__ . '/wp-security-audit-log/class-my-custom-alerts.php',
            )
        );
    }
);
```

--------------------------------

### WP 2FA Hooks

Source: https://melapress.com/support/kb/wp-2fa-list-hooks

This section details the available hooks within the WP 2FA plugin, along with their functions, parameters, and example usage.

```APIDOC
## wp_2fa_custom_setup_page_link

### Description
Use this hook to specify the page where a user should be redirected to when required to setup 2FA based on your own logic, for example if a user belongs to a certain group of roles etc. By default the plugin does a great job of handling where to take users when setting up 2FA, however, this might be required in certain custom setups.

**Important:** use this hook only if the user(s) do not have access to the WordPress dashboard. If the users have access to the WordPress dashboard use the hook _wp_2fa_setup_page_link_.

### Parameters
  * **$url** (string) – the URL where the user should be redirected to
  * **$user** (WP_User) – the user object of the user that needs to be redirected

### Example code
```php
add_filter( 'wp_2fa_custom_setup_page_link', 'my_custom_setup_page_link', 10, 2 );
function my_custom_setup_page_link( $url, $user ) {
    if ( in_array( 'author', (array) $user->roles ) ) {
         // The user has the "author" role.
         $url = ‘my-custom-slug’;
    }
    return $url;
}
```
```

```APIDOC
## wp_2fa_mail_default_settings

### Description
The filter provides just a single argument, _$default_settings_ , which contains the default list of strings used within the plugin which can be read, altered, and returned back to our plugin prior to display.

### Parameters
  * **$default_settings** (array) – Array of default strings used throughout emails.

### Example code
```php
add_filter( 'wp_2fa_mail_default_settings', 'my_custom_email_strings' );
function my_custom_email_strings( $default_settings ) {
    $default_settings['login_code_setup_email_body'] = '<p>Hello world</p>';
    return $default_settings;
}
```
```

```APIDOC
## wp_2fa_oob_redirect_url

### Description
Use this hook to redirect the user to a different URL when sending an Out-Of-Band email (2FA authentication method that sends a link via email).

### Parameters
  * **$redirect** (string) – The URL you would like to redirect the user to
  * **$user** (WP_User) – The user object of the user that needs to be redirected

### Example code
```php
function change_redirect( string $redirect, \WP_User $user ) {
     $redirect = 'https://melapress.com?id=" . $user->ID;
     return $redirect;
}
```
```

```APIDOC
## wp_2fa_replacement_email_strings

### Description
In the plugin’s emails you can use tags such as _{user_login_name}_ and _{grace_period}_ which are replaced with applicable strings when an email is generated and sent to a user. This filter allows you to set your own replacements or add your own tags.

### Parameters
  * **$replacements** (array) – Array of default strings used throughout emails.

### Example code
```php
add_filter( 'wp_2fa_mail_default_settings', 'my_custom_replacement_reconfigure_strings' );
function my_custom_replacement_reconfigure_strings( $replacements ) {
    $replacements['grace_period'] = '<p>Hello world</p>';
    return $replacements;
}
```
```

```APIDOC
## wp_2fa_replacement_reconfigure_strings

### Description
In the plugin’s reconfiguration email’s you can use tags such as _{reconfigure_or_configure}_ and _{reconfigure_or_configure_capitalized}_ which are replaced with applicable strings when an email is generated and sent to a user. This filter allows you to set your own replacements or add your own tags.

### Parameters
  * **$replacements** (array) – Array of default strings used throughout emails.

### Example code
```php
add_filter( 'wp_2fa_mail_default_settings', 'my_custom_replacement_reconfigure_strings' );
function my_custom_replacement_reconfigure_strings( $replacements ) {
    $replacements['reconfigure_or_configure'] = '<p>Hello world</p>';
    return $replacements;
}
```
```

--------------------------------

### Implement Event Triggering with Variable Reporting (PHP)

Source: https://melapress.com/support/kb/wp-activity-log-create-custom-events

This PHP snippet shows how to implement the event triggering logic within a custom sensor. It includes adding an action hook, defining an event handler function, and triggering an event with specific variables like table ID, name, and editor link.

```php
if ( ! class_exists( '\WSAL\Plugin_Sensors\My_Custom_Sensor' ) ) {
    /**
     * Custom Sensors for PLUGINNAME plugin.
     *
     * Class file for alert manager.
     *
     * @since   1.0.0
     * @package wsal
     * @subpackage wsal-PLUGINNAME
     */
    class My_Custom_Sensor {
        /**
         * Listening to events using hooks.
         * Here you can code your own custom sensors for triggering your custom events.
         */
        public static function init() {
            add_action( 'tablepress_event_added_table', [ $this, 'event_table_added' ] );
        }
        /**
         * Report new Tables being created.
         *
         * Collect old post data before post update event.
         *
         * @since 1.0.0
         *
         * @param int $table_id - Table ID.
         */
        public function event_table_added( $table_id ) {
            $editor_link = esc_url(
                add_query_arg(
                    array(
                        'table_id' => $table_id,
                        'action' => 'edit',
                    ),
                    admin_url( 'admin.php?page=tablepress' )
                )
            );
            $event_id = ( isset( $_POST['action'] ) && 'tablepress_import' == $_POST['action'] ) ? 1234 : 4321;
            $variables = array(
                'table_name' => sanitize_text_field( get_the_title( $this->imported_table_id ) ),
                'table_id' => $table_id,
                'columns' => ( isset( $_POST[ 'table' ] ) ) ? intval( $_POST[ 'table' ][ 'columns' ] ) : 0,
                'rows' => ( isset( $_POST[ 'table' ] ) ) ? intval( $_POST[ 'table' ][ 'rows' ] ) : 0,
                'EditorLink' => $editor_link,
            );
            $this->plugin->alerts->Trigger( $event_id, $variables );
            return;
        }
    }
}
```

--------------------------------

### wp_2fa_setup_page_link

Source: https://melapress.com/support/kb/wp-2fa-list-hooks

Allows developers to specify a custom page URL for 2FA setup based on custom logic, such as user roles. This hook should only be used if the user has access to the WordPress dashboard.

```APIDOC
## wp_2fa_setup_page_link

### Description
Use this hook to specify the page where a user should be redirected to when required to setup 2FA based on your own logic, for example if a user belongs to a certain group of roles etc. By default the plugin does a great job of handling where to take users when setting up 2FA, however, this might be required in certain custom setups. Important: use this hook only if the user has access to the WordPress dashboard. If you are using a custom front-end 2FA page use the hook _wp_2fa_custom_setup_page_link_.

### Method
add_filter

### Hook Name
wp_2fa_setup_page_link

### Parameters
#### Filter Parameters
- **$url** (string) - The URL where the user should be redirected to.

### Example code
```php
add_filter( 'wp_2fa_setup_page_link', 'my_custom_setup_page_link', 10, 1 );
function my_custom_setup_page_link( $url ) {
    $user = wp_get_current_user();
    if ( in_array( 'author', (array) $user->roles ) ) {
        // The user has the "author" role.
        $url = ‘my-custom-slug’;
    }
    return $url;
}
```
```

--------------------------------

### Hide WP Activity Log Plugin using WP CLI

Source: https://melapress.com/support/kb/wp-cli-commands-wp-activity-log

This command hides the WP Activity Log plugin from the Installed Plugins list. It accepts a boolean (true/false) or integer (1/0). Any value other than '1' or 'true' will disable the hide option.

```bash
wp wsal_cli_commands set_hide_plugin --enabled=true
```

--------------------------------

### Define WP Activity Log License Key in wp-config.php

Source: https://melapress.com/support/kb/activate-melapress-plugin-license-programmatically

Defines the license key for the WP Activity Log plugin as a constant in the wp-config.php file. This is a prerequisite for programmatic license activation.

```php
define (‘WP__WSAL_FREEMIUS_LICENSE_KEY’,’<YOUR_LICENSE_KEY>’);
```

--------------------------------

### Configure Activity Log Retention using WP CLI

Source: https://melapress.com/support/kb/wp-cli-commands-wp-activity-log

This command configures the retention period for the activity log. It accepts boolean for enabling/disabling, a time unit (days, months, years), and an integer value for the retention period. The default retention is 6 months.

```bash
wsal_cli_commands set_retention --enabled=true --pruning-unit=years --pruning-value=5
```
Tokens:
Raw