Action uncanny-automator

automator_settings_premium_integration_after_output

Fires after the premium integration settings output is displayed, allowing for custom modifications or additions.

add_action( 'automator_settings_premium_integration_after_output', $callback, 10, 1 );

Description

Fires after the premium integration settings content has been output. Developers can use this hook to append or modify content within the premium integration settings page. The `$this` parameter refers to the integration object, allowing access to its properties and methods.


Usage

add_action( 'automator_settings_premium_integration_after_output', 'your_function_name', 10, 1 );

Parameters

$this (mixed)
The `$this` parameter represents the instance of the `Premium_Integration_Settings` class, providing access to its methods and properties for outputting premium integration settings.

Examples

// Example of how to hook into the 'automator_settings_premium_integration_after_output' action.
// This function will be called after the main content of a premium integration settings page is outputted.
// It demonstrates adding extra information or performing actions after the default settings are displayed.
add_action( 'automator_settings_premium_integration_after_output', function( $settings_instance ) {

	// Check if the current instance is for a specific premium integration, e.g., 'my-awesome-plugin'
	// The $settings_instance variable typically holds an object representing the settings of a particular integration.
	// We can access properties or methods of this instance to perform context-aware actions.
	if ( method_exists( $settings_instance, 'get_integration_slug' ) && 'my-awesome-plugin' === $settings_instance->get_integration_slug() ) {

		// Output a custom message or a link to additional documentation.
		echo '<div class="notice notice-info">';
		echo '<p>';
		echo esc_html__( 'Thank you for using My Awesome Plugin integration!', 'your-text-domain' );
		echo ' <a href="' . esc_url( admin_url( 'admin.php?page=my-awesome-plugin-docs' ) ) . '" target="_blank">';
		echo esc_html__( 'Read our advanced guide', 'your-text-domain' );
		echo '</a>';
		echo '</p>';
		echo '</div>';

		// You could also perform other actions here, like clearing a cache specific to this integration
		// or logging that the settings page was viewed.
		// For example:
		// my_awesome_plugin_clear_integration_cache( $settings_instance->get_integration_id() );

	}

}, 10, 1 ); // Priority 10, accepts 1 argument ($this from the hook)

Placement

This code should be placed in the functions.php file of your active theme, a custom plugin, or using a code snippets plugin.


Source Code

src/core/lib/settings/premium-integration-settings.php:434
src/core/lib/settings/trait-premium-integration-templating.php:50

final public function output_wrapper() {
		do_action( 'automator_settings_premium_integration_before_output', $this );
		$this->output();
		do_action( 'automator_settings_premium_integration_after_output', $this );
	}


Scroll to Top