class-acf-admin-tool.php — Advanced Custom Fields (ACF®) 6.8.8

advanced-custom-fields / includes / admin / tools / class-acf-admin-tool.php

advanced-custom-fields / includes / admin / tools Last commit date

class-acf-admin-tool-export.php 5 months ago class-acf-admin-tool-import.php 5 months ago class-acf-admin-tool.php 5 months ago index.php 2 years ago

class-acf-admin-tool.php

184 lines

1	<?php
2	/**
3	* @package ACF
4	* @author WP Engine
5	*
6	* © 2026 Advanced Custom Fields (ACF®). All rights reserved.
7	* "ACF" is a trademark of WP Engine.
8	* Licensed under the GNU General Public License v2 or later.
9	* https://www.gnu.org/licenses/gpl-2.0.html
10	*/
11
12	if ( ! defined( 'ABSPATH' ) ) {
13	exit; // Exit if accessed directly
14	}
15
16	if ( ! class_exists( 'ACF_Admin_Tool' ) ) :
17
18	class ACF_Admin_Tool {
19
20
21	/** @var string Tool name */
22	var $name = '';
23
24
25	/** @var string Tool title */
26	var $title = '';
27
28
29	/** @var string Dashicon slug */
30	var $icon = '';
31
32
33	/** @var boolean Redirect form to single */
34	// var $redirect = false;
35
36
37	/**
38	* get_name
39	*
40	* This function will return the Tool's name
41	*
42	* @date 19/10/17
43	* @since 5.6.3
44	*
45	* @param n/a
46	* @return n/a
47	*/
48	function get_name() {
49	return $this->name;
50	}
51
52
53	/**
54	* get_title
55	*
56	* This function will return the Tool's title
57	*
58	* @date 19/10/17
59	* @since 5.6.3
60	*
61	* @param n/a
62	* @return n/a
63	*/
64	function get_title() {
65	return $this->title;
66	}
67
68
69	/**
70	* get_url
71	*
72	* This function will return the Tool's title
73	*
74	* @date 19/10/17
75	* @since 5.6.3
76	*
77	* @param n/a
78	* @return n/a
79	*/
80	function get_url() {
81	return acf_get_admin_tool_url( $this->name );
82	}
83
84
85	/**
86	* is_active
87	*
88	* This function will return true if the tool is active
89	*
90	* @date 19/10/17
91	* @since 5.6.3
92	*
93	* @param n/a
94	* @return boolean
95	*/
96	function is_active() {
97	return acf_maybe_get_GET( 'tool' ) === $this->name;
98	}
99
100
101	/**
102	* This function will setup the class functionality
103	*
104	* @type function
105	* @date 27/6/17
106	* @since 5.6.0
107	*
108	* @param n/a
109	* @return n/a
110	*/
111	function __construct() {
112
113	// initialize
114	$this->initialize();
115	}
116
117
118	/**
119	* initialize
120	*
121	* This function will initialize the admin tool
122	*
123	* @date 10/10/17
124	* @since 5.6.3
125	*
126	* @param n/a
127	* @return n/a
128	*/
129	function initialize() {
130
131	/* do nothing */
132	}
133
134
135
136	/**
137	* load
138	*
139	* This function is called during the admin page load
140	*
141	* @date 10/10/17
142	* @since 5.6.3
143	*
144	* @param n/a
145	* @return n/a
146	*/
147	function load() {
148
149	/* do nothing */
150	}
151
152
153	/**
154	* html
155	*
156	* This function will output the metabox HTML
157	*
158	* @date 10/10/17
159	* @since 5.6.3
160	*
161	* @param n/a
162	* @return n/a
163	*/
164	function html() {
165	}
166
167
168	/**
169	* submit
170	*
171	* This function will run when the tool's form has been submit
172	*
173	* @date 10/10/17
174	* @since 5.6.3
175	*
176	* @param n/a
177	* @return n/a
178	*/
179	function submit() {
180	}
181	}
182
183	endif; // class_exists check
184