How Does Subscriptions Handle Staging Sites and Migrations?

Some hosts, like SiteGround, provide an easy way to create a clone your website for testing changes, called a staging site.

To prevent duplicate payments from a clone of your site, Subscriptions will disable automatic payments and subscription related emails whenever the current site’s URL differs to the URL of the site where Subscriptions was first activated.

You will know when this is happening because Subscriptions will display a warning in the administration area of your site. This notice also shows which URL Subscriptions considers to be the live site.

Staging Site Notice

 

Subscriptions will also display a smaller warning next to the WooCommerce > Subscriptions menu item when a store is operating in Staging Mode.

subscriptions-duplicate-site-menu-item-badge

Duplicate Site Warning ↑ Back to top

You can still test subscription renewals on a test site, but Subscriptions will use the manual renewal process and will not send any subscription related emails.

If want to enable automatic payments on the new site, either because you have changed the test site’s payment gateway to use a sandbox mode and updated all customer emails for the staging site, or because the new site is a permanent migration of the old site, then click the Enable automatic payments button displayed in the administration notice.

Please note: it is only emails sent by Subscriptions that will be blocked by Subscriptions in staging mode, any emails sent or managed by WordPress, WooCommerce or another plugin may still be sent from your staging site. To block all emails from your site, install a plugin like Disable Emails.

What does Subscriptions consider a Staging Site? ↑ Back to top

Subscriptions will keep a record of the URL of the site where it is first activated. It considers this to be the live site and will run in live mode. If the site’s URL then changes, it considers the new site to be a staging site and it will run in staging mode.

This means if you first activate Subscriptions on a staging site, Subscriptions will run in live mode on the staging site because it considers this site to actually be your live site.

Because of this, if you want to test Subscriptions on a staging site before running it on your life site, we recommend first activating it on the live site and then creating the staging site from that site’s database.

Developer Note: Subscriptions stores a clone of WordPress’ siteurl value in an option with the name wc_subscriptions_siteurl. It compares this value with the siteurl value to see if the value has changed.

Check if Staging Mode is Active ↑ Back to top

If you are unsure whether you or another administrator on the site has dismissed the notice and want to check if the store is running in Staging mode, you can:

  1. Go To WooComerce
  2. Check the Subscriptions menu item. If a red area is shown with the word Staging, the site is in Staging Mode. If nothing is displayed except “Subscriptions”, the site is in Live Mode.

subscriptions-duplicate-site-menu-item-badge

Whether the store is running in Staging or Live mode is also displayed on the Status screen. To check it there, you can:

  1. Go To WooCommerce > Status
  2. Scroll down to Subscriptions Mode
  3. Check the value. If a red cross is shown with the word Staging, the site is in Staging Mode. If a tick mark is shown with the word Live, the site is in Live Mode.

system-status-entry-for-a-site-in-staging-mode

Below this section will be a row labeled Subscriptions Live URL. This shows the URL that Subscriptions considers the live site.

Subscriptions Live Site URL

Enabling automatic payments on a staging site ↑ Back to top

To switch your site from Staging Mode to Live Mode:

  1. Go to any admin page on your site, e.g. visit example.com/wp-admin/
  2. Click the Enable Automatic Payments button displayed in the staging site notice.

If you chose the Quit Nagging Me option, but then later find you want to enable automatic payments on the test site, you can:

  1. Access your database via PhpMyAdmin if your host provides it (or install a plugin like ARI Adminer if your host does not provide phpMyAdmin access)
  2. Search the wp_options table for an option with the option_name of 'wcs_ignore_duplicate_siteurl_notice'
  3. Change the option value of the 'wcs_ignore_duplicate_siteurl_notice' option to anything other than its current value, “false” would be a good choice.
  4. Save the changes to the option value

The staging site notice should reappear and you can choose to Enable automatic payments.

Database Migration ↑ Back to top

When migrating your site’s database from one server to another server, there are additional considerations.

If you have migrated your site’s database and the domain name has not changed, the staging mode will not be triggered on the new site. This means renewal payments will be processed in live mode. If you want to make sure payments are not processed, even temporarily, you need to:

Decommission the Old Site ↑ Back to top

To avoid any issues with duplicate payments or emails, you should decommission the old site as soon as possible.

However, if you need to continue to allow the old site to run after migrating the database to a different server, you must also:

Without completing one of these steps, your old site will continue to process real recurring payments.

We also suggest you block all emails from your duplicate site to prevent customers receiving any emails from this old site. To do this, you can use a plugin like Disable Emails (this plugin is not officially endorsed by WooCommerce.com).

Disabling all scheduled events ↑ Back to top

By default, scheduled renewals and other scheduled events, like expiration, will still be triggered when Subscriptions is in staging mode. No payments will be attempted, or emails sent, for these events, but the event will still be initiated as it would be on the live site.

If you wish to stop these events being triggered, install and activated the free Action Scheduler – Disable Default Runner plugin.

This plugin disables all events in the scheduling library WooCommerce Subscriptions uses. This library is also used by other extensions, like WooCommerce Memberships, so will also disable any scheduled events for those plugins.

The Action Scheduler – Disable Default Runner plugin does not rely on the site URL check. Once active, it will block scheduled events. As a result, it can also be used on a live site to temporarily disable renewals payments and other scheduled events.

FAQ ↑ Back to top

Why are renewal payments not processing on the live site? ↑ Back to top

When a renewal is processed in Staging mode, the following note will be added to its order notes:

Payment processing skipped – renewal order created on staging site under staging site lock. Live site is at https://example.com/

On occasion, these notes may appear on renewal orders created on the live site. This means the live site is accessible via more than one URL. For example, the site may be accessible via both:

  • https://www.example.com
  • https://example.com

To process renewals correctly, Subscriptions requires your WordPress site to be accessible via only one URL.

To ensure your site is accessible via only one the URL, you can use the WordPress Site URL constants in your wp-config.php file to set the URL for the site. For example:

define( 'WP_SITEURL', 'https://example.com/' );
define( 'WP_HOME', 'https://example.com/' );

You should also make sure your web server software, like Apache, is configured to redirect any requests to other URLs to the canonical URL. WordPress has a guide on setting up .htaccess file correctly. If you need additional help, please contact your web host.

Serving your site under a single URL is good practice as it has other benefits, most notably for SEO. As Moz explains:

Duplicate content is content that appears on the Internet in more than one place. That “one place” is defined as a location with a unique website address (URL)

While not technically a penalty, duplicate content can still sometimes impact search engine rankings. When there are multiple pieces of, as Google calls it, “appreciably similar” content in more than one location on the Internet, it can be difficult for search engines to decide which version is more relevant to a given search query.

WooCommerce - the most customizable eCommerce platform for building your online business.

Back to the top