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

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

107 lines 2.2 KB

Raw Download Zip

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