Disabling & Uninstalling the ShipperHQ Extension for Magento
Step-by-step process to safely disable or uninstall ShipperHQ extension in Magento
Overview
Sometimes you need to disable the ShipperHQ extension in Magento, especially if it's causing conflicts on your site. You may also need to completely uninstall our extension on certain occasions, such as during an upgrade. Below, you'll find steps for both processes. 😊
If you encounter any issues with the configuration, please contact us for assistance.
💡 Caution: Some attributes used by ShipperHQ are also used by WebShopApps extensions. If you have WebShopApps extensions that you still need, do not delete those attributes.
This guide assumes that you have a working knowledge of MySQL.
Table of Contents
- Overview
- Magento 1
- How to Disable the ShipperHQ Magento Extension
- Manually Uninstalling the ShipperHQ Extension
- Magento 2
- How to Disable ShipperHQ Modules
- Composer Uninstaller
- How to Manually Uninstall the ShipperHQ Modules
Magento 1
How to Disable the ShipperHQ Magento Extension
Follow these steps:
- Open the relevant extension file in
app/etc/modules
- Set active to false
- Save the file back to the file system
- Refresh cache
If your backend is broken and you cannot refresh the cache, you can manually remove the contents of var/cache
. If you're still having issues with the site's frontend after disabling ShipperHQ, the problem may be due to an external factor (like a third-party extension). Note that disabling ShipperHQ might cause issues with viewing/saving products/customers because the data entries are tied to ShipperHQ files. The only way to resolve this is by removing the ShipperHQ attributes from the database. ⚠️
Manually Uninstalling the ShipperHQ Extension
Follow these steps:
- Disable the cache (if enabled) and compiler (if enabled).
- Edit the
eav_attribute
table and changeis_user_defined
to1
for all ShipperHQ attributes:- carrierid
- carriertype
- carriergroup
- ... (continue list)
- Remove all ShipperHQ attributes from all attribute sets.
- Disable the extension's files. This includes XML files prefixed by "shipperhq", "HackathonGridControl.xml" (not in modern versions), and "Webshopapps_Wsalogger.xml". If you have WebShopApps extensions installed, the Logger extension is required and should not be removed.
- Remove files from
app/code/community/Webshopapps
(unless using WebShopApps extensions),app/code/community/hackathon
andapp/code/community/shipperhq
related to the extension. - Remove the XML files from step 2 in
app/etc/modules
. - Remove files from
app/design
,app/locale
,js
,lib
, andskin
directories that include "shipperhq" in the directory name or "shipperhq_" as the file prefix. - Remove any references to shipperhq from the
core_config_data
MySQL database table. - Verify removal on admin/frontend.
- All attributes from step 2 can be removed if no longer required.
- Enable the cache and compiler (if previously enabled).
The extensions reside in the app/code/community
areas, so there is no impact on core code. ✅
Magento 2
How to Disable ShipperHQ Modules
From the command line, disable the modules using:
```bash
php bin/magento module:disable --clear-static-content ShipperHQCommon ShipperHQLogger ShipperHQ_Shipper
If you have any optional modules enabled, disable them similarly:
```bash
php bin/magento module:disable --clear-static-content ShipperHQPickup ShipperHQOption ShipperHQ_Calendar
Lastly, run the standard cleanup commands:
```bash
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento indexer:reindex
php bin/magento cache:clean
Composer Uninstaller
As of version 20.35.0, uninstall the modules using Composer:
```bash
php bin/magento module:uninstall -r ShipperHQ_Shipper
This WILL remove your ShipperHQ attributes and data from your database. Omit the "-r" parameter if you want to keep your data. If you encounter an error like:
```bash
Class "ShipperHQ\Shipper\Model\Carrier\Shipper" does not exist
You may need to run this SQL manually due to an issue preventing all ShipperHQ data removal during uninstall:
``sql DELETE FROM
coreconfigdataWHERE
value` LIKE 'ShipperHQ\\Shipper\\Model\\Carrier\\Shipper';
Remember to refresh the cache after running this SQL. Learn more about updating to 20.35.0 or newer in our Installation Article. 💡
How to Manually Uninstall the ShipperHQ Modules
Follow these steps:
- Disable the cache (if enabled) and compiler (if enabled).
- Edit the
eav_attribute
table and changeis_user_defined
to1
for all ShipperHQ attributes. - Remove all ShipperHQ attributes from all attribute sets. The attributes to remove include:
- Run:
composer remove shipperhq/module-logger
- Run:
composer remove shipperhq/module-shipper
- Run:
php bin/magento setup:upgrade
- Run:
php bin/magento setup:di:compile
(if the compiler is enabled). - Remove any references to shipperhq from the
core_config_data
MySQL database table. - Verify removal on admin/frontend.
- All attributes from step 2 can be removed if no longer needed.
- Enable cache (if previously enabled).
- If Redis is installed, flush its caches:
redis-cli FLUSHALL
- Retest in Private Browsing/Incognito Mode to ensure your browser isn't caching the checkout. 😊