api.php
5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
<?php
use AC\EncodedListScreenDataFactory;
use AC\Helper;
use AC\ListScreen;
use AC\ListScreenCollection;
use AC\Type\ListScreenId;
use AC\Type\Url;
/**
* @since 3.0
*/
// TODO David remove the singleton, make a factory with a shared instance for AC this should be no issue
if ( ! function_exists( 'AC' ) ) {
function AC(): AC\AdminColumns {
static $ac = null;
if ( $ac === null ) {
$ac = AC\AdminColumns::instance();
}
return $ac;
}
}
if ( ! function_exists( 'ac_helper' ) ) {
function ac_helper() {
return new AC\Helper();
}
}
/**
* @param string $id Layout ID e.g. ac5de58e04a75b0
*
* @return ListScreen|null
* @since 4.0.0
*/
if ( ! function_exists( 'ac_get_list_screen' ) ) {
function ac_get_list_screen( $id ) {
return AC()->get_storage()->find( new ListScreenId( $id ) );
}
}
/**
* Usage: Load after or within the 'wp_loaded' action hook.
*
* @param string $key e.g. post, page, wp-users, wp-media, wp-comments
*
* @return ListScreenCollection
* @since 4.0.0
*/
if ( ! function_exists( 'ac_get_list_screens' ) ) {
function ac_get_list_screens( $key ) {
return AC()->get_storage()->find_all( [ 'key' => $key ] );
}
}
/**
* Usage: Load after or within the 'wp_loaded' action hook.
*
* @param string $column_name
* @param string $list_screen_id
*
* @return AC\Column|null
* @since 4.2
*/
if ( ! function_exists( 'ac_get_column' ) ) {
function ac_get_column( $column_name, $list_screen_id ) {
try {
$list_id = new ListScreenId( $list_screen_id );
} catch ( Exception $e ) {
return null;
}
$list_screen = AC()->get_storage()->find( $list_id );
if ( ! $list_screen ) {
return null;
}
$column = $list_screen->get_column_by_name( $column_name );
if ( ! $column ) {
return null;
}
return $column;
}
}
/**
* Usage: Load after or within the 'wp_loaded' action hook.
*
* @param string $list_screen_id
*
* @return AC\Column[]
* @since 4.2
*/
if ( ! function_exists( 'ac_get_columns' ) ) {
function ac_get_columns( $list_screen_id ) {
try {
$list_id = new ListScreenId( $list_screen_id );
} catch ( Exception $e ) {
return [];
}
$list_screen = AC()->get_storage()->find( $list_id );
if ( ! $list_screen ) {
return [];
}
return $list_screen->get_columns();
}
}
/**
* @param $format
* @param null $timestamp
* @param DateTimeZone|null $timezone
*
* @return false|string
*/
if ( ! function_exists( 'ac_format_date' ) ) {
function ac_format_date( $format, $timestamp = null, DateTimeZone $timezone = null ) {
return ( new Helper\Date )->format_date( $format, $timestamp, $timezone );
}
}
/**
* @param string|null $slug
*
* @return string
* @deprecated 4.5
*/
function ac_get_admin_url( $slug = null ) {
_deprecated_function( __METHOD__, '4.5', 'Url\Editor' );
return ( new Url\Editor( $slug ) )->get_url();
}
/**
* @param string|null $slug
*
* @return string
* @deprecated 4.5
*/
function ac_get_admin_network_url( $slug = null ) {
_deprecated_function( __METHOD__, '4.5', 'Url\EditorNetwork' );
return ( new Url\EditorNetwork( $slug ) )->get_url();
}
/**
* @param array|string $list_screen_keys
* @param array $column_data
*
* @deprecated 4.0.0
* @since 2.2
*/
function ac_register_columns( $list_screen_keys, $column_data ) {
foreach ( (array) $list_screen_keys as $key ) {
ac_load_columns( [ $key => $column_data ] );
}
}
/**
* @deprecated 6.0
*/
function ac_get_site_utm_url(
string $path,
string $utm_medium,
string $utm_content = null,
string $utm_campaign = null
): string {
_deprecated_function( __METHOD__, '6.0', 'AC\Type\UrlUtmTags()' );
return ( new Url\UtmTags( new Url\Site( $path ), $utm_medium, $utm_content, $utm_campaign ) )->get_url();
}
/**
* @deprecated 6.0
*/
function ac_get_site_documentation_url( string $path = null ): string {
_deprecated_function( __METHOD__, '6.0', 'AC\Type\Url\Documentation()' );
return ( new Url\Documentation( $path ) )->get_url();
}
/**
* @deprecated 6.0
*/
function ac_get_site_url( string $path = null ): string {
_deprecated_function( __METHOD__, '6.0', 'AC\Type\Url\Site()' );
return ( new Url\Site( $path ) )->get_url();
}
/**
* Manually set the columns for a list screen
* This overrides the database settings and thus renders the settings screen for this list screen useless
* If you like to register a column of your own please have a look at our documentation.
* We also have a free start-kit available, which contains all the necessary files.
* Documentation: https://www.admincolumns.com/documentation/guides/creating-new-column-type/
* Starter-kit: https://github.com/codepress/ac-column-template/
*
* @param array $data
*
* @deprecated 4.1
* @since 4.0.0
*/
if ( ! function_exists( 'ac_load_columns' ) ) {
function ac_load_columns( array $data ) {
$factory = new EncodedListScreenDataFactory();
$factory->create()->add( $data );
}
}
/**
* @return bool
* @deprecated 6.0
*/
function ac_is_pro_active() {
_deprecated_function( __METHOD__, '6.0' );
return defined( 'ACP_FILE' );
}