Documentation

RpmInitiator extends AbstractInitiator
in package
Uses UtilsProvider

Initiate real-product-manager-wp-client functionality.

Table of Contents

Properties

$pluginUpdate  : PluginUpdate
Plugin update instance.

Methods

buildTelemetryData()  : mixed
Allows you to build telemetry data.
formAdditionalCheckboxes()  : array<string|int, mixed>
Allows to configure additional checkboxes in the license activation form.
getAccountSiteUrl()  : mixed
getHost()  : mixed
getLicenseKeyHelpUrl()  : mixed
getMigrationOption()  : null|string
Get the option value if we want to migrate a plugin. Please override with your implementation and simply return the "old" used license key.
getPluginAssets()  : Assets
Documented in AbstractInitiator.
getPluginBase()  : Base
Documented in AbstractInitiator.
getPluginConstantPrefix()  : string
Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
getPluginFile()  : mixed
getPluginName()  : mixed
getPluginSlug()  : mixed
getPluginUpdater()  : PluginUpdate
Get the plugin updater instance.
getPluginVersion()  : mixed
getPrivacyPolicy()  : string
Documented in AbstractInitiator.
getPrivacyProvider()  : string
Get the privacy provider.
getProductAndVariant()  : array<string|int, int>
Documented in AbstractInitiator.
isAdminNoticeLicenseVisible()  : bool
Documented in AbstractInitiator.
isAutoUpdatesEnabled()  : bool
Returns `true` if the current WordPress installations allows automatic updates for this plugin.
isExternalUpdateEnabled()  : bool
Documented in AbstractInitiator.
isLocalAnnouncementVisible()  : bool
Documented in AbstractInitiator.
isMultisiteLicensed()  : bool
Return `false` if you want to disable license per site in multisite.
isNewsletterEnabled()  : bool
Return `false` if you want to disable sending newsletter signup.
isTelemetryEnabled()  : bool
Return `false` if you want to disable sending telemetry data.
start()  : mixed
Initialize all available things depending on the configuration.

Properties

Methods

formAdditionalCheckboxes()

Allows to configure additional checkboxes in the license activation form.

public formAdditionalCheckboxes() : array<string|int, mixed>

It should return an array in form of:

[
  [
    'id' => 'my-checkbox',
    'text' => 'This is my awesome checkbox',
    'stateFn' => function($state) {
      // Do anything with $state
      // You can also return `WP_Error`
    }
  ]
]
Return values
array<string|int, mixed>

getMigrationOption()

Get the option value if we want to migrate a plugin. Please override with your implementation and simply return the "old" used license key.

public getMigrationOption() : null|string
Return values
null|string

getPluginAssets()

Documented in AbstractInitiator.

public getPluginAssets() : Assets
Tags
codeCoverageIgnore
Return values
Assets

getPluginBase()

Documented in AbstractInitiator.

public getPluginBase() : Base
Tags
codeCoverageIgnore
Return values
Base

getPluginConstantPrefix()

Get the prefix of this plugin so composer packages can dynamically build other constant values on it.

public getPluginConstantPrefix() : string
Tags
codeCoverageIgnore

It only returns a string with the constant prefix

Return values
string

getPrivacyPolicy()

Documented in AbstractInitiator.

public getPrivacyPolicy() : string
Tags
codeCoverageIgnore
Return values
string

getPrivacyProvider()

Get the privacy provider.

public getPrivacyProvider() : string
Return values
string

getProductAndVariant()

Documented in AbstractInitiator.

public getProductAndVariant() : array<string|int, int>
Tags
codeCoverageIgnore
Return values
array<string|int, int>

isAdminNoticeLicenseVisible()

Documented in AbstractInitiator.

public isAdminNoticeLicenseVisible() : bool
Tags
codeCoverageIgnore
Return values
bool

isAutoUpdatesEnabled()

Returns `true` if the current WordPress installations allows automatic updates for this plugin.

public isAutoUpdatesEnabled() : bool

Returns false if the current plugin is already enabled for auto updates.

Attention: We have implemented to only update minor and patch versions, no major versions!

Tags
see
https://wordpress.org/support/wordpress-version/version-5-5/#security
see
https://developer.wordpress.org/reference/hooks/auto_update_type/
see
https://wordpress.org/support/article/configuring-automatic-background-updates/#plugin-theme-updates-via-filter
Return values
bool

isExternalUpdateEnabled()

Documented in AbstractInitiator.

public isExternalUpdateEnabled() : bool
Tags
codeCoverageIgnore
Return values
bool

isLocalAnnouncementVisible()

Documented in AbstractInitiator.

public isLocalAnnouncementVisible() : bool
Tags
codeCoverageIgnore
Return values
bool

isMultisiteLicensed()

Return `false` if you want to disable license per site in multisite.

public isMultisiteLicensed() : bool

For wordpress.org plugins (free) the multisite-license is disabled.

Return values
bool

isNewsletterEnabled()

Return `false` if you want to disable sending newsletter signup.

public isNewsletterEnabled() : bool
Return values
bool

isTelemetryEnabled()

Return `false` if you want to disable sending telemetry data.

public isTelemetryEnabled() : bool
Return values
bool

start()

Initialize all available things depending on the configuration.

public start() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results