Updating the Freemius WordPress SDK
The Freemius WordPress SDK is regularly updated with new features, improvements, bug fixes, and compatibility updates. To make sure your product has access to the latest SDK capabilities, we recommend keeping the SDK bundled with your plugin or theme up to date.
When a new SDK version is released, the copy of the SDK already included in your product does not update automatically. You need to update the SDK files in your product and deploy a new version of your plugin or theme.
Updating the SDK in Your Product
To update the Freemius WordPress SDK:
-
Download the latest SDK release from the Freemius WordPress SDK GitHub repository.
-
Replace the existing
freemiusfolder in your plugin or theme with thefreemiusfolder from the latest release. -
If you're using Composer to install the SDK, you can also update it by running the following command:
composer update freemius/wordpress-sdk -
Test your product locally to confirm that the SDK loads correctly and your integration still works as expected.
-
Deploy a new version of your product through the Freemius Developer Dashboard.
Keeping the SDK current helps ensure that you and your users can benefit from new SDK features, compatibility improvements, and bug fixes as they become available.
Deployment Page Update Notices
The Freemius Developer Dashboard can notify you on the Deployment page when a newer version of the WordPress SDK is available for your product.
If you see an SDK update notice during deployment, review the available version and update the SDK before releasing your next product version.
When to Update the SDK
You do not always need to update immediately after every SDK release. However, it is a good practice to monitor new releases and update your product when a release includes features, compatibility changes, or fixes that are relevant to your integration.
If a release includes an urgent security update or important bug fix, we will usually send an email recommending that you update your product as soon as possible.
To stay informed about new SDK releases, we recommend that you Watch the Freemius WordPress SDK GitHub repository. You can also Star the repository to bookmark it in your GitHub account.
Contributing to the SDK
If you want to contribute to the Freemius WordPress SDK, see our contribution guidelines. The guide explains how to submit bug fixes, suggest new features, and improve the documentation.