PHP Class WPDKPlugin

This class is very different from WPDKWordPressPlugin because can describe any WordPress Plugin. Also, it is the logical model of any plugin.
Author: =undo= ([email protected])
显示文件 Open project: wpxtreme/wpdk Class Usage Examples

Public Properties

Property Type Description
$active boolean The Active flag
$activeForNetwork boolean TRUE whether the plugin is active for the entire network.
$author string The Author get from get_plugin_data(), 'Author' parameter
$authorName string The Author name from get_plugin_data(), 'AuthorName' parameter
$authorURI string The Author URI from get_plugin_data(), 'AuthorURI' parameter
$description string Long description of plugin
$file string Usually __FILE__
$icon string The standard WPDK 64x64 icon path
$id string This is the ID of plugin. This property is 'folder/main file.php'
$name string Name of plugin
$network string Checks for "Network: true" in the plugin header to see if this should be activated only as a network wide plugin. The plugin would also work when Multisite is not enabled.
$pluginURI string Address of plugin repository
$textDomain string The plugin text domain get from get_plugin_data(), 'Text Domain' parameter
$textDomainPath string The complete Text domain Plugin url get from get_plugin_data(), 'Domain Path' parameter
$title string The plugin title. This is the same as name
$version string Plugin version

Public Methods

Method Description
__construct ( null $file = null ) : WPDKPlugin Create an instance of WPDKPlugin class

Method Details

__construct() public method

Create an instance of WPDKPlugin class
public __construct ( null $file = null ) : WPDKPlugin
$file null Optional. Usually constant __FILE__
return WPDKPlugin

Property Details

$active public_oe property

The Active flag
public bool $active
return boolean

$activeForNetwork public_oe property

TRUE whether the plugin is active for the entire network.
Since: 1.7.2
public bool $activeForNetwork
return boolean

$author public_oe property

The Author get from get_plugin_data(), 'Author' parameter
public string $author
return string

$authorName public_oe property

The Author name from get_plugin_data(), 'AuthorName' parameter
public string $authorName
return string

$authorURI public_oe property

The Author URI from get_plugin_data(), 'AuthorURI' parameter
public string $authorURI
return string

$description public_oe property

Long description of plugin
public string $description
return string

$file public_oe property

Usually __FILE__
Since: 1.0.0.b4
public string $file
return string

$icon public_oe property

The standard WPDK 64x64 icon path
public string $icon
return string

$id public_oe property

This is the ID of plugin. This property is 'folder/main file.php'
public string $id
return string

$name public_oe property

Name of plugin
public string $name
return string

$network public_oe property

Checks for "Network: true" in the plugin header to see if this should be activated only as a network wide plugin. The plugin would also work when Multisite is not enabled.
public string $network
return string

$pluginURI public_oe property

Address of plugin repository
public string $pluginURI
return string

$textDomain public_oe property

The plugin text domain get from get_plugin_data(), 'Text Domain' parameter
public string $textDomain
return string

$textDomainPath public_oe property

The complete Text domain Plugin url get from get_plugin_data(), 'Domain Path' parameter
public string $textDomainPath
return string

$title public_oe property

The plugin title. This is the same as name
public string $title
return string

$version public_oe property

Plugin version
public string $version
return string