-
Notifications
You must be signed in to change notification settings - Fork 0
/
starter_content_exporter.php
2077 lines (1771 loc) · 71 KB
/
starter_content_exporter.php
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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Plugin Name: Starter Content Exporter
* Plugin URI: https://pixelgrade.com/
* Description: A plugin which exposes exportable data through the REST API.
* Version: 1.5.5
* Author: Pixelgrade, Vlad Olaru
* Author URI: https://pixelgrade.com/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
* Text Domain: socket
* Domain Path: /languages
* Requires at least: 5.5.0
* Tested up to: 6.0.0
* Requires PHP: 7.4
*/
if ( ! class_exists( 'Starter_Content_Exporter' ) ) {
class Starter_Content_Exporter {
private $client_placeholders;
/**
* @var array A list of meta keys representing all the possible image holders
* For example `_thumbnail_id` holds the featured image, which should be replaced with a placeholder
* Or `product_image_gallery` which holds a list of attachments ids separated by comma. Also they should be
* replaced with placeholders
* @TODO this should turn into an option and allow user to select which meta keys are holding images
*/
private array $gallery_meta_keys = [
'_thumbnail_id',
'main_image',
'image_backgrounds',
'_hero_background_gallery',
'product_image_gallery',
// theme specific keys .. gosh these should be automatically detected
'_border_main_gallery',
'_bucket_main_gallery',
'_heap_main_gallery',
'_lens_main_gallery',
'_rosa_main_gallery',
'_mies_second_image',
'_pile_second_image',
'_border_portfolio_gallery',
'_lens_portfolio_gallery',
'_border_project_gallery',
];
/**
* A list of options and theme mods which are supposed to be imported at the start
* For example, some options like "which Jetpack modules should be enabled" must be imported before we
* even start to import posts or categories.
*
* The remaining theme mods (which aren't ignored) will be imported at the end of the process
*
* @var array
*/
private array $pre_settings = [
'mi_options' => [],
'mi_mods' => [],
'options' => [
'show_on_front',
'posts_per_page',
],
'mods' => [
'pixelgrade_jetpack_default_active_modules',
],
];
/**
* A list of options keys which should be ignored from export
* @var array
*/
private array $ignored_theme_mods = [
'pixcare_license', // This is the new key
'pixassist_license', // This is the new key for Pixelgrade Assistant
'pixcare_theme_config',
'pixcare_license_hash',
'pixcare_license_status',
'pixcare_license_type',
'pixcare_license_expiry_date',
'pixcare_new_theme_version',
'support',
'pixcare_support',
'0',
];
public function __construct() {
register_activation_hook( __FILE__, [ 'Starter_Content_Exporter', 'activate' ] );
add_action( 'init', [ $this, 'init_demo_exporter' ], 100050 );
add_filter( 'socket_config_for_starter_content_exporter', [ $this, 'add_socket_config' ] );
/**
* Add REST API support to all registered post types that don't specify a REST API behavior.
*
* This is OK since we use Starter Content Exporter on demo sites and there is nothing sensitive to expose.
*/
add_filter( 'register_post_type_args', [ $this, 'add_restapi_post_type_args' ], 10, 2 );
// Do the same for taxonomies.
add_filter( 'register_taxonomy_args', [ $this, 'add_restapi_taxonomy_args' ], 10, 2 );
// The new standard following endpoints
add_action( 'rest_api_init', [ $this, 'add_rest_routes_api_v2' ] );
// Internal filters.
add_filter( 'sce_export_prepare_post_content', [ $this, 'parse_content_for_images' ], 10, 3 );
add_filter( 'sce_export_prepare_post_meta', [ $this, 'prepare_post_meta' ], 10, 3 );
// widgets
add_filter( 'pixcare_sce_widget_data_export_text', [ $this, 'prepare_text_widgets' ], 10, 3 );
add_filter( 'pixcare_sce_widget_data_export_nav_menu', [ $this, 'prepare_menu_widgets' ], 10, 3 );
// Make sure that queries don't get an unbound `posts_per_page` value (-1), via filtering.
// since the REST API core controllers (like WP_REST_Posts_Controller) don't support that.
// @see https://core.trac.wordpress.org/ticket/43998
add_action( 'rest_api_init', [ $this, 'prevent_unbound_rest_queries' ] );
}
/**
* Do anything needed at plugin activation.
*/
public static function activate() {
flush_rewrite_rules();
}
public function init_demo_exporter() {
require_once( plugin_dir_path( __FILE__ ) . 'socket/loader.php' );
$socket = new WP_Socket( [
'plugin' => 'starter_content_exporter',
'api_base' => 'sce/v1',
] );
require_once( plugin_dir_path( __FILE__ ) . 'safe-svg.php' );
}
/**
* Add the `show_in_rest` CPT argument if it is not already present.
*
* @param $args
* @param $post_type
*
* @return mixed
*/
public function add_restapi_post_type_args( $args, $post_type ) {
// We don't want to mess with these since they are system-related.
$excluded_cpts = [
'revision',
'customize_changeset',
'oembed_cache',
'user_request',
'scheduled-action',
'schema',
'shop_order',
'shop_order_refund',
'shop_coupon',
'feedback',
'jp_pay_order',
'jp_pay_product',
'nf_sub',
];
if ( ! in_array( $post_type, $excluded_cpts ) && is_array( $args ) && ! isset( $args['show_in_rest'] ) ) {
$args['show_in_rest'] = true;
}
return $args;
}
/**
* Add the `show_in_rest` taxonomy argument if it is not already present.
*
* @param $args
*
* @return mixed
*/
public function add_restapi_taxonomy_args( $args ) {
if ( is_array( $args ) && ! isset( $args['show_in_rest'] ) ) {
$args['show_in_rest'] = true;
}
return $args;
}
/**
* For REST API requests, prevent unbound `posts_per_page` value (-1).
*
* Nova_Restaurant CPT is filtering the posts query and imposing a -1 value,
* thus making it impossible to fetch food menu items via REST API.
*
* The REST API core controllers (like WP_REST_Posts_Controller) don't support that.
* @see https://core.trac.wordpress.org/ticket/43998
*
* @return void
*/
public function prevent_unbound_rest_queries() {
add_action( 'parse_query', function ( $query ) {
if ( isset( $query->query_vars['posts_per_page'] ) && - 1 === $query->query_vars['posts_per_page'] ) {
// 100 posts is the maximum allowed per page by the core REST controllers.
$query->query_vars['posts_per_page'] = 100;
}
}, 9999 );
}
/**
* This is the management interface config via the Socket options framework
*
* @param array $config
*
* @return array
*/
public function add_socket_config( array $config ): array {
$config = array_merge( $config, [
'page_title' => 'Set Up Content/Data Exports',
'description' => '',
'nav_label' => 'Starter Content Exporter',
'options_key' => 'starter_content_exporter',
'display' => [
// Group the sockets
'group' => true,
// Provide the groups of socket keys. The order will be respected.
'groups' => [
[
'title' => 'Must-Import Data',
'desc' => 'This data will be <strong>automatically imported upon theme setup.</strong><br>This should not be focused on content, but on data that is important for the theme to function as expected.',
'sockets' => [
'export_mi_media',
'export_mi_post_types',
'export_mi_options',
],
],
[
'title' => 'Optional Content/Data',
'desc' => 'This content/data will only be imported if the user chooses so.',
'sockets' => [
'export_media',
'export_post_types',
'export_options',
],
],
],
],
'sockets' => [],
] );
// Get all the post types that are shown in the REST API.
$post_types = get_post_types( [ 'show_in_rest' => true ], 'objects' );
// Only add post type specific media items to post types that truly need it.
$post_types_with_specific_media = [
'product',
'portfolio',
'gallery',
];
/**
* MUST-IMPORT GROUP SOCKETS.
*/
// Must-Import media.
$config['sockets']['export_mi_media'] = [
'label' => 'Media',
'items' => [
'mi_placeholders' => [
'type' => 'gallery',
'label' => 'Placeholder Images',
'description' => 'Pick a set of images which should <strong>replace post content images.</strong> Assume the order in which these images will be chosen is <em>random.</em>',
],
'mi_ignored_images' => [
'type' => 'gallery',
'label' => 'Ignored Images',
'description' => 'Pick a set of images to be <strong>ignored from replacement</strong> in the exported content. They will be exported as they are.',
],
],
];
// Must-Import post types.
$config['sockets']['export_mi_post_types'] = [
'label' => 'Content (posts & taxonomies)',
'items' => [],
];
foreach ( $post_types as $post_type => $post_type_config ) {
if ( 'attachment' === $post_type ) {
continue;
}
$config['sockets']['export_mi_post_types']['items'][ 'mi_post_type_' . $post_type . '_start' ] = [
'type' => 'divider',
'html' => $post_type,
];
$config['sockets']['export_mi_post_types']['items'][ 'mi_post_type_' . $post_type ] = [
'type' => 'post_select',
'label' => $post_type_config->label,
'query' => [
'post_type' => $post_type,
],
];
$taxonomy_objects = get_object_taxonomies( $post_type, 'objects' );
if ( ! empty( $taxonomy_objects ) ) {
foreach ( $taxonomy_objects as $tax => $tax_config ) {
if ( in_array( $tax, [
'feedback',
'jp_pay_order',
'jp_pay_product',
'post_format',
'product_type',
'product_visibility',
'product_shipping_class',
'wp_template_part_area',
'wp_theme',
] ) ) {
continue;
}
$config['sockets']['export_mi_post_types']['items'][ 'mi_tax_' . $tax ] = [
'type' => 'tax_select',
'label' => $tax_config->label,
'query' => [
'taxonomy' => $tax,
],
];
}
}
// Add post type specific media items.
if ( in_array( $post_type, $post_types_with_specific_media ) ) {
$config['sockets']['export_mi_post_types']['items'][ 'mi_post_type_' . $post_type . '_media_placeholders' ] = [
'type' => 'gallery',
'label' => 'Placeholder Images',
'description' => 'Pick a set of images which should <strong>replace post content images, for ' . $post_type . '.</strong> Assume the order in which these images will be chosen is <em>random.</em><br>Leave empty to use the general placeholder images, for this post type.',
];
$config['sockets']['export_mi_post_types']['items'][ 'mi_post_type_' . $post_type . '_media_ignored_images' ] = [
'type' => 'gallery',
'label' => 'Ignored Images',
'description' => 'Pick a set of images to be <strong>ignored from replacement</strong> in the exported content, for ' . $post_type . '. They will be exported as they are.<br>Leave empty to use the general ignored images, for this post type.',
];
}
$config['sockets']['export_mi_post_types']['items'][ 'mi_post_type_' . $post_type . '_end' ] = [
'type' => 'divider',
'html' => '',
];
}
// Must-Import options.
$config['sockets']['export_mi_options'] = [
'label' => 'Site Options and Theme-Mods',
'items' => [
'mi_exported_pre_options' => [
'type' => 'tags',
'label' => 'Pre Content-Import Site Options Keys',
'description' => 'Select which site options keys should be imported before importing the must-import content.',
'options' => $this->get_options_select_list(),
],
'mi_exported_post_options' => [
'type' => 'tags',
'label' => 'Post Content-Import Site Options Keys',
'description' => 'Select which site options keys should be imported after the must-import content has been imported.',
'options' => $this->get_options_select_list(),
],
'mi_exported_pre_theme_mods' => [
'type' => 'tags',
'label' => 'Pre Content-Import Theme-Mods Keys',
'description' => 'Select which theme_mod keys should be imported before importing must-import content.',
'options' => $this->get_theme_mods_select_list(),
],
'mi_exported_post_theme_mods' => [
'type' => 'tags',
'label' => 'Post Content-Import Theme-Mods Keys',
'description' => 'Select which theme_mod keys should be imported after importing must-import content.',
'options' => $this->get_theme_mods_select_list(),
],
],
];
/**
* OPTIONAL-IMPORT GROUP SOCKETS.
*/
$config['sockets']['export_media'] = [
'label' => 'Media',
'items' => [
'placeholders' => [
'type' => 'gallery',
'label' => 'Placeholder Images',
'description' => 'Pick a set of images which should <strong>replace post content images.</strong> Assume the order in which these images will be chosen is <em>random.</em>',
],
'ignored_images' => [
'type' => 'gallery',
'label' => 'Ignored Images',
'description' => 'Pick a set of images to be <strong>ignored from replacement</strong> in the exported content. They will be exported as they are.',
],
],
];
$config['sockets']['export_post_types'] = [
'label' => 'Content (posts & taxonomies)',
'items' => [],
];
foreach ( $post_types as $post_type => $post_type_config ) {
if ( 'attachment' === $post_type ) {
continue;
}
$config['sockets']['export_post_types']['items'][ 'post_type_' . $post_type . '_start' ] = [
'type' => 'divider',
'html' => $post_type,
];
$config['sockets']['export_post_types']['items'][ 'post_type_' . $post_type ] = [
'type' => 'post_select',
'label' => $post_type_config->label,
'query' => [
'post_type' => $post_type,
],
];
$taxonomy_objects = get_object_taxonomies( $post_type, 'objects' );
if ( ! empty( $taxonomy_objects ) ) {
foreach ( $taxonomy_objects as $tax => $tax_config ) {
if ( in_array( $tax, [
'feedback',
'jp_pay_order',
'jp_pay_product',
'post_format',
'product_type',
'product_visibility',
'product_shipping_class',
'wp_template_part_area',
'wp_theme',
] ) ) {
continue;
}
$config['sockets']['export_post_types']['items'][ 'tax_' . $tax ] = [
'type' => 'tax_select',
'label' => $tax_config->label,
'query' => [
'taxonomy' => $tax,
],
];
}
}
// Add post type specific media items.
if ( in_array( $post_type, $post_types_with_specific_media ) ) {
$config['sockets']['export_post_types']['items'][ 'post_type_' . $post_type . '_media_placeholders' ] = [
'type' => 'gallery',
'label' => 'Placeholder Images',
'description' => 'Pick a set of images which should <strong>replace post content images, for ' . $post_type . '.</strong> Assume the order in which these images will be chosen is <em>random.</em><br>Leave empty to use the general placeholder images, for this post type.',
];
$config['sockets']['export_post_types']['items'][ 'post_type_' . $post_type . '_media_ignored_images' ] = [
'type' => 'gallery',
'label' => 'Ignored Images',
'description' => 'Pick a set of images to be <strong>ignored from replacement</strong> in the exported content, for ' . $post_type . '. They will be exported as they are.<br>Leave empty to use the general ignored images, for this post type.',
];
}
$config['sockets']['export_post_types']['items'][ 'post_type_' . $post_type . '_end' ] = [
'type' => 'divider',
'html' => '',
];
}
$config['sockets']['export_options'] = [
'label' => 'Site Options and Theme-Mods',
'items' => [
'exported_pre_options' => [
'type' => 'tags',
'label' => 'Pre Content-Import Site Options Keys',
'description' => 'Select which site options keys should be imported before importing the content. There is no need to include must-import options.',
'options' => $this->get_options_select_list(),
],
'exported_post_options' => [
'type' => 'tags',
'label' => 'Post Content-Import Site Options Keys',
'description' => 'Select which site options keys should be imported after the content has been imported. There is no need to include must-import options.',
'options' => $this->get_options_select_list(),
],
'exported_pre_theme_mods' => [
'type' => 'tags',
'label' => 'Pre Content-Import Theme-Mods Keys',
'description' => 'Select which theme_mod keys should be imported before importing content. There is no need to include must-import theme_mods.',
'options' => $this->get_theme_mods_select_list(),
],
'ignored_post_theme_mods' => [
'type' => 'tags',
'label' => 'Ignored Theme-Mods Keys',
'description' => '<strong>All remaining theme mods are imported after the content import,</strong> but you can chose to ignore certain keys.',
'options' => $this->get_theme_mods_select_list(),
],
],
];
return $config;
}
/**
* Get the list of site options to be available in selects.
*
* We will not include all site options, but only those that we believe are relevant for export.
*
* Others may be manually "selected" if the control allows it (like the `tags` control does).
*
* @return array An array with key => value pairs. The key is the select option value, while the value is the select option label.
*/
protected function get_options_select_list(): array {
$select_options = [];
// Do not include the current theme theme_mods entry, since we provide dedicated fields for theme_mods.
$options = wp_load_alloptions();
// If the theme's Style Manager option key is present, include it.
// This key is used when Style Manager is instructed to save customization option in the site options instead of theme_mods.
if ( function_exists( '\Pixelgrade\StyleManager\get_options_key' ) ) {
$sm_options_key = \Pixelgrade\StyleManager\get_options_key();
if ( isset( $options[ $sm_options_key ] ) ) {
$select_options[ $sm_options_key ] = $sm_options_key;
// Include all relevant sub-entries.
$options[ $sm_options_key ] = maybe_unserialize( $options[ $sm_options_key ] );
if ( ! empty( $options[ $sm_options_key ] ) && is_array( $options[ $sm_options_key ] ) ) {
foreach ( $options[ $sm_options_key ] as $mod_name => $mod_value ) {
$select_options[ $sm_options_key . '[' . $mod_name . ']' ] = $sm_options_key . '[' . $mod_name . ']';
}
}
}
}
// Include all Style Manager options.
foreach ( $options as $option_name => $option_value ) {
if ( 0 === strpos( $option_name, 'sm_' ) ) {
$select_options[ $option_name ] = $option_name;
}
}
return $select_options;
}
/**
* Get the list of theme_mods options to be available in selects.
*
* We will not include all theme_mods options, but only those that we believe are relevant for export.
*
* Others may be manually "selected" if the control allows it (like the `tags` control does).
*
* @return array
*/
protected function get_theme_mods_select_list(): array {
$select_options = [];
$theme_mods = get_theme_mods();
// Include all theme_mods options, except those that should be ignored.
foreach ( $theme_mods as $mod_name => $mod_value ) {
if ( ! in_array( $mod_name, $this->ignored_theme_mods ) ) {
$select_options[ $mod_name ] = $mod_name;
}
}
// If the theme's Style Manager option key is present, include it.
// This key is used when Style Manager is instructed to save customization option in the site options instead of theme_mods.
if ( function_exists( '\Pixelgrade\StyleManager\get_options_key' ) ) {
$sm_options_key = \Pixelgrade\StyleManager\get_options_key();
// Include all relevant sub-entries.
if ( ! empty( $theme_mods[ $sm_options_key ] ) ) {
foreach ( $theme_mods[ $sm_options_key ] as $mod_name => $mod_value ) {
$select_options[ $sm_options_key . '[' . $mod_name . ']' ] = $sm_options_key . '[' . $mod_name . ']';
}
}
}
return $select_options;
}
/**
* REST API Endpoints that follow our common standard of response:
* - code
* - message
* - data
*/
public function add_rest_routes_api_v2() {
/**
* Register endpoints for fetching the overall data.
*
* One for must-import data, and the another one for optional data.
*/
register_rest_route( 'sce/v2', '/mi-data', [
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'rest_export_mi_data_v2' ],
'permission_callback' => '__return_true',
] );
register_rest_route( 'sce/v2', '/data', [
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'rest_export_data_v2' ],
'permission_callback' => '__return_true',
] );
/**
* Register endpoints for fetching individual data details.
*/
register_rest_route( 'sce/v2', '/media', [
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'rest_export_media_v2' ],
'permission_callback' => '__return_true',
] );
register_rest_route( 'sce/v2', '/posts', [
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'rest_export_posts_v2' ],
'permission_callback' => '__return_true',
'args' => [
'include' => [
'required' => true,
],
],
] );
register_rest_route( 'sce/v2', '/terms', [
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'rest_export_terms_v2' ],
'permission_callback' => '__return_true',
'args' => [
'include' => [
'required' => true,
],
],
] );
register_rest_route( 'sce/v2', '/widgets', [
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'rest_export_widgets_v2' ],
'permission_callback' => '__return_true',
] );
}
/**
* Handle requests for must-import data.
*
* @return WP_Error|WP_HTTP_Response|WP_REST_Response
*/
public function rest_export_mi_data_v2() {
$options = get_option( 'starter_content_exporter' );
$data = [
'media' => [
'placeholders' => [],
'ignored' => [],
],
'post_types' => [],
'taxonomies' => [],
'pre_settings' => [],
'post_settings' => [],
];
if ( ! empty( $options['mi_placeholders'] ) ) {
$data['media']['placeholders'] = $this->validate_attachment_ids( wp_parse_id_list( $options['mi_placeholders'] ) );
}
if ( ! empty( $options['mi_ignored_images'] ) ) {
$data['media']['ignored'] = $this->validate_attachment_ids( wp_parse_id_list( $options['mi_ignored_images'] ) );
}
if ( ! empty( $options ) ) {
foreach ( $options as $key => $option ) {
if ( strpos( $key, 'mi_post_type_' ) !== false ) {
// We are dealing with a post type related item,
// but we need to differentiate between posts ids items and media items.
$post_type = str_replace( 'mi_post_type_', '', $key );
if ( strpos( $post_type, '_media_placeholders' ) !== false ) {
$post_type = str_replace( '_media_placeholders', '', $post_type );
} else if ( strpos( $post_type, '_media_ignored_images' ) !== false ) {
$post_type = str_replace( '_media_ignored_images', '', $post_type );
}
$priority = 10;
/**
* We need to make sure that the navigation items are imported at the end.
* The metadata of a menu item can contain an object_id which should be mapped, but we can only map existing IDs.
*/
if ( in_array( $post_type, [ 'nav_menu_item', 'wp_navigation', ] ) ) {
$priority = 900;
}
/**
* We need to make sure that the wp_template and wp_template_part items are imported at the end.
* Templates and template parts might reference posts (like wp_navigation posts) which should be mapped, but we can only map existing IDs.
*/
if ( in_array( $post_type, [ 'wp_template', 'wp_template_part', ] ) ) {
$priority = 910;
}
if ( empty( $data['post_types'][ $post_type ] ) ) {
$data['post_types'][ $post_type ] = [];
}
$data['post_types'][ $post_type ] = wp_parse_args( $data['post_types'][ $post_type ], [
'name' => $post_type,
'ids' => [],
'media' => [
'placeholders' => [],
'ignored' => [],
],
'priority' => $priority, // for now all will have the same priority
] );
if ( strpos( $key, '_media_placeholders' ) !== false ) {
$data['post_types'][ $post_type ]['media']['placeholders'] = $this->validate_attachment_ids( wp_parse_id_list( $option ) );
} else if ( strpos( $key, '_media_ignored_images' ) !== false ) {
$data['post_types'][ $post_type ]['media']['ignored'] = $this->validate_attachment_ids( wp_parse_id_list( $option ) );
} else {
$data['post_types'][ $post_type ]['ids'] = wp_parse_id_list( $option );
}
} elseif ( strpos( $key, 'mi_tax_' ) !== false ) {
$taxonomy = str_replace( 'mi_tax_', '', $key );
$data['taxonomies'][ $taxonomy ] = [
'name' => $taxonomy,
'ids' => wp_parse_id_list( $option ),
'priority' => 10, // for now all will have the same priority
];
}
}
}
$data['pre_settings'] = $this->get_mi_pre_settings();
$data['post_settings'] = $this->get_mi_post_settings();
return rest_ensure_response( [
'code' => 'success',
'message' => '',
'data' => $data,
] );
}
public function rest_export_data_v2() {
$options = get_option( 'starter_content_exporter' );
$data = [
'media' => [
'placeholders' => [],
'ignored' => [],
],
'post_types' => [],
'taxonomies' => [],
'widgets' => $this->get_widgets(),
'pre_settings' => [],
'post_settings' => [],
];
if ( ! empty( $options['placeholders'] ) ) {
$data['media']['placeholders'] = $this->validate_attachment_ids( wp_parse_id_list( $options['placeholders'] ) );
}
if ( ! empty( $options['ignored_images'] ) ) {
$data['media']['ignored'] = $this->validate_attachment_ids( wp_parse_id_list( $options['ignored_images'] ) );
}
if ( ! empty( $options ) ) {
foreach ( $options as $key => $option ) {
if ( strpos( $key, 'post_type_' ) !== false && strpos( $key, 'mi_post_type_' ) === false ) {
// We are dealing with a post type related item,
// but we need to differentiate between posts ids items and media items.
$post_type = str_replace( 'post_type_', '', $key );
if ( strpos( $post_type, '_media_placeholders' ) !== false ) {
$post_type = str_replace( '_media_placeholders', '', $post_type );
} else if ( strpos( $post_type, '_media_ignored_images' ) !== false ) {
$post_type = str_replace( '_media_ignored_images', '', $post_type );
}
$priority = 10;
/**
* We need to make sure that the navigation items are imported at the end.
* The metadata of a menu item can contain an object_id which should be mapped, but we can only map existing IDs.
*/
if ( in_array( $post_type, [ 'nav_menu_item', 'wp_navigation', ] ) ) {
$priority = 900;
}
/**
* We need to make sure that the wp_template and wp_template_part items are imported at the end.
* Templates and template parts might reference posts (like wp_navigation posts) which should be mapped, but we can only map existing IDs.
*/
if ( in_array( $post_type, [ 'wp_template', 'wp_template_part', ] ) ) {
$priority = 910;
}
if ( empty( $data['post_types'][ $post_type ] ) ) {
$data['post_types'][ $post_type ] = [];
}
$data['post_types'][ $post_type ] = wp_parse_args( $data['post_types'][ $post_type ], [
'name' => $post_type,
'ids' => [],
'media' => [
'placeholders' => [],
'ignored' => [],
],
'priority' => $priority, // for now all will have the same priority
] );
if ( strpos( $key, '_media_placeholders' ) !== false ) {
$data['post_types'][ $post_type ]['media']['placeholders'] = $this->validate_attachment_ids( wp_parse_id_list( $option ) );
} else if ( strpos( $key, '_media_ignored_images' ) !== false ) {
$data['post_types'][ $post_type ]['media']['ignored'] = $this->validate_attachment_ids( wp_parse_id_list( $option ) );
} else {
$data['post_types'][ $post_type ]['ids'] = wp_parse_id_list( $option );
}
} elseif ( strpos( $key, 'tax_' ) !== false && strpos( $key, 'mi_tax_' ) === false ) {
$taxonomy = str_replace( 'tax_', '', $key );
$data['taxonomies'][ $taxonomy ] = [
'name' => $taxonomy,
'ids' => wp_parse_id_list( $option ),
'priority' => 10, // For now on will have the same priority.
];
}
}
}
$data['pre_settings'] = $this->get_pre_settings();
$data['post_settings'] = $this->get_post_settings();
return rest_ensure_response( [
'code' => 'success',
'message' => '',
'data' => $data,
] );
}
protected function validate_attachment_ids( $attachment_ids ): array {
if ( empty( $attachment_ids ) ) {
$attachment_ids = [];
}
// Go through each one and make sure that they exist.
foreach ( $attachment_ids as $key => $attachment_id ) {
$attachment_id = absint( $attachment_id );
$file_path = get_attached_file( $attachment_id );
if ( empty( $file_path ) || ! file_exists( $file_path ) ) {
unset( $attachment_ids[ $key ] );
}
}
return $attachment_ids;
}
/**
* @param WP_REST_Request $request
*
* @return WP_REST_Response
*/
public function rest_export_posts_v2( WP_REST_Request $request ): WP_REST_Response {
$params = $request->get_params();
$query_args = array(
'post__in' => empty( $params['include'] ) ? [] : wp_parse_id_list( $params['include'] ),
'posts_per_page' => 100,
'post_type' => 'any',
'no_found_rows' => true,
'ignore_sticky_posts' => true,
);
if ( ! empty( $params['post_type'] ) ) {
$query_args['post_type'] = sanitize_text_field( $params['post_type'] );
}
$get_posts = new WP_Query();
$posts = $get_posts->query( $query_args );
foreach ( $posts as &$post ) {
$post->meta = apply_filters( 'sce_export_prepare_post_meta', get_post_meta( $post->ID ), $post, $request );
$post->post_content = apply_filters( 'sce_export_prepare_post_content', $post->post_content, $post, $request );
$post->taxonomies = [];
foreach ( array_values( get_post_taxonomies( $post ) ) as $taxonomy ) {
$fields = 'names';
if ( is_taxonomy_hierarchical( $taxonomy ) ) {
$fields = 'ids';
}
$current_tax = wp_get_object_terms( $post->ID, $taxonomy, [
'fields' => $fields,
] );
if ( ! is_wp_error( $current_tax ) && ! empty( $current_tax ) ) {
$post->taxonomies[ $taxonomy ] = $current_tax;
} else {
unset( $post->taxonomies[ $taxonomy ] );
}
}
}
return rest_ensure_response( [
'code' => 'success',
'message' => '',
'data' => [
'posts' => $posts,
],
] );
}
/**
* Filter the post content and deal with the images in it.
*
* @param string $content
* @param WP_Post $post
* @param WP_REST_Request $request
*
* @return string
*/
public function parse_content_for_images( string $content, WP_Post $post, WP_REST_Request $request ): string {
// Since we are in the Gutenberg age now, we need to do a better job in dealing with blocks that hold images.
// Mainly wp:image since wp:gallery is comprised of wp:images.
if ( has_blocks( $content ) ) {
$content = $this->handle_images_in_content_with_blocks( $content, $request );
} else {
$upload_dir = wp_get_upload_dir();
$explode = explode( '/wp-content/uploads/', $upload_dir['baseurl'] );
$base_url = '/wp-content/uploads/';
if ( ! empty( $explode[1] ) ) {
$base_url = trailingslashit( '/wp-content/uploads/' . $explode[1] );
}
$attachments_regex = '~(?<=src=\").+((' . $base_url . ')|(files\.wordpress\.com)).+(?=[\"\ ])~U';
preg_match_all( $attachments_regex, $content, $result );
if ( ! empty( $result[0] ) && is_array( $result[0] ) ) {
foreach ( $result[0] as $i => $match ) {
$original_image_url = $match;
$new_url = $this->get_rotated_placeholder_url( $original_image_url, $request );
$content = str_replace( $original_image_url, $new_url, $content );
}
}
// Search for shortcodes with attachments ids like gallery.
if ( has_shortcode( $content, 'gallery' ) ) {
$content = $this->replace_gallery_shortcodes_ids( $content, $request );
}
}
return $content;
}
protected function handle_images_in_content_with_blocks( string $post_content, WP_REST_Request $request ): string {
// We will only do the work for post content with blocks and if the WP version is at least 5.9.
if ( ! has_blocks( $post_content ) || ! version_compare( get_bloginfo( 'version' ), '5.9', '>=' ) ) {
return $post_content;
}
$upload_dir = wp_get_upload_dir();
$explode = explode( '/wp-content/uploads/', $upload_dir['baseurl'] );
$base_url = '/wp-content/uploads/';
if ( ! empty( $explode[1] ) ) {
$base_url = trailingslashit( '/wp-content/uploads/' . $explode[1] );
}
$attachments_regex = '~(?<=src=\").+((' . $base_url . ')|(files\.wordpress\.com)).+(?=[\"\ ])~U';
$media_link_regex = '~(?<=href=\").+((' . $base_url . ')|(files\.wordpress\.com)).+(?=[\"\ ])~U';
$has_updated_content = false;
$new_content = '';
$template_blocks = parse_blocks( $post_content );
$blocks = _flatten_blocks( $template_blocks );
foreach ( $blocks as &$block ) {
// Handle all the blocks that may need handling.
// Replace attachment ids in wp:image block and the img src that is inside it.
if (
'core/image' === $block['blockName'] &&
! empty( $block['attrs']['id'] )
) {
$original_wp_image_id = absint( $block['attrs']['id'] );
$replacement_media_details = $this->get_rotated_placeholder( $original_wp_image_id, $request );
if ( empty( $replacement_media_details['id'] ) ) {
continue;
}
// Set the replacement attachment ID in the block attributes.
// This is the attachment ID as imported by the requesting website.
$block['attrs']['id'] = $replacement_media_details['id'];
$has_updated_content = true;
if ( empty( $block['innerContent'] ) ) {
continue;
}
// Now deal with the inner content of the block (the <img> mainly).
$replacement_size = 'full';
if ( ! empty( $block['attrs']['sizeSlug'] ) && ! empty( $replacement_media_details['sizes'][ $block['attrs']['sizeSlug'] ] ) ) {
$replacement_size = esc_attr( $block['attrs']['sizeSlug'] );
}
foreach ( $block['innerContent'] as $key => $inner_content ) {
// Replace the URL in the <img> src attribute.