Skip to content

Implement admin pointer to indicate to the user they need to migrate modules to their standalone plugins #910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
felixarntz merged 7 commits into from
Dec 19, 2023
Merged

Implement admin pointer to indicate to the user they need to migrate modules to their standalone plugins #910

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b0ecb92
Add module migration pointer
mukeshpanchal27 Dec 18, 2023
ab6c25b
Update pointer heading
mukeshpanchal27 Dec 18, 2023
c8ac7e0
Remove string concatenation
mukeshpanchal27 Dec 18, 2023
eb5f7fb
Merge branch 'feature/creating-standalone-plugins' into fix/653-add-m…
mukeshpanchal27 Dec 18, 2023
331d308
Merge branch 'feature/creating-standalone-plugins' into fix/653-add-m…
mukeshpanchal27 Dec 18, 2023
d855b9e
Address review feedback
mukeshpanchal27 Dec 19, 2023
6d4cd74
Minor update to return doc.
felixarntz Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 96 additions & 48 deletions admin/load.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,40 @@ function perflab_admin_pointer( $hook_suffix ) {
$current_user = get_current_user_id();
$dismissed = explode( ',', (string) get_user_meta( $current_user, 'dismissed_wp_pointers', true ) );

/*
* If there are any active modules with inactive standalone plugins,
* show an admin pointer to prompt the user to migrate.
*/
$active_modules_with_inactive_plugins = perflab_get_active_module_data_with_inactive_standalone_plugins();
if (
! empty( $active_modules_with_inactive_plugins )
&& current_user_can( 'install_plugins' )
&& current_user_can( 'activate_plugins' )
&& ! in_array( 'perflab-module-migration-pointer', $dismissed, true )
) {
// Enqueue the pointer logic and return early.
wp_enqueue_style( 'wp-pointer' );
wp_enqueue_script( 'wp-pointer' );
add_action(
'admin_print_footer_scripts',
static function () {
$content = sprintf(
/* translators: %s: settings page link */
esc_html__( 'Your site is using modules which will be removed in the future in favor of their equivalent standalone plugins. Open %s to learn more about next steps to keep the functionality available.', 'performance-lab' ),
'<a href="' . esc_url( add_query_arg( 'page', PERFLAB_MODULES_SCREEN, admin_url( 'options-general.php' ) ) ) . '">' . esc_html__( 'Settings > Performance', 'performance-lab' ) . '</a>'
);
perflab_render_pointer(
'perflab-module-migration-pointer',
array(
'heading' => __( 'Performance Lab: Action required', 'performance-lab' ),
'content' => $content,
)
);
}
);
return;
}

if ( in_array( 'perflab-admin-pointer', $dismissed, true ) ) {
return;
}
Expand Down Expand Up @@ -436,8 +470,8 @@ function perflab_render_pointer( $pointer_id = 'perflab-admin-pointer', $args =
if ( ! isset( $args['content'] ) ) {
$args['content'] = sprintf(
/* translators: %s: settings page link */
__( 'You can now test upcoming WordPress performance features. Open %s to individually toggle the performance features included in the plugin.', 'performance-lab' ),
'<a href="' . esc_url( add_query_arg( 'page', PERFLAB_MODULES_SCREEN, admin_url( 'options-general.php' ) ) ) . '">' . __( 'Settings > Performance', 'performance-lab' ) . '</a>'
esc_html__( 'You can now test upcoming WordPress performance features. Open %s to individually toggle the performance features included in the plugin.', 'performance-lab' ),
'<a href="' . esc_url( add_query_arg( 'page', PERFLAB_MODULES_SCREEN, admin_url( 'options-general.php' ) ) ) . '">' . esc_html__( 'Settings > Performance', 'performance-lab' ) . '</a>'
);
}

Expand Down Expand Up @@ -757,58 +791,72 @@ function perflab_plugin_admin_notices() {
<?php
}

$active_modules_with_plugins = perflab_get_active_modules_with_standalone_plugins();
$active_modules_with_inactive_plugins = perflab_get_active_module_data_with_inactive_standalone_plugins();
if ( empty( $active_modules_with_inactive_plugins ) ) {
return;
}

if ( ! empty( $active_modules_with_plugins ) ) {
$module_data = perflab_get_modules();
$available_module_names = array();
foreach ( $active_modules_with_plugins as $module_slug ) {
if ( isset( $module_data[ $module_slug ] ) && ! perflab_is_standalone_plugin_loaded( $module_slug ) ) {
$available_module_names[] = $module_data[ $module_slug ]['name'];
}
}
$available_module_names = wp_list_pluck( $active_modules_with_inactive_plugins, 'name' );
$modules_count = count( $available_module_names );

$modules_count = count( $available_module_names );
if ( $modules_count < 1 ) {
return;
if ( 1 === $modules_count ) {
$message = '<p>';
$message .= sprintf(
/* translators: Module name */
esc_html__( 'Your site is using the "%s" module which will be removed in the future in favor of its equivalent standalone plugin.', 'performance-lab' ),
esc_attr( $available_module_names[0] )
);
$message .= ' ';
$message .= esc_html__( 'Please click the following button to install and activate the relevant plugin in favor of the module. This will not impact any of the underlying functionality.', 'performance-lab' );
$message .= '</p>';
} else {
$message = '<p>';
$message .= esc_html__( 'Your site is using modules which will be removed in the future in favor of their equivalent standalone plugins.', 'performance-lab' );
$message .= ' ';
$message .= esc_html__( 'Please click the following button to install and activate the relevant plugins in favor of the modules. This will not impact any of the underlying functionality.', 'performance-lab' );
$message .= '</p>';
$message .= '<strong>' . esc_html__( 'Available standalone plugins:', 'performance-lab' ) . '</strong>';
$message .= '<ol>';
foreach ( $available_module_names as $module_name ) {
$message .= sprintf( '<li>%s</li>', esc_html( $module_name ) );
}
$message .= '</ol>';
}

if ( 1 === $modules_count ) {
$message = '<p>';
$message .= sprintf(
/* translators: Module name */
esc_html__( 'Your site is using the "%s" module which will be removed in the future in favor of its equivalent standalone plugin.', 'performance-lab' ),
esc_attr( $available_module_names[0] )
);
$message .= ' ';
$message .= esc_html__( 'Please click the following button to install and activate the relevant plugin in favor of the module. This will not impact any of the underlying functionality.', 'performance-lab' );
$message .= '</p>';
} else {
$message = '<p>';
$message .= esc_html__( 'Your site is using modules which will be removed in the future in favor of their equivalent standalone plugins.', 'performance-lab' );
$message .= ' ';
$message .= esc_html__( 'Please click the following button to install and activate the relevant plugins in favor of the modules. This will not impact any of the underlying functionality.', 'performance-lab' );
$message .= '</p>';
$message .= '<strong>' . esc_html__( 'Available standalone plugins:', 'performance-lab' ) . '</strong>';
$message .= '<ol>';
foreach ( $available_module_names as $module_name ) {
$message .= sprintf( '<li>%s</li>', esc_html( $module_name ) );
}
$message .= '</ol>';
}
?>
<div class="notice notice-warning is-dismissible">
<?php echo wp_kses_post( $message ); ?>
<p class="perflab-button-wrapper">
<button type="button" class="button button-primary perflab-install-active-plugin">
<?php esc_html_e( 'Migrate legacy modules to standalone plugins', 'performance-lab' ); ?>
</button>
<span class="dashicons dashicons-update hidden"></span>
</p>
</div>
<?php
}

?>
<div class="notice notice-warning is-dismissible">
<?php echo wp_kses_post( $message ); ?>
<p class="perflab-button-wrapper">
<button type="button" class="button button-primary perflab-install-active-plugin">
<?php esc_html_e( 'Migrate legacy modules to standalone plugins', 'performance-lab' ); ?>
</button>
<span class="dashicons dashicons-update hidden"></span>
</p>
</div>
<?php
/**
* Returns an array of active module data with inactive standalone plugins.
*
* @since n.e.x.t
*
* @return array Array of active module data with inactive standalone plugins, otherwise an empty array.
*/
function perflab_get_active_module_data_with_inactive_standalone_plugins() {
$active_modules_with_plugins = perflab_get_active_modules_with_standalone_plugins();
if ( empty( $active_modules_with_plugins ) ) {
return array();
}

$module_data = perflab_get_modules();
$available_modules_data = array();
foreach ( $active_modules_with_plugins as $module_dir ) {
if ( isset( $module_data[ $module_dir ] ) && ! perflab_is_standalone_plugin_loaded( $module_dir ) ) {
$available_modules_data[] = $module_data[ $module_dir ];
}
}
return $available_modules_data;
}

/**
Expand Down