diff --git a/doc/Readme.md b/doc/Readme.md index 2d3a21aa1a..d05535d1f1 100644 --- a/doc/Readme.md +++ b/doc/Readme.md @@ -26,6 +26,7 @@ Class `\MailPoet\API\API` becomes available once MailPoet plugin is loaded by Wo * [Get Lists (getLists)](api_methods/GetLists.md) * [Get Subscriber (getSubscriber)](api_methods/GetSubscriber.md) * [Get Subscriber Fields (getSubscriberFields)](api_methods/GetSubscriberFields.md) +* [Is Setup Complete (isSetupComplete)](api_methods/IsSetupComplete.md) * [Subscribe to List (subscribeToList)](api_methods/SubscribeToList.md) * [Subscribe to List (subscribeToLists)](api_methods/SubscribeToLists.md) * [Unsubscribe from List (unsubscribeFromList)](api_methods/UnsubscribeFromList.md) diff --git a/doc/api_methods/IsSetupComplete.md b/doc/api_methods/IsSetupComplete.md new file mode 100644 index 0000000000..1a44c60cab --- /dev/null +++ b/doc/api_methods/IsSetupComplete.md @@ -0,0 +1,9 @@ +[back to list](../Readme.md) + +# Is setup complete + +## `bool isSetupComplete()` + +This method checks if the MailPoet is set up. + +It returns `false` if either Welcome Wizard, or WooCommerce setup, or MailPoet 2 migration is shown on the next MailPoet page visit. Otherwise it returns `true`.