Wp.php
14.7 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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
<?php
namespace AIOSEO\Plugin\Common\Traits\Helpers;
use AIOSEO\Plugin\Common\Utils;
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Contains all WP related helper methods.
*
* @since 4.1.4
*/
trait Wp {
/**
* Whether or not we have a local connection.
*
* @since 4.0.0
*
* @var bool
*/
private static $connection = false;
/**
* Helper method to enqueue scripts.
*
* @since 4.0.0
*
* @param string $script The script to enqueue.
* @param string $url The URL of the script.
* @param bool $vue Whether or not this is a vue script.
* @return void
*/
public function enqueueScript( $script, $url, $vue = true ) {
if ( ! wp_script_is( $script, 'enqueued' ) ) {
wp_enqueue_script(
$script,
$this->getScriptUrl( $url, $vue ),
[],
aioseo()->version,
true
);
}
}
/**
* Helper method to enqueue stylesheets.
*
* @since 4.0.0
*
* @param string $style The stylesheet to enqueue.
* @param string $url The URL of the stylesheet.
* @param bool $vue Whether or not this is a vue stylesheet.
* @return void
*/
public function enqueueStyle( $style, $url, $vue = true ) {
if ( ! wp_style_is( $style, 'enqueued' ) && $this->shouldEnqueue( $url ) ) {
wp_enqueue_style(
$style,
$this->getScriptUrl( $url, $vue ),
[],
aioseo()->version
);
}
}
/** Whether or not we should enqueue a file.
*
* @since 4.0.0
*
* @param string $url The url to check against.
* @return bool Whether or not we should enqueue.
*/
private function shouldEnqueue( $url ) {
$version = strtoupper( aioseo()->versionPath );
$host = defined( 'AIOSEO_DEV_' . $version ) ? constant( 'AIOSEO_DEV_' . $version ) : false;
if ( ! $host ) {
return true;
}
if ( false !== strpos( $url, 'chunk-common.css' ) ) {
// return false;
}
return true;
}
/**
* Retrieve the proper URL for this script or style.
*
* @since 4.0.0
*
* @param string $url The url.
* @param bool $vue Whether or not this is a vue script.
* @return string The modified url.
*/
public function getScriptUrl( $url, $vue = true ) {
$version = strtoupper( aioseo()->versionPath );
$host = $vue && defined( 'AIOSEO_DEV_' . $version ) ? constant( 'AIOSEO_DEV_' . $version ) : false;
$localUrl = $url;
$url = plugins_url( 'dist/' . aioseo()->versionPath . '/assets/' . $url, AIOSEO_FILE );
if ( ! $host ) {
return $url;
}
if ( $host && ! self::$connection ) {
$splitHost = explode( ':', str_replace( '/', '', str_replace( 'http://', '', str_replace( 'https://', '', $host ) ) ) );
self::$connection = @fsockopen( $splitHost[0], $splitHost[1] ); // phpcs:ignore WordPress
}
if ( ! self::$connection ) {
return $url;
}
return $host . $localUrl;
}
/**
* Returns user roles in the current WP install.
*
* @since 4.0.0
*
* @return array An array of user roles.
*/
public function getUserRoles() {
global $wp_roles;
$wpRoles = $wp_roles;
if ( ! is_object( $wpRoles ) ) {
// Don't assign this to the global because otherwise WordPress won't override it.
$wpRoles = new \WP_Roles();
}
$roleNames = $wpRoles->get_names();
asort( $roleNames );
return $roleNames;
}
/**
* Returns the custom roles in the current WP install.
*
* @since 4.1.3
*
* @return array An array of custom roles.
*/
public function getCustomRoles() {
$allRoles = $this->getUserRoles();
$toSkip = array_merge(
// Default WordPress roles.
[ 'superadmin', 'administrator', 'editor', 'author', 'contributor' ],
// Default AIOSEO roles.
[ 'aioseo_manager', 'aioseo_editor' ],
// Filterable roles.
apply_filters( 'aioseo_access_control_excluded_roles', array_merge( [
'subscriber'
], aioseo()->helpers->isWooCommerceActive() ? [ 'customer' ] : [] ) )
);
// Remove empty entries.
$toSkip = array_filter( $toSkip );
$customRoles = [];
foreach ( $allRoles as $roleName => $role ) {
// Skip specific roles.
if ( in_array( $roleName, $toSkip, true ) ) {
continue;
}
$customRoles[ $roleName ] = $role;
}
return $customRoles;
}
/**
* Returns an array of plugins with the active status.
*
* @since 4.0.0
*
* @return array An array of plugins with active status.
*/
public function getPluginData() {
$pluginUpgrader = new Utils\PluginUpgraderSilentAjax();
$installedPlugins = array_keys( get_plugins() );
$plugins = [];
foreach ( $pluginUpgrader->pluginSlugs as $key => $slug ) {
$plugins[ $key ] = [
'basename' => $slug,
'installed' => in_array( $slug, $installedPlugins, true ),
'activated' => is_plugin_active( $slug ),
'adminUrl' => admin_url( $pluginUpgrader->pluginAdminUrls[ $key ] ),
'canInstall' => aioseo()->addons->canInstall(),
'canActivate' => aioseo()->addons->canActivate(),
'canUpdate' => aioseo()->addons->canUpdate(),
'wpLink' => ! empty( $pluginUpgrader->wpPluginLinks[ $key ] ) ? $pluginUpgrader->wpPluginLinks[ $key ] : null
];
}
return $plugins;
}
/**
* Get all registered Post Statuses.
*
* @since 4.1.6
*
* @param boolean $statusesOnly Whether or not to only return statuses.
* @return array An array of post statuses.
*/
public function getPublicPostStatuses( $statusesOnly = false ) {
$allStatuses = get_post_stati( [ 'show_in_admin_all_list' => true ], 'objects' );
$postStatuses = [];
foreach ( $allStatuses as $status => $data ) {
if ( $statusesOnly ) {
$postStatuses[] = $status;
continue;
}
$postStatuses[] = [
'label' => $data->label,
'status' => $status
];
}
return $postStatuses;
}
/**
* Retrieve a list of public post types with slugs/icons.
*
* @since 4.0.0
*
* @param boolean $namesOnly Whether only the names should be returned.
* @param boolean $hasArchivesOnly Whether or not to only include post types which have archives.
* @param boolean $rewriteType Whether or not to rewrite the type slugs.
* @return array An array of public post types.
*/
public function getPublicPostTypes( $namesOnly = false, $hasArchivesOnly = false, $rewriteType = false ) {
$postTypes = [];
$postObjects = get_post_types( [ 'public' => true ], 'objects' );
$woocommerce = class_exists( 'woocommerce' );
foreach ( $postObjects as $postObject ) {
if ( empty( $postObject->label ) ) {
continue;
}
// We don't want to include archives for the WooCommerce shop page.
if (
$hasArchivesOnly &&
(
! $postObject->has_archive ||
( 'product' === $postObject->name && $woocommerce )
)
) {
continue;
}
if ( $namesOnly ) {
$postTypes[] = $postObject->name;
continue;
}
if ( 'attachment' === $postObject->name ) {
$postObject->label = __( 'Attachments', 'all-in-one-seo-pack' );
}
if ( 'product' === $postObject->name && $woocommerce ) {
$postObject->menu_icon = 'dashicons-products';
}
$name = $postObject->name;
if ( 'type' === $postObject->name && $rewriteType ) {
$name = '_aioseo_type';
}
$postTypes[] = [
'name' => $name,
'label' => ucwords( $postObject->label ),
'singular' => ucwords( $postObject->labels->singular_name ),
'icon' => $postObject->menu_icon,
'hasExcerpt' => post_type_supports( $postObject->name, 'excerpt' ),
'hasArchive' => $postObject->has_archive,
'hierarchical' => $postObject->hierarchical,
'taxonomies' => get_object_taxonomies( $name ),
'slug' => isset( $postObject->rewrite['slug'] ) ? $postObject->rewrite['slug'] : $name
];
}
return apply_filters( 'aioseo_public_post_types', $postTypes, $namesOnly, $hasArchivesOnly );
}
/**
* Retrieve a list of public taxonomies with slugs/icons.
*
* @since 4.0.0
*
* @param boolean $namesOnly Whether only the names should be returned.
* @param boolean $rewriteType Whether or not to rewrite the type slugs.
* @return array An array of public taxonomies.
*/
public function getPublicTaxonomies( $namesOnly = false, $rewriteType = false ) {
$taxonomies = [];
if ( count( $taxonomies ) ) {
return $taxonomies;
}
$taxObjects = get_taxonomies( [ 'public' => true ], 'objects' );
foreach ( $taxObjects as $taxObject ) {
if ( empty( $taxObject->label ) ) {
continue;
}
if ( in_array( $taxObject->name, [
'product_shipping_class',
'post_format'
], true ) ) {
continue;
}
// We need to exclude product attributes from this list as well.
if (
'pa_' === substr( $taxObject->name, 0, 3 ) &&
'manage_product_terms' === $taxObject->cap->manage_terms &&
! apply_filters( 'aioseo_woocommerce_product_attributes', false )
) {
continue;
}
if ( $namesOnly ) {
$taxonomies[] = $taxObject->name;
continue;
}
$name = $taxObject->name;
if ( 'type' === $taxObject->name && $rewriteType ) {
$name = '_aioseo_type';
}
$taxonomies[] = [
'name' => $name,
'label' => ucwords( $taxObject->label ),
'singular' => ucwords( $taxObject->labels->singular_name ),
'icon' => strpos( $taxObject->label, 'categor' ) !== false ? 'dashicons-category' : 'dashicons-tag',
'hierarchical' => $taxObject->hierarchical,
'slug' => isset( $taxObject->rewrite['slug'] ) ? $taxObject->rewrite['slug'] : ''
];
}
return apply_filters( 'aioseo_public_taxonomies', $taxonomies, $namesOnly );
}
/**
* Retrieve a list of users that match passed in roles.
*
* @since 4.0.0
*
* @return array An array of user data.
*/
public function getSiteUsers( $roles ) {
static $users = [];
if ( ! empty( $users ) ) {
return $users;
}
$rolesWhere = [];
foreach ( $roles as $role ) {
$rolesWhere[] = '(um.meta_key = \'' . aioseo()->db->db->prefix . 'capabilities\' AND um.meta_value LIKE \'%\"' . $role . '\"%\')';
}
$dbUsers = aioseo()->db->start( 'users as u' )
->select( 'u.ID, u.display_name, u.user_nicename, u.user_email' )
->join( 'usermeta as um', 'u.ID = um.user_id' )
->whereRaw( '(' . implode( ' OR ', $rolesWhere ) . ')' )
->orderBy( 'u.user_nicename' )
->run()
->result();
foreach ( $dbUsers as $dbUser ) {
$users[] = [
'id' => intval( $dbUser->ID ),
'displayName' => $dbUser->display_name,
'niceName' => $dbUser->user_nicename,
'email' => $dbUser->user_email,
'gravatar' => get_avatar_url( $dbUser->user_email )
];
}
return $users;
}
/**
* Returns the ID of the site logo if it exists.
*
* @since 4.0.0
*
* @return int
*/
public function getSiteLogoId() {
if ( ! get_theme_support( 'custom-logo' ) ) {
return false;
}
return get_theme_mod( 'custom_logo' );
}
/**
* Returns the URL of the site logo if it exists.
*
* @since 4.0.0
*
* @return string
*/
public function getSiteLogoUrl() {
$id = $this->getSiteLogoId();
if ( ! $id ) {
return false;
}
$image = wp_get_attachment_image_src( $id, 'full' );
if ( empty( $image ) ) {
return false;
}
return $image[0];
}
/**
* Returns the filesystem object if we have access to it.
*
* @since 4.0.0
*
* @param array $args The connection args.
* @return WP_Filesystem The filesystem object.
*/
public function wpfs( $args = [] ) {
require_once( ABSPATH . 'wp-admin/includes/file.php' );
WP_Filesystem( $args );
global $wp_filesystem;
if ( is_object( $wp_filesystem ) ) {
return $wp_filesystem;
}
return false;
}
/**
* Returns noindexed post types.
*
* @since 4.0.0
*
* @return array A list of noindexed post types.
*/
public function getNoindexedPostTypes() {
return $this->getNoindexedObjects( 'postTypes' );
}
/**
* Checks whether a given post type is noindexed.
*
* @since 4.0.0
*
* @param string $postType The post type.
* @return bool Whether the post type is noindexed.
*/
public function isPostTypeNoindexed( $postType ) {
$noindexedPostTypes = $this->getNoindexedPostTypes();
return in_array( $postType, $noindexedPostTypes, true );
}
/**
* Returns noindexed taxonomies.
*
* @since 4.0.0
*
* @return array A list of noindexed taxonomies.
*/
public function getNoindexedTaxonomies() {
return $this->getNoindexedObjects( 'taxonomies' );
}
/**
* Checks whether a given post type is noindexed.
*
* @since 4.0.0
*
* @param string $taxonomy The taxonomy.
* @return bool Whether the taxonomy is noindexed.
*/
public function isTaxonomyNoindexed( $taxonomy ) {
$noindexedTaxonomies = $this->getNoindexedTaxonomies();
return in_array( $taxonomy, $noindexedTaxonomies, true );
}
/**
* Returns noindexed object types of a given parent type.
*
* @since 4.0.0
*
* @param string $type The parent object type ("postTypes" or "taxonomies").
* @return array A list of noindexed objects types.
*/
private function getNoindexedObjects( $type ) {
$noindexed = [];
foreach ( aioseo()->dynamicOptions->searchAppearance->$type->all() as $name => $object ) {
if (
! $object['show'] ||
( $object['advanced']['robotsMeta'] && ! $object['advanced']['robotsMeta']['default'] && $object['advanced']['robotsMeta']['noindex'] )
) {
$noindexed[] = $name;
}
}
return $noindexed;
}
/**
* Returns all categories for a post.
*
* @since 4.1.4
*
* @param int $postId The post ID.
* @return array $names The category names.
*/
public function getAllCategories( $postId = 0 ) {
$names = [];
$categories = get_the_category( $postId );
if ( $categories && count( $categories ) ) {
foreach ( $categories as $category ) {
$names[] = aioseo()->helpers->internationalize( $category->cat_name );
}
}
return $names;
}
/**
* Returns all tags for a post.
*
* @since 4.1.4
*
* @param int $postId The post ID.
* @return array $names The tag names.
*/
public function getAllTags( $postId = 0 ) {
$names = [];
$tags = get_the_tags( $postId );
if ( ! empty( $tags ) && ! is_wp_error( $tags ) ) {
foreach ( $tags as $tag ) {
if ( ! empty( $tag->name ) ) {
$names[] = aioseo()->helpers->internationalize( $tag->name );
}
}
}
return $names;
}
/**
* Loads the translations for a given domain.
*
* @since 4.1.4
*
* @return void
*/
public function loadTextDomain( $domain ) {
if ( ! is_user_logged_in() ) {
return;
}
// Unload the domain in case WordPress has enqueued the translations for the site language instead of profile language.
// Reloading the text domain will otherwise not override the existing loaded translations.
unload_textdomain( $domain );
$mofile = $domain . '-' . get_user_locale() . '.mo';
load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile );
}
}