\Barn2\PTP_Lib\PluginPlugin

Basic interface implemented by all Barn2 plugins.

Summary

Methods

Constants

get_name()
get_version()
get_file()
get_basename()
get_slug()
get_dir_path()
get_dir_url()
is_woocommerce()
is_edd()
get_settings_page_url()
get_documentation_url()
get_support_url()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

get_name()

get_name(): string

Gets the name of this plugin.

Returns

string —

The plugin name.

get_version()

get_version(): string

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

Returns

string —

The version number.

get_file()

get_file(): string

Gets the full path to the main plugin file.

Returns

string —

The main plugin file.

get_basename()

get_basename(): string

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

Returns

string —

The plugin basename.

get_slug()

get_slug(): string

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

Returns

string —

The plugin slug.

get_dir_path()

get_dir_path(): string

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

Returns

string —

The plugin directory path.

get_dir_url()

get_dir_url(): string

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

Returns

string —

(URL)

is_woocommerce()

is_woocommerce(): boolean

Is this plugin a WooCommerce extension?

Returns

boolean —

true if it's a WooCommerce extension.

is_edd()

is_edd(): boolean

Is this plugin an Easy Digital Downloads extension?

Returns

boolean —

true if it's an EDD extension.

get_settings_page_url()

get_settings_page_url(): string

Get the settings page URL in the WordPress admin.

Returns

string —

(URL)

get_documentation_url()

get_documentation_url(): string

Get the documentation URL for this plugin.

Returns

string —

(URL)

get_support_url()

get_support_url(): string

Get the support URL for this plugin.

Returns

string —

(URL)