Documentation

Install extends AbstractChecklistItem
in package

Is the plugin installed?

Table of Contents

Constants

IDENTIFIER  = 'install'

Methods

getDescription()  : string
Get checklist description. Can be empty.
getLink()  : string
Get link so the checklist item can be resolved there. Can be empty.
getLinkTarget()  : string
Get link target. Can be empty or "_blank", .
getLinkText()  : string
Get link text. Can be empty.
getPluginConstantPrefix()  : string
Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
getTitle()  : string
Get checklist title.
isChecked()  : bool
Is this checklist item checked?
isVisible()  : bool
Should this be visible as checklist item?
needsPro()  : bool
Does this checklist item need PRO version of RCB?
toggle()  : bool
Set state of checklist item.
getFromOption()  : mixed
Get the state from `wp_options`.
persistStateToOption()  : mixed
Persist the state from `wp_options`.

Constants

IDENTIFIER

public mixed IDENTIFIER = 'install'

Methods

getDescription()

Get checklist description. Can be empty.

public getDescription() : string
Return values
string

getLink()

Get link so the checklist item can be resolved there. Can be empty.

public getLink() : string
Return values
string

getLinkTarget()

Get link target. Can be empty or "_blank", .

public getLinkTarget() : string

..

Return values
string

getLinkText()

Get link text. Can be empty.

public getLinkText() : string
Return values
string

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

getTitle()

Get checklist title.

public getTitle() : string
Return values
string

isChecked()

Is this checklist item checked?

public isChecked() : bool
Return values
bool

isVisible()

Should this be visible as checklist item?

public isVisible() : bool
Return values
bool

needsPro()

Does this checklist item need PRO version of RCB?

public needsPro() : bool
Return values
bool

toggle()

Set state of checklist item.

public toggle(bool $state) : bool
Parameters
$state : bool
Return values
bool

getFromOption()

Get the state from `wp_options`.

protected getFromOption(string $id) : mixed
Parameters
$id : string

persistStateToOption()

Persist the state from `wp_options`.

protected persistStateToOption(string $id, bool $state) : mixed
Parameters
$id : string
$state : bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results