Update WP Consent API plugin detection to account for non-standard location

[techanvil]

Feature Description

As mentioned in this #8305 (comment), it's possible for the WP Consent API plugin entry point to reside in a location other than wp-consent-api/wp-consent-api.php.

site-kit-wp/includes/Core/Consent_Mode/REST_Consent_Mode_Controller.php

Lines 143 to 144 in b19bdd5

	$slug = 'wp-consent-api';
	$plugin = "$slug/$slug.php";

We should update the above code to account for alternative locations for the plugin.

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• The Consent Mode controller should detect that the Consent API plugin is installed, even if it was installed via Composer or into a custom WordPress plugin folder and use the correct path to the plugin file.

Implementation Brief

• Update the core/site/data/consent-mode REST route includes/Core/Consent_Mode/REST_Consent_Mode_Controller.php:
  • Replace the $slug and $plugin variables with a single new variable called $plugin_uri with the value of https://wordpress.org/plugins/wp-consent-api. This is the URI of the plugin which won't change even if the plugin folder or main file changes.
    

    site-kit-wp/includes/Core/Consent_Mode/REST_Consent_Mode_Controller.php

    Lines 155 to 156 in cc356a6

    	$slug = 'wp-consent-api';
    	$plugin = "$slug/$slug.php";

  • Create the $slug and $plugin variables as empty strings to set later based on dynamic plugin values.
  • Update the install check block:
    

    site-kit-wp/includes/Core/Consent_Mode/REST_Consent_Mode_Controller.php

    Lines 166 to 171 in cc356a6

    	foreach ( array_keys( get_plugins() ) as $installed_plugin ) {
    	if ( $installed_plugin === $plugin ) {
    	$installed = true;
    	break;
    	}
    	}

    • Get the key and value in the foreach get_plugins() as $plugin_file => $installed_plugin.
    • Remove the array_keys function so that the loop gets the full plugin objects.
    • Update the check condition to $installed_plugin["PluginURI"] === $plugin_uri.
      • Set the $slug variable using $installed_plugin["TextDomain"].
      • Set the $plugin variable using $plugin_file.
  • The response block will now use the $slug and $plugin variables set based on the WordPress plugin data above, no changes required:
    

    site-kit-wp/includes/Core/Consent_Mode/REST_Consent_Mode_Controller.php

    Lines 177 to 184 in cc356a6

    	$activate_url = $nonce_url( self_admin_url( 'plugins.php?action=activate&plugin=' . $plugin ), 'activate-plugin_' . $plugin );
    	$install_url = $nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $slug ), 'install-plugin_' . $slug );
    	$response['wpConsentPlugin'] = array(
    	'installed' => $installed,
    	'activateURL' => current_user_can( 'activate_plugin', $plugin ) ? esc_url_raw( $activate_url ) : false,
    	'installURL' => current_user_can( 'install_plugins' ) ? esc_url_raw( $install_url ) : false,
    	);

Test Coverage

• Confirm existing phpunit tests pass.

QA Brief

• Setup and configure a basic Site Kit installation
• Manually download the WP Consent API plugin from https://wordpress.org/plugins/wp-consent-api/
• Extract it to your plugins folder in a randomly named folder, i.e wp-content/plugins/test-consent-plugin
• Navigate to Site Kit > Settings > Admin Settings
• Under Consent Mode, enable said feature
• Validate that the Activate CTA button shows as per the screenshot below:

• Validate that, upon clicking said CTA, the WP Consent API plugin is successfully activated
• Validate that, upon returning to Site Kit > Settings > Admin Settings, the Consent mode notice indicates the successful presence of the plugin as per the screenshot below:

• Deactivate and delete the plugin
• Ensure that the installation and activations steps for the plugin can be performed in Site Kit > Settings > Admin Settings

Changelog entry

• Detect WP Consent API plugin even when it's installed in a non-standard folder name.

[eugene-manuilov]

AC ✔️, I have adjusted it a bit to add a note that the controller should use the right path to the plugin.

[tofumatt]

IB ✅

[mohitwp]

QA Update ✅

• Tested on dev environment.
• Tested using File manager plugin.
• Tested by creating custom folder as mentioned in QAB.
• Verified that the Consent Mode controller detect that the Consent API plugin is installed, even if it was installed via Composer or into a custom WordPress plugin folder and use the correct path to the plugin file.
• Verified that plugin installation and activation is working as expected in case of installation through custom folder or directly through Site Kit > Settings > Admin Settings.

Recording.1155.mp4

[wpdarren]

@mohitwp as per my conversation on Slack. I am a little paranoid with this feature due to past issues 😄 so could you test the sceario in the QAB, but also check that the snippet still appears in the source code and ensure that tracking is working as expected for EU and Non EU traffic. More info on the snippet can be found in the testing instructions. Let me know if you have any questions.

[mohitwp]

QA Update ✅

• • Tested on dev environment.
• • Tested using File manager plugin.
• • Tested by creating custom folder as mentioned in QAB.
• • Verified that the Consent Mode controller detect that the Consent API plugin is installed, even if it was installed via Composer or into a custom WordPress plugin folder and use the correct path to the plugin file.
• • Verified that plugin installation and activation is working as expected in case of installation through custom folder or directly through Site Kit > Settings > Admin Settings.
• Verified that tracking is working as expected for Non EU and EU members including UK.
• Done E2E testing for consent mode functionality as per test instructions.

Recording.1155.mp4

• Verified that if consent mode is enabled snippet is showing under source code.

Recording.1160.mp4

• Verified that consent mode snippet is not showing if consent mode is not enabled.

Recording.1161.mp4

• Verified GA events related to WP constant API plugin activation and other Consent mode GA events listed under testing instructions.

[aaemnnosttv]

⚠️ Approval

There is a small change we should make to the implementation here. See #8959 (review)

I can raise a quick follow up here if needed.

[nfmohit]

⚠️ Approval

There is a small change we should make to the implementation here. See #8959 (review)

I can raise a quick follow up here if needed.

I've created a follow-up PR.

[aaemnnosttv]

Thanks @nfmohit, this has been merged and tested so this is good to go 👍

It's worth noting that this issue's changes were somehow reverted (no longer in main or develop) in 9ab0412 after it had gone through QA, so the follow-up PR actually re-introduced the change while addressing the points I raised.