WordPress Coming Soon Module

Coming Soon functionality for WordPress.

Installation

1. Add the Newfold Satis to your composer.json.

composer config repositories.newfold composer https://newfold-labs.github.io/satis/

2. Require the newfold-labs/wp-module-coming-soon package.

composer require newfold-labs/wp-module-coming-soon

3. Set strings and other options via the comingsoon index in a container.

use NewfoldLabs\WP\ModuleLoader\Container;
use function NewfoldLabs\WP\ModuleLoader\container as setContainer;

$nfd_module_container = new Container();

// Set a value - scoped to comingsoon index
$nfd_module_container->set('comingsoon', [
   'admin_screen_id' => 'app',
   'admin_app_url'   => admin_url( 'admin.php?page=app#/home' ),
   'template_h1'     => __('Coming Soon!', 'text-domain'),
   ...
]);
// assign container
setContainer( $nfd_module_container );

4. API

The module offers the ability to check the status of the coming soon, enable the coming soon or disable the coming soon.

For PHP applications, you can use its container service provider to interact with the API.

Container Service Provider Usage

use NewfoldLabs\WP\ModuleLoader\Container;

// Check if coming soon is enabled
public function check_coming_soon() {
    if ( $this->container->has( 'comingSoon' ) ) {
        $comingSoonService = $this->container->get( 'comingSoon' );
        return $comingSoonService->is_enabled();
    }
}

// Enable coming soon
public function enable_coming_soon() {
    if ( $this->container->has( 'comingSoon' ) ) {
        $comingSoonService = $this->container->get( 'comingSoon' );
        $comingSoonService->enable();
    }
}

// Disable coming soon
public function disable_coming_soon() {
    if ( $this->container->has( 'comingSoon' ) ) {
        $comingSoonService = $this->container->get( 'comingSoon' );
        $comingSoonService->disable();
    }
}

For JavaScript applications, you can use NewfoldRuntime.comingSoon window object to interact with the API.

The object exposes three asynchronous methods:

1. isEnable: Checks the current state of the coming soon and returns a boolean value or null on error.
2. enable: Enables the coming soon. It will return an object containing two properties, success and comingSoon. 'success' is a boolean that indicates whether the operation succeeded or not. 'comingSoon' is also a boolean with the new value. If the operation does not succeed, the object will not contain a 'comingSoon' property.
3. disable: Disables the coming soon. It will return an object containing two properties, success and comingSoon. 'success' is a boolean that indicates whether the operation succeeded or not. 'comingSoon' is also a boolean with the new value. If the operation does not succeed, the object will not contain a 'comingSoon' property.

All three methods are asynchronous, so keep that in mind when calling them.

Window API (JavaScript) Usage

await NewfoldRuntime.comingSoon.isEnabled();
await NewfoldRuntime.comingSoon.enable();
await NewfoldRuntime.comingSoon.disable();

[More on Newfold WordPress Modules](https://github.com/newfold-labs/wp-module-loader)