Licensed_Plugin extends Plugin

Extends the Plugin interface to add additional functions for licensed plugins.

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

version
1.1

Table of Contents

get_basename()  : string
Get the 'basename' for the plugin (e.g. my-plugin/my-plugin.php).
get_dir_path()  : string
Get the full path to the plugin folder, with trailing slash (e.g. /wp-content/plugins/my-plugin/).
get_dir_url()  : string
Get the URL to the plugin folder, with trailing slash.
get_documentation_url()  : string
Get the documentation URL for this plugin.
get_file()  : string
Gets the full path to the main plugin file.
get_id()  : mixed
Get the plugin ID.
get_item_id()  : int
Get the item ID of this plugin.
get_legacy_db_prefix()  : string
Get the legacy database prefix for the old license system.
get_license()  : License
Get the plugin license object.
get_license_page_url()  : string
Get the URL of the page where license settings are managed.
get_license_setting()  : License_Setting
Get the license setting for the plugin.
get_name()  : string
Gets the name of this plugin.
get_settings_page_url()  : string
Get the settings page URL in the WordPress admin.
get_slug()  : string
Get the slug for this plugin (e.g. my-plugin).
get_support_url()  : string
Get the support URL for this plugin.
get_version()  : string
Gets the plugin version number (e.g. 1.3.2).
has_valid_license()  : bool
Does this plugin have a valid license?
is_edd()  : bool
Is this plugin an Easy Digital Downloads extension?
is_woocommerce()  : bool
Is this plugin a WooCommerce extension?

Methods

get_basename()

Get the 'basename' for the plugin (e.g. my-plugin/my-plugin.php).

public get_basename() : string
Return values
string

The plugin basename.

get_dir_path()

Get the full path to the plugin folder, with trailing slash (e.g. /wp-content/plugins/my-plugin/).

public get_dir_path() : string
Return values
string

The plugin directory path.

get_dir_url()

Get the URL to the plugin folder, with trailing slash.

public get_dir_url() : string
Return values
string

(URL)

get_documentation_url()

Get the documentation URL for this plugin.

public get_documentation_url() : string
Return values
string

(URL)

get_file()

Gets the full path to the main plugin file.

public get_file() : string
Return values
string

The main plugin file.

get_id()

Get the plugin ID.

public get_id() : mixed

$return int The plugin ID.

Return values
mixed

get_item_id()

Get the item ID of this plugin.

public get_item_id() : int
Tags
deprecated
1.1

Replaced by Plugin::get_id()

Return values
int

The item ID

get_legacy_db_prefix()

Get the legacy database prefix for the old license system.

public get_legacy_db_prefix() : string
Return values
string

The prefix or an empty string if not applicable

get_license()

Get the plugin license object.

public get_license() : License
Return values
License

get_license_page_url()

Get the URL of the page where license settings are managed.

public get_license_page_url() : string
Return values
string

The license setting URL

get_license_setting()

Get the license setting for the plugin.

public get_license_setting() : License_Setting
Return values
License_Setting

get_name()

Gets the name of this plugin.

public get_name() : string
Return values
string

The plugin name.

get_settings_page_url()

Get the settings page URL in the WordPress admin.

public get_settings_page_url() : string
Return values
string

(URL)

get_slug()

Get the slug for this plugin (e.g. my-plugin).

public get_slug() : string
Return values
string

The plugin slug.

get_support_url()

Get the support URL for this plugin.

public get_support_url() : string
Return values
string

(URL)

get_version()

Gets the plugin version number (e.g. 1.3.2).

public get_version() : string
Return values
string

The version number.

has_valid_license()

Does this plugin have a valid license?

public has_valid_license() : bool
Return values
bool

true if valid.

is_edd()

Is this plugin an Easy Digital Downloads extension?

public is_edd() : bool
Return values
bool

true if it's an EDD extension.

is_woocommerce()

Is this plugin a WooCommerce extension?

public is_woocommerce() : bool
Return values
bool

true if it's a WooCommerce extension.

Search results