posts-data-table / lib / Plugin / Plugin.php

Plugin.php in Posts Table with Search & Sort 1.3.1, at lib/Plugin/Plugin.php

101 lines 2.1 KB

Raw Download Zip

1	<?php
2
3	namespace Barn2\Lib\Plugin;
4
5	/**
6	* Basic interface implemented by all Barn2 plugins.
7	*
8	* @package Barn2/barn2-lib
9	* @author Barn2 Plugins <info@barn2.co.uk>
10	* @license GPL-3.0
11	* @copyright Barn2 Media Ltd
12	* @version 1.2
13	*/
14	interface Plugin {
15
16	/**
17	* Gets the name of this plugin.
18	*
19	* @return string The plugin name.
20	*/
21	public function get_name();
22
23	/**
24	* Gets the plugin version number (e.g. 1.3.2).
25	*
26	* @return string The version number.
27	*/
28	public function get_version();
29
30	/**
31	* Gets the full path to the main plugin file.
32	*
33	* @return string The main plugin file.
34	*/
35	public function get_file();
36
37	/**
38	* Get the 'basename' for the plugin (e.g. my-plugin/my-plugin.php).
39	*
40	* @return string The plugin basename.
41	*/
42	public function get_basename();
43
44	/**
45	* Get the slug for this plugin (e.g. my-plugin).
46	*
47	* @return string The plugin slug.
48	*/
49	public function get_slug();
50
51	/**
52	* Get the full path to the plugin folder, with trailing slash (e.g. /wp-content/plugins/my-plugin/).
53	*
54	* @return string The plugin directory path.
55	*/
56	public function get_dir_path();
57
58	/**
59	* Get the URL to the plugin folder, with trailing slash.
60	*
61	* @return string (URL)
62	*/
63	public function get_dir_url();
64
65	/**
66	* Is this plugin a WooCommerce extension?
67	*
68	* @return boolean true if it's a WooCommerce extension.
69	*/
70	public function is_woocommerce();
71
72	/**
73	* Is this plugin an Easy Digital Downloads extension?
74	*
75	* @return boolean true if it's an EDD extension.
76	*/
77	public function is_edd();
78
79	/**
80	* Get the settings page URL in the WordPress admin.
81	*
82	* @return string (URL)
83	*/
84	public function get_settings_page_url();
85
86	/**
87	* Get the documentation URL for this plugin.
88	*
89	* @return string (URL)
90	*/
91	public function get_documentation_url();
92
93	/**
94	* Get the support URL for this plugin.
95	*
96	* @return string (URL)
97	*/
98	public function get_support_url();
99
100	}
101