@@ -19,88 +19,88 @@ |
||
19 | 19 | */ |
20 | 20 | class Wordlift_Image_Service { |
21 | 21 | |
22 | - /** |
|
23 | - * The image ratios and sizes. |
|
24 | - * |
|
25 | - * @since 3.19.4 |
|
26 | - * @access public |
|
27 | - * @var array $sizes The image ratios and sizes. |
|
28 | - */ |
|
29 | - public static $sizes = array( |
|
30 | - '16x9' => array( 1200, 675 ), |
|
31 | - '4x3' => array( 1200, 900 ), |
|
32 | - '1x1' => array( 1200, 1200 ), |
|
33 | - ); |
|
34 | - |
|
35 | - /** |
|
36 | - * Create a {@link Wordlift_Image_Service} instance. |
|
37 | - * |
|
38 | - * @since 3.19.4 |
|
39 | - */ |
|
40 | - public function __construct() { |
|
41 | - |
|
42 | - // Add hook to define the image sizes. Since we're a plugin, we cannot use the |
|
43 | - // `after_theme_setup` hook. |
|
44 | - add_action( 'init', array( $this, 'after_theme_setup' ) ); |
|
45 | - |
|
46 | - } |
|
47 | - |
|
48 | - /** |
|
49 | - * Hook `after_theme_setup`: add our own image sizes. |
|
50 | - * |
|
51 | - * @since 3.19.4 |
|
52 | - */ |
|
53 | - public function after_theme_setup() { |
|
54 | - |
|
55 | - foreach ( self::$sizes as $ratio => $sizes ) { |
|
56 | - add_image_size( "wl-$ratio", $sizes[0], $sizes[1], true ); |
|
57 | - } |
|
58 | - |
|
59 | - } |
|
60 | - |
|
61 | - /** |
|
62 | - * Get the sources for the specified attachment. |
|
63 | - * |
|
64 | - * @since 3.19.4 |
|
65 | - * |
|
66 | - * @param int $attachment_id The attachment id. |
|
67 | - * |
|
68 | - * @return array { |
|
69 | - * An array of image sources. |
|
70 | - * |
|
71 | - * @type string $url The attachment URL. |
|
72 | - * @type int $width The attachment width. |
|
73 | - * @type int $height The attachment height. |
|
74 | - * } |
|
75 | - */ |
|
76 | - public static function get_sources( $attachment_id ) { |
|
77 | - |
|
78 | - // Get the source for the specified image sizes. |
|
79 | - $sources = array_map( |
|
80 | - function ( $ratio ) use ( $attachment_id ) { |
|
81 | - |
|
82 | - // Get the source of the specified ratio. |
|
83 | - $source = wp_get_attachment_image_src( $attachment_id, "wl-$ratio" ); |
|
84 | - |
|
85 | - // Get the size for the specified ratio. |
|
86 | - $size = Wordlift_Image_Service::$sizes[ $ratio ]; |
|
87 | - |
|
88 | - // Check that the source has an image, and the required size. |
|
89 | - if ( empty( $source[0] ) || $size[0] !== $source[1] || $size[1] !== $source[2] ) { |
|
90 | - return null; |
|
91 | - } |
|
92 | - |
|
93 | - // Return the source. |
|
94 | - return $source; |
|
95 | - }, |
|
96 | - array_keys( self::$sizes ) |
|
97 | - ); |
|
98 | - |
|
99 | - // Filter unavailable sources. |
|
100 | - $sources_1200 = array_filter( $sources ); |
|
101 | - |
|
102 | - // Make the results unique. |
|
103 | - return $sources_1200; |
|
104 | - } |
|
22 | + /** |
|
23 | + * The image ratios and sizes. |
|
24 | + * |
|
25 | + * @since 3.19.4 |
|
26 | + * @access public |
|
27 | + * @var array $sizes The image ratios and sizes. |
|
28 | + */ |
|
29 | + public static $sizes = array( |
|
30 | + '16x9' => array( 1200, 675 ), |
|
31 | + '4x3' => array( 1200, 900 ), |
|
32 | + '1x1' => array( 1200, 1200 ), |
|
33 | + ); |
|
34 | + |
|
35 | + /** |
|
36 | + * Create a {@link Wordlift_Image_Service} instance. |
|
37 | + * |
|
38 | + * @since 3.19.4 |
|
39 | + */ |
|
40 | + public function __construct() { |
|
41 | + |
|
42 | + // Add hook to define the image sizes. Since we're a plugin, we cannot use the |
|
43 | + // `after_theme_setup` hook. |
|
44 | + add_action( 'init', array( $this, 'after_theme_setup' ) ); |
|
45 | + |
|
46 | + } |
|
47 | + |
|
48 | + /** |
|
49 | + * Hook `after_theme_setup`: add our own image sizes. |
|
50 | + * |
|
51 | + * @since 3.19.4 |
|
52 | + */ |
|
53 | + public function after_theme_setup() { |
|
54 | + |
|
55 | + foreach ( self::$sizes as $ratio => $sizes ) { |
|
56 | + add_image_size( "wl-$ratio", $sizes[0], $sizes[1], true ); |
|
57 | + } |
|
58 | + |
|
59 | + } |
|
60 | + |
|
61 | + /** |
|
62 | + * Get the sources for the specified attachment. |
|
63 | + * |
|
64 | + * @since 3.19.4 |
|
65 | + * |
|
66 | + * @param int $attachment_id The attachment id. |
|
67 | + * |
|
68 | + * @return array { |
|
69 | + * An array of image sources. |
|
70 | + * |
|
71 | + * @type string $url The attachment URL. |
|
72 | + * @type int $width The attachment width. |
|
73 | + * @type int $height The attachment height. |
|
74 | + * } |
|
75 | + */ |
|
76 | + public static function get_sources( $attachment_id ) { |
|
77 | + |
|
78 | + // Get the source for the specified image sizes. |
|
79 | + $sources = array_map( |
|
80 | + function ( $ratio ) use ( $attachment_id ) { |
|
81 | + |
|
82 | + // Get the source of the specified ratio. |
|
83 | + $source = wp_get_attachment_image_src( $attachment_id, "wl-$ratio" ); |
|
84 | + |
|
85 | + // Get the size for the specified ratio. |
|
86 | + $size = Wordlift_Image_Service::$sizes[ $ratio ]; |
|
87 | + |
|
88 | + // Check that the source has an image, and the required size. |
|
89 | + if ( empty( $source[0] ) || $size[0] !== $source[1] || $size[1] !== $source[2] ) { |
|
90 | + return null; |
|
91 | + } |
|
92 | + |
|
93 | + // Return the source. |
|
94 | + return $source; |
|
95 | + }, |
|
96 | + array_keys( self::$sizes ) |
|
97 | + ); |
|
98 | + |
|
99 | + // Filter unavailable sources. |
|
100 | + $sources_1200 = array_filter( $sources ); |
|
101 | + |
|
102 | + // Make the results unique. |
|
103 | + return $sources_1200; |
|
104 | + } |
|
105 | 105 | |
106 | 106 | } |
@@ -27,9 +27,9 @@ discard block |
||
27 | 27 | * @var array $sizes The image ratios and sizes. |
28 | 28 | */ |
29 | 29 | public static $sizes = array( |
30 | - '16x9' => array( 1200, 675 ), |
|
31 | - '4x3' => array( 1200, 900 ), |
|
32 | - '1x1' => array( 1200, 1200 ), |
|
30 | + '16x9' => array(1200, 675), |
|
31 | + '4x3' => array(1200, 900), |
|
32 | + '1x1' => array(1200, 1200), |
|
33 | 33 | ); |
34 | 34 | |
35 | 35 | /** |
@@ -41,7 +41,7 @@ discard block |
||
41 | 41 | |
42 | 42 | // Add hook to define the image sizes. Since we're a plugin, we cannot use the |
43 | 43 | // `after_theme_setup` hook. |
44 | - add_action( 'init', array( $this, 'after_theme_setup' ) ); |
|
44 | + add_action('init', array($this, 'after_theme_setup')); |
|
45 | 45 | |
46 | 46 | } |
47 | 47 | |
@@ -52,8 +52,8 @@ discard block |
||
52 | 52 | */ |
53 | 53 | public function after_theme_setup() { |
54 | 54 | |
55 | - foreach ( self::$sizes as $ratio => $sizes ) { |
|
56 | - add_image_size( "wl-$ratio", $sizes[0], $sizes[1], true ); |
|
55 | + foreach (self::$sizes as $ratio => $sizes) { |
|
56 | + add_image_size("wl-$ratio", $sizes[0], $sizes[1], true); |
|
57 | 57 | } |
58 | 58 | |
59 | 59 | } |
@@ -73,31 +73,31 @@ discard block |
||
73 | 73 | * @type int $height The attachment height. |
74 | 74 | * } |
75 | 75 | */ |
76 | - public static function get_sources( $attachment_id ) { |
|
76 | + public static function get_sources($attachment_id) { |
|
77 | 77 | |
78 | 78 | // Get the source for the specified image sizes. |
79 | 79 | $sources = array_map( |
80 | - function ( $ratio ) use ( $attachment_id ) { |
|
80 | + function($ratio) use ($attachment_id) { |
|
81 | 81 | |
82 | 82 | // Get the source of the specified ratio. |
83 | - $source = wp_get_attachment_image_src( $attachment_id, "wl-$ratio" ); |
|
83 | + $source = wp_get_attachment_image_src($attachment_id, "wl-$ratio"); |
|
84 | 84 | |
85 | 85 | // Get the size for the specified ratio. |
86 | - $size = Wordlift_Image_Service::$sizes[ $ratio ]; |
|
86 | + $size = Wordlift_Image_Service::$sizes[$ratio]; |
|
87 | 87 | |
88 | 88 | // Check that the source has an image, and the required size. |
89 | - if ( empty( $source[0] ) || $size[0] !== $source[1] || $size[1] !== $source[2] ) { |
|
89 | + if (empty($source[0]) || $size[0] !== $source[1] || $size[1] !== $source[2]) { |
|
90 | 90 | return null; |
91 | 91 | } |
92 | 92 | |
93 | 93 | // Return the source. |
94 | 94 | return $source; |
95 | 95 | }, |
96 | - array_keys( self::$sizes ) |
|
96 | + array_keys(self::$sizes) |
|
97 | 97 | ); |
98 | 98 | |
99 | 99 | // Filter unavailable sources. |
100 | - $sources_1200 = array_filter( $sources ); |
|
100 | + $sources_1200 = array_filter($sources); |
|
101 | 101 | |
102 | 102 | // Make the results unique. |
103 | 103 | return $sources_1200; |
@@ -14,211 +14,211 @@ |
||
14 | 14 | */ |
15 | 15 | class Wordlift_Entity_Type_Taxonomy_Service { |
16 | 16 | |
17 | - /** |
|
18 | - * The WordPress taxonomy name. |
|
19 | - * |
|
20 | - * @since 1.0.0 |
|
21 | - */ |
|
22 | - const TAXONOMY_NAME = 'wl_entity_type'; |
|
23 | - |
|
24 | - /** |
|
25 | - * Register the taxonomies. |
|
26 | - * |
|
27 | - * @since 3.23.6 we hook to `wp_get_object_terms` to ensure that a term is returned when a post is queries for the |
|
28 | - * `wl_entity_type` taxonomy. |
|
29 | - * @since 3.18.0 |
|
30 | - */ |
|
31 | - public function init() { |
|
32 | - |
|
33 | - $labels = array( |
|
34 | - 'name' => _x( 'Entity Types', 'taxonomy general name', 'wordlift' ), |
|
35 | - 'singular_name' => _x( 'Entity Type', 'taxonomy singular name', 'wordlift' ), |
|
36 | - 'search_items' => __( 'Search Entity Types', 'wordlift' ), |
|
37 | - 'all_items' => __( 'All Entity Types', 'wordlift' ), |
|
38 | - 'parent_item' => __( 'Parent Entity Type', 'wordlift' ), |
|
39 | - 'parent_item_colon' => __( 'Parent Entity Type:', 'wordlift' ), |
|
40 | - 'edit_item' => __( 'Edit Entity Type', 'wordlift' ), |
|
41 | - 'update_item' => __( 'Update Entity Type', 'wordlift' ), |
|
42 | - 'add_new_item' => __( 'Add New Entity Type', 'wordlift' ), |
|
43 | - 'new_item_name' => __( 'New Entity Type', 'wordlift' ), |
|
44 | - 'menu_name' => __( 'Entity Types', 'wordlift' ), |
|
45 | - ); |
|
46 | - |
|
47 | - // Take away GUI for taxonomy editing. |
|
48 | - // TODO: read capabilities when editing of the WL <-> schema.org mapping is possible. |
|
49 | - $capabilities = array( |
|
50 | - // We enable editors to change the title/description of terms: |
|
51 | - // |
|
52 | - // @see https://github.com/insideout10/wordlift-plugin/issues/398. |
|
53 | - 'manage_terms' => 'manage_options', |
|
54 | - 'edit_terms' => 'wl_entity_type_edit_term', |
|
55 | - 'delete_terms' => 'wl_entity_type_delete_term', |
|
56 | - 'assign_terms' => 'edit_posts', |
|
57 | - ); |
|
58 | - |
|
59 | - $args = array( |
|
60 | - 'labels' => $labels, |
|
61 | - 'capabilities' => $capabilities, |
|
62 | - 'hierarchical' => true, |
|
63 | - // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
|
64 | - 'show_admin_column' => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ), |
|
65 | - // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
|
66 | - 'show_in_rest' => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ), |
|
67 | - 'show_in_quick_edit' => false, |
|
68 | - 'publicly_queryable' => false, |
|
69 | - ); |
|
70 | - |
|
71 | - /* |
|
17 | + /** |
|
18 | + * The WordPress taxonomy name. |
|
19 | + * |
|
20 | + * @since 1.0.0 |
|
21 | + */ |
|
22 | + const TAXONOMY_NAME = 'wl_entity_type'; |
|
23 | + |
|
24 | + /** |
|
25 | + * Register the taxonomies. |
|
26 | + * |
|
27 | + * @since 3.23.6 we hook to `wp_get_object_terms` to ensure that a term is returned when a post is queries for the |
|
28 | + * `wl_entity_type` taxonomy. |
|
29 | + * @since 3.18.0 |
|
30 | + */ |
|
31 | + public function init() { |
|
32 | + |
|
33 | + $labels = array( |
|
34 | + 'name' => _x( 'Entity Types', 'taxonomy general name', 'wordlift' ), |
|
35 | + 'singular_name' => _x( 'Entity Type', 'taxonomy singular name', 'wordlift' ), |
|
36 | + 'search_items' => __( 'Search Entity Types', 'wordlift' ), |
|
37 | + 'all_items' => __( 'All Entity Types', 'wordlift' ), |
|
38 | + 'parent_item' => __( 'Parent Entity Type', 'wordlift' ), |
|
39 | + 'parent_item_colon' => __( 'Parent Entity Type:', 'wordlift' ), |
|
40 | + 'edit_item' => __( 'Edit Entity Type', 'wordlift' ), |
|
41 | + 'update_item' => __( 'Update Entity Type', 'wordlift' ), |
|
42 | + 'add_new_item' => __( 'Add New Entity Type', 'wordlift' ), |
|
43 | + 'new_item_name' => __( 'New Entity Type', 'wordlift' ), |
|
44 | + 'menu_name' => __( 'Entity Types', 'wordlift' ), |
|
45 | + ); |
|
46 | + |
|
47 | + // Take away GUI for taxonomy editing. |
|
48 | + // TODO: read capabilities when editing of the WL <-> schema.org mapping is possible. |
|
49 | + $capabilities = array( |
|
50 | + // We enable editors to change the title/description of terms: |
|
51 | + // |
|
52 | + // @see https://github.com/insideout10/wordlift-plugin/issues/398. |
|
53 | + 'manage_terms' => 'manage_options', |
|
54 | + 'edit_terms' => 'wl_entity_type_edit_term', |
|
55 | + 'delete_terms' => 'wl_entity_type_delete_term', |
|
56 | + 'assign_terms' => 'edit_posts', |
|
57 | + ); |
|
58 | + |
|
59 | + $args = array( |
|
60 | + 'labels' => $labels, |
|
61 | + 'capabilities' => $capabilities, |
|
62 | + 'hierarchical' => true, |
|
63 | + // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
|
64 | + 'show_admin_column' => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ), |
|
65 | + // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
|
66 | + 'show_in_rest' => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ), |
|
67 | + 'show_in_quick_edit' => false, |
|
68 | + 'publicly_queryable' => false, |
|
69 | + ); |
|
70 | + |
|
71 | + /* |
|
72 | 72 | * If `All Entity Types` is enabled, use the new metabox. |
73 | 73 | * |
74 | 74 | * @see https://github.com/insideout10/wordlift-plugin/issues/835 |
75 | 75 | * @since 3.20.0 |
76 | 76 | */ |
77 | - // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
|
78 | - if ( apply_filters( 'wl_feature__enable__all-entity-types', WL_ALL_ENTITY_TYPES ) ) { |
|
79 | - // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
|
80 | - $args['meta_box_cb'] = apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ) ? array( |
|
81 | - 'Wordlift_Admin_Schemaorg_Taxonomy_Metabox', |
|
82 | - 'render', |
|
83 | - ) : false; |
|
84 | - } |
|
85 | - |
|
86 | - register_taxonomy( |
|
87 | - self::TAXONOMY_NAME, // Taxonomy name. |
|
88 | - Wordlift_Entity_Service::valid_entity_post_types(), // Taxonomy post types. |
|
89 | - $args // Taxonomy args. |
|
90 | - ); |
|
91 | - |
|
92 | - /** |
|
93 | - * Register meta wl_entities_gutenberg for use in Gutenberg |
|
94 | - */ |
|
95 | - register_meta( |
|
96 | - 'post', |
|
97 | - 'wl_entities_gutenberg', |
|
98 | - array( |
|
99 | - 'show_in_rest' => true, |
|
100 | - 'single' => true, |
|
101 | - 'type' => 'string', |
|
102 | - ) |
|
103 | - ); |
|
104 | - |
|
105 | - /** |
|
106 | - * Register meta _wl_alt_label for use in Gutenberg |
|
107 | - */ |
|
108 | - // register_meta( 'post', Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY, array( |
|
109 | - // 'object_subtype' => '', |
|
110 | - // 'show_in_rest' => true, |
|
111 | - // 'single' => false, |
|
112 | - // 'type' => 'string', |
|
113 | - // 'auth_callback' => function () { |
|
114 | - // return current_user_can( 'edit_posts' ); |
|
115 | - // } |
|
116 | - // ) ); |
|
117 | - |
|
118 | - // see #1364: add custom fields support for CPTs that are valid entity post types in order to be able to |
|
119 | - // query for synonyms in Block Editor. |
|
120 | - add_filter( |
|
121 | - 'register_post_type_args', |
|
122 | - function ( $args, $post_type ) { |
|
123 | - if ( in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true ) ) { |
|
124 | - if ( ! isset( $args['supports'] ) ) { |
|
125 | - $args['supports'] = array(); |
|
126 | - } |
|
127 | - $args['supports'][] = 'custom-fields'; |
|
128 | - } |
|
129 | - |
|
130 | - return $args; |
|
131 | - }, |
|
132 | - 10, |
|
133 | - 2 |
|
134 | - ); |
|
135 | - |
|
136 | - // Add filter to change the metabox CSS class. |
|
137 | - add_filter( 'postbox_classes_entity_wl_entity_typediv', 'wl_admin_metaboxes_add_css_class' ); |
|
138 | - |
|
139 | - // Add a filter to preset the object term if none is set. |
|
140 | - // |
|
141 | - // DO NOT hook to `wp_get_object_terms`, because `wp_get_object_terms` returns imploded values for SQL queries. |
|
142 | - // |
|
143 | - // @see https://github.com/insideout10/wordlift-plugin/issues/995 |
|
144 | - // @since 3.23.6 |
|
145 | - add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 ); |
|
146 | - |
|
147 | - /** |
|
148 | - * Exclude sitemap creation for wl_entity_type taxonomy in Yoast |
|
149 | - * |
|
150 | - * @since 3.30.1 |
|
151 | - */ |
|
152 | - add_filter( 'wpseo_sitemap_exclude_taxonomy', array( $this, 'wpseo_sitemap_exclude_taxonomy' ), 10, 2 ); |
|
153 | - |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * Hook to the `get_object_terms` filter. |
|
158 | - * |
|
159 | - * We check if our taxonomy is requested and whether a term has been returned. If no term has been returned we |
|
160 | - * preset `Article` for posts/pages and 'Thing' for everything else and we query the terms again. |
|
161 | - * |
|
162 | - * @param array $terms Array of terms for the given object or objects. |
|
163 | - * @param int[] $object_ids Array of object IDs for which terms were retrieved. |
|
164 | - * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved. |
|
165 | - * @param array $args Array of arguments for retrieving terms for the given |
|
166 | - * object(s). See get_object_terms() for details. |
|
167 | - * |
|
168 | - * @return array|WP_Error |
|
169 | - * @since 3.23.6 |
|
170 | - */ |
|
171 | - public function get_object_terms( $terms, $object_ids, $taxonomies, $args ) { |
|
172 | - // Get our entity type. |
|
173 | - $entity_type = self::TAXONOMY_NAME; |
|
174 | - |
|
175 | - // Check if this is a query for our entity type, that no terms have been found and that we have an article |
|
176 | - // term to preset in case. |
|
177 | - if ( ! taxonomy_exists( $entity_type ) |
|
178 | - || array( $entity_type ) !== (array) $taxonomies |
|
179 | - || ! empty( $terms ) |
|
180 | - || ! term_exists( 'article', $entity_type ) |
|
181 | - || ! term_exists( 'thing', $entity_type ) ) { |
|
182 | - |
|
183 | - // Return the input value. |
|
184 | - return $terms; |
|
185 | - } |
|
186 | - |
|
187 | - // Avoid nested calls in case of issues. |
|
188 | - remove_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10 ); |
|
189 | - |
|
190 | - // Set the default term for all the queried object. |
|
191 | - foreach ( (array) $object_ids as $object_id ) { |
|
192 | - $post_type = get_post_type( $object_id ); |
|
193 | - if ( Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post_type ) ) { |
|
194 | - // Set the term to article for posts and pages, or to thing for everything else. |
|
195 | - $uris = Wordlift_Entity_Type_Adapter::get_entity_types( $post_type ); |
|
196 | - foreach ( $uris as $uri ) { |
|
197 | - // set the uri based on post type. |
|
198 | - if ( 'http://schema.org/Article' === $uri || 'http://schema.org/Thing' === $uri ) { |
|
199 | - $uri = Wordlift_Entity_Service::TYPE_NAME === $post_type ? |
|
200 | - 'http://schema.org/Thing' : 'http://schema.org/Article'; |
|
201 | - } |
|
202 | - Wordlift_Entity_Type_Service::get_instance()->set( $object_id, $uri ); |
|
203 | - } |
|
204 | - } |
|
205 | - } |
|
206 | - |
|
207 | - // Finally return the object terms. |
|
208 | - $terms = wp_get_object_terms( $object_ids, $taxonomies, $args ); |
|
209 | - |
|
210 | - // Re-enable nested calls in case of issues. |
|
211 | - add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 ); |
|
212 | - |
|
213 | - return $terms; |
|
214 | - } |
|
215 | - |
|
216 | - public function wpseo_sitemap_exclude_taxonomy( $exclude, $tax ) { |
|
217 | - if ( self::TAXONOMY_NAME === $tax ) { |
|
218 | - return true; |
|
219 | - } |
|
220 | - |
|
221 | - return $exclude; |
|
222 | - } |
|
77 | + // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
|
78 | + if ( apply_filters( 'wl_feature__enable__all-entity-types', WL_ALL_ENTITY_TYPES ) ) { |
|
79 | + // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
|
80 | + $args['meta_box_cb'] = apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ) ? array( |
|
81 | + 'Wordlift_Admin_Schemaorg_Taxonomy_Metabox', |
|
82 | + 'render', |
|
83 | + ) : false; |
|
84 | + } |
|
85 | + |
|
86 | + register_taxonomy( |
|
87 | + self::TAXONOMY_NAME, // Taxonomy name. |
|
88 | + Wordlift_Entity_Service::valid_entity_post_types(), // Taxonomy post types. |
|
89 | + $args // Taxonomy args. |
|
90 | + ); |
|
91 | + |
|
92 | + /** |
|
93 | + * Register meta wl_entities_gutenberg for use in Gutenberg |
|
94 | + */ |
|
95 | + register_meta( |
|
96 | + 'post', |
|
97 | + 'wl_entities_gutenberg', |
|
98 | + array( |
|
99 | + 'show_in_rest' => true, |
|
100 | + 'single' => true, |
|
101 | + 'type' => 'string', |
|
102 | + ) |
|
103 | + ); |
|
104 | + |
|
105 | + /** |
|
106 | + * Register meta _wl_alt_label for use in Gutenberg |
|
107 | + */ |
|
108 | + // register_meta( 'post', Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY, array( |
|
109 | + // 'object_subtype' => '', |
|
110 | + // 'show_in_rest' => true, |
|
111 | + // 'single' => false, |
|
112 | + // 'type' => 'string', |
|
113 | + // 'auth_callback' => function () { |
|
114 | + // return current_user_can( 'edit_posts' ); |
|
115 | + // } |
|
116 | + // ) ); |
|
117 | + |
|
118 | + // see #1364: add custom fields support for CPTs that are valid entity post types in order to be able to |
|
119 | + // query for synonyms in Block Editor. |
|
120 | + add_filter( |
|
121 | + 'register_post_type_args', |
|
122 | + function ( $args, $post_type ) { |
|
123 | + if ( in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true ) ) { |
|
124 | + if ( ! isset( $args['supports'] ) ) { |
|
125 | + $args['supports'] = array(); |
|
126 | + } |
|
127 | + $args['supports'][] = 'custom-fields'; |
|
128 | + } |
|
129 | + |
|
130 | + return $args; |
|
131 | + }, |
|
132 | + 10, |
|
133 | + 2 |
|
134 | + ); |
|
135 | + |
|
136 | + // Add filter to change the metabox CSS class. |
|
137 | + add_filter( 'postbox_classes_entity_wl_entity_typediv', 'wl_admin_metaboxes_add_css_class' ); |
|
138 | + |
|
139 | + // Add a filter to preset the object term if none is set. |
|
140 | + // |
|
141 | + // DO NOT hook to `wp_get_object_terms`, because `wp_get_object_terms` returns imploded values for SQL queries. |
|
142 | + // |
|
143 | + // @see https://github.com/insideout10/wordlift-plugin/issues/995 |
|
144 | + // @since 3.23.6 |
|
145 | + add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 ); |
|
146 | + |
|
147 | + /** |
|
148 | + * Exclude sitemap creation for wl_entity_type taxonomy in Yoast |
|
149 | + * |
|
150 | + * @since 3.30.1 |
|
151 | + */ |
|
152 | + add_filter( 'wpseo_sitemap_exclude_taxonomy', array( $this, 'wpseo_sitemap_exclude_taxonomy' ), 10, 2 ); |
|
153 | + |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * Hook to the `get_object_terms` filter. |
|
158 | + * |
|
159 | + * We check if our taxonomy is requested and whether a term has been returned. If no term has been returned we |
|
160 | + * preset `Article` for posts/pages and 'Thing' for everything else and we query the terms again. |
|
161 | + * |
|
162 | + * @param array $terms Array of terms for the given object or objects. |
|
163 | + * @param int[] $object_ids Array of object IDs for which terms were retrieved. |
|
164 | + * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved. |
|
165 | + * @param array $args Array of arguments for retrieving terms for the given |
|
166 | + * object(s). See get_object_terms() for details. |
|
167 | + * |
|
168 | + * @return array|WP_Error |
|
169 | + * @since 3.23.6 |
|
170 | + */ |
|
171 | + public function get_object_terms( $terms, $object_ids, $taxonomies, $args ) { |
|
172 | + // Get our entity type. |
|
173 | + $entity_type = self::TAXONOMY_NAME; |
|
174 | + |
|
175 | + // Check if this is a query for our entity type, that no terms have been found and that we have an article |
|
176 | + // term to preset in case. |
|
177 | + if ( ! taxonomy_exists( $entity_type ) |
|
178 | + || array( $entity_type ) !== (array) $taxonomies |
|
179 | + || ! empty( $terms ) |
|
180 | + || ! term_exists( 'article', $entity_type ) |
|
181 | + || ! term_exists( 'thing', $entity_type ) ) { |
|
182 | + |
|
183 | + // Return the input value. |
|
184 | + return $terms; |
|
185 | + } |
|
186 | + |
|
187 | + // Avoid nested calls in case of issues. |
|
188 | + remove_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10 ); |
|
189 | + |
|
190 | + // Set the default term for all the queried object. |
|
191 | + foreach ( (array) $object_ids as $object_id ) { |
|
192 | + $post_type = get_post_type( $object_id ); |
|
193 | + if ( Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post_type ) ) { |
|
194 | + // Set the term to article for posts and pages, or to thing for everything else. |
|
195 | + $uris = Wordlift_Entity_Type_Adapter::get_entity_types( $post_type ); |
|
196 | + foreach ( $uris as $uri ) { |
|
197 | + // set the uri based on post type. |
|
198 | + if ( 'http://schema.org/Article' === $uri || 'http://schema.org/Thing' === $uri ) { |
|
199 | + $uri = Wordlift_Entity_Service::TYPE_NAME === $post_type ? |
|
200 | + 'http://schema.org/Thing' : 'http://schema.org/Article'; |
|
201 | + } |
|
202 | + Wordlift_Entity_Type_Service::get_instance()->set( $object_id, $uri ); |
|
203 | + } |
|
204 | + } |
|
205 | + } |
|
206 | + |
|
207 | + // Finally return the object terms. |
|
208 | + $terms = wp_get_object_terms( $object_ids, $taxonomies, $args ); |
|
209 | + |
|
210 | + // Re-enable nested calls in case of issues. |
|
211 | + add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 ); |
|
212 | + |
|
213 | + return $terms; |
|
214 | + } |
|
215 | + |
|
216 | + public function wpseo_sitemap_exclude_taxonomy( $exclude, $tax ) { |
|
217 | + if ( self::TAXONOMY_NAME === $tax ) { |
|
218 | + return true; |
|
219 | + } |
|
220 | + |
|
221 | + return $exclude; |
|
222 | + } |
|
223 | 223 | |
224 | 224 | } |
@@ -31,17 +31,17 @@ discard block |
||
31 | 31 | public function init() { |
32 | 32 | |
33 | 33 | $labels = array( |
34 | - 'name' => _x( 'Entity Types', 'taxonomy general name', 'wordlift' ), |
|
35 | - 'singular_name' => _x( 'Entity Type', 'taxonomy singular name', 'wordlift' ), |
|
36 | - 'search_items' => __( 'Search Entity Types', 'wordlift' ), |
|
37 | - 'all_items' => __( 'All Entity Types', 'wordlift' ), |
|
38 | - 'parent_item' => __( 'Parent Entity Type', 'wordlift' ), |
|
39 | - 'parent_item_colon' => __( 'Parent Entity Type:', 'wordlift' ), |
|
40 | - 'edit_item' => __( 'Edit Entity Type', 'wordlift' ), |
|
41 | - 'update_item' => __( 'Update Entity Type', 'wordlift' ), |
|
42 | - 'add_new_item' => __( 'Add New Entity Type', 'wordlift' ), |
|
43 | - 'new_item_name' => __( 'New Entity Type', 'wordlift' ), |
|
44 | - 'menu_name' => __( 'Entity Types', 'wordlift' ), |
|
34 | + 'name' => _x('Entity Types', 'taxonomy general name', 'wordlift'), |
|
35 | + 'singular_name' => _x('Entity Type', 'taxonomy singular name', 'wordlift'), |
|
36 | + 'search_items' => __('Search Entity Types', 'wordlift'), |
|
37 | + 'all_items' => __('All Entity Types', 'wordlift'), |
|
38 | + 'parent_item' => __('Parent Entity Type', 'wordlift'), |
|
39 | + 'parent_item_colon' => __('Parent Entity Type:', 'wordlift'), |
|
40 | + 'edit_item' => __('Edit Entity Type', 'wordlift'), |
|
41 | + 'update_item' => __('Update Entity Type', 'wordlift'), |
|
42 | + 'add_new_item' => __('Add New Entity Type', 'wordlift'), |
|
43 | + 'new_item_name' => __('New Entity Type', 'wordlift'), |
|
44 | + 'menu_name' => __('Entity Types', 'wordlift'), |
|
45 | 45 | ); |
46 | 46 | |
47 | 47 | // Take away GUI for taxonomy editing. |
@@ -61,9 +61,9 @@ discard block |
||
61 | 61 | 'capabilities' => $capabilities, |
62 | 62 | 'hierarchical' => true, |
63 | 63 | // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
64 | - 'show_admin_column' => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ), |
|
64 | + 'show_admin_column' => apply_filters('wl_feature__enable__entity-types-taxonomy', true), |
|
65 | 65 | // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
66 | - 'show_in_rest' => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ), |
|
66 | + 'show_in_rest' => apply_filters('wl_feature__enable__entity-types-taxonomy', true), |
|
67 | 67 | 'show_in_quick_edit' => false, |
68 | 68 | 'publicly_queryable' => false, |
69 | 69 | ); |
@@ -75,9 +75,9 @@ discard block |
||
75 | 75 | * @since 3.20.0 |
76 | 76 | */ |
77 | 77 | // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
78 | - if ( apply_filters( 'wl_feature__enable__all-entity-types', WL_ALL_ENTITY_TYPES ) ) { |
|
78 | + if (apply_filters('wl_feature__enable__all-entity-types', WL_ALL_ENTITY_TYPES)) { |
|
79 | 79 | // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
80 | - $args['meta_box_cb'] = apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ) ? array( |
|
80 | + $args['meta_box_cb'] = apply_filters('wl_feature__enable__entity-types-taxonomy', true) ? array( |
|
81 | 81 | 'Wordlift_Admin_Schemaorg_Taxonomy_Metabox', |
82 | 82 | 'render', |
83 | 83 | ) : false; |
@@ -119,9 +119,9 @@ discard block |
||
119 | 119 | // query for synonyms in Block Editor. |
120 | 120 | add_filter( |
121 | 121 | 'register_post_type_args', |
122 | - function ( $args, $post_type ) { |
|
123 | - if ( in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true ) ) { |
|
124 | - if ( ! isset( $args['supports'] ) ) { |
|
122 | + function($args, $post_type) { |
|
123 | + if (in_array($post_type, Wordlift_Entity_Service::valid_entity_post_types(), true)) { |
|
124 | + if ( ! isset($args['supports'])) { |
|
125 | 125 | $args['supports'] = array(); |
126 | 126 | } |
127 | 127 | $args['supports'][] = 'custom-fields'; |
@@ -134,7 +134,7 @@ discard block |
||
134 | 134 | ); |
135 | 135 | |
136 | 136 | // Add filter to change the metabox CSS class. |
137 | - add_filter( 'postbox_classes_entity_wl_entity_typediv', 'wl_admin_metaboxes_add_css_class' ); |
|
137 | + add_filter('postbox_classes_entity_wl_entity_typediv', 'wl_admin_metaboxes_add_css_class'); |
|
138 | 138 | |
139 | 139 | // Add a filter to preset the object term if none is set. |
140 | 140 | // |
@@ -142,14 +142,14 @@ discard block |
||
142 | 142 | // |
143 | 143 | // @see https://github.com/insideout10/wordlift-plugin/issues/995 |
144 | 144 | // @since 3.23.6 |
145 | - add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 ); |
|
145 | + add_filter('get_object_terms', array($this, 'get_object_terms'), 10, 4); |
|
146 | 146 | |
147 | 147 | /** |
148 | 148 | * Exclude sitemap creation for wl_entity_type taxonomy in Yoast |
149 | 149 | * |
150 | 150 | * @since 3.30.1 |
151 | 151 | */ |
152 | - add_filter( 'wpseo_sitemap_exclude_taxonomy', array( $this, 'wpseo_sitemap_exclude_taxonomy' ), 10, 2 ); |
|
152 | + add_filter('wpseo_sitemap_exclude_taxonomy', array($this, 'wpseo_sitemap_exclude_taxonomy'), 10, 2); |
|
153 | 153 | |
154 | 154 | } |
155 | 155 | |
@@ -168,53 +168,53 @@ discard block |
||
168 | 168 | * @return array|WP_Error |
169 | 169 | * @since 3.23.6 |
170 | 170 | */ |
171 | - public function get_object_terms( $terms, $object_ids, $taxonomies, $args ) { |
|
171 | + public function get_object_terms($terms, $object_ids, $taxonomies, $args) { |
|
172 | 172 | // Get our entity type. |
173 | 173 | $entity_type = self::TAXONOMY_NAME; |
174 | 174 | |
175 | 175 | // Check if this is a query for our entity type, that no terms have been found and that we have an article |
176 | 176 | // term to preset in case. |
177 | - if ( ! taxonomy_exists( $entity_type ) |
|
178 | - || array( $entity_type ) !== (array) $taxonomies |
|
179 | - || ! empty( $terms ) |
|
180 | - || ! term_exists( 'article', $entity_type ) |
|
181 | - || ! term_exists( 'thing', $entity_type ) ) { |
|
177 | + if ( ! taxonomy_exists($entity_type) |
|
178 | + || array($entity_type) !== (array) $taxonomies |
|
179 | + || ! empty($terms) |
|
180 | + || ! term_exists('article', $entity_type) |
|
181 | + || ! term_exists('thing', $entity_type)) { |
|
182 | 182 | |
183 | 183 | // Return the input value. |
184 | 184 | return $terms; |
185 | 185 | } |
186 | 186 | |
187 | 187 | // Avoid nested calls in case of issues. |
188 | - remove_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10 ); |
|
188 | + remove_filter('get_object_terms', array($this, 'get_object_terms'), 10); |
|
189 | 189 | |
190 | 190 | // Set the default term for all the queried object. |
191 | - foreach ( (array) $object_ids as $object_id ) { |
|
192 | - $post_type = get_post_type( $object_id ); |
|
193 | - if ( Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post_type ) ) { |
|
191 | + foreach ((array) $object_ids as $object_id) { |
|
192 | + $post_type = get_post_type($object_id); |
|
193 | + if (Wordlift_Entity_Type_Service::is_valid_entity_post_type($post_type)) { |
|
194 | 194 | // Set the term to article for posts and pages, or to thing for everything else. |
195 | - $uris = Wordlift_Entity_Type_Adapter::get_entity_types( $post_type ); |
|
196 | - foreach ( $uris as $uri ) { |
|
195 | + $uris = Wordlift_Entity_Type_Adapter::get_entity_types($post_type); |
|
196 | + foreach ($uris as $uri) { |
|
197 | 197 | // set the uri based on post type. |
198 | - if ( 'http://schema.org/Article' === $uri || 'http://schema.org/Thing' === $uri ) { |
|
198 | + if ('http://schema.org/Article' === $uri || 'http://schema.org/Thing' === $uri) { |
|
199 | 199 | $uri = Wordlift_Entity_Service::TYPE_NAME === $post_type ? |
200 | 200 | 'http://schema.org/Thing' : 'http://schema.org/Article'; |
201 | 201 | } |
202 | - Wordlift_Entity_Type_Service::get_instance()->set( $object_id, $uri ); |
|
202 | + Wordlift_Entity_Type_Service::get_instance()->set($object_id, $uri); |
|
203 | 203 | } |
204 | 204 | } |
205 | 205 | } |
206 | 206 | |
207 | 207 | // Finally return the object terms. |
208 | - $terms = wp_get_object_terms( $object_ids, $taxonomies, $args ); |
|
208 | + $terms = wp_get_object_terms($object_ids, $taxonomies, $args); |
|
209 | 209 | |
210 | 210 | // Re-enable nested calls in case of issues. |
211 | - add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 ); |
|
211 | + add_filter('get_object_terms', array($this, 'get_object_terms'), 10, 4); |
|
212 | 212 | |
213 | 213 | return $terms; |
214 | 214 | } |
215 | 215 | |
216 | - public function wpseo_sitemap_exclude_taxonomy( $exclude, $tax ) { |
|
217 | - if ( self::TAXONOMY_NAME === $tax ) { |
|
216 | + public function wpseo_sitemap_exclude_taxonomy($exclude, $tax) { |
|
217 | + if (self::TAXONOMY_NAME === $tax) { |
|
218 | 218 | return true; |
219 | 219 | } |
220 | 220 |
@@ -16,187 +16,187 @@ |
||
16 | 16 | */ |
17 | 17 | class Wordlift_Attachment_Service { |
18 | 18 | |
19 | - /** |
|
20 | - * Create a {@link Wordlift_Attachment_Service} instance. |
|
21 | - * |
|
22 | - * @since 3.20.0 |
|
23 | - */ |
|
24 | - protected function __construct() { |
|
25 | - |
|
26 | - } |
|
27 | - |
|
28 | - private static $instance = null; |
|
29 | - |
|
30 | - /** |
|
31 | - * Get the singleton instance. |
|
32 | - * |
|
33 | - * @return \Wordlift_Attachment_Service The singleton instance. |
|
34 | - * @since 3.20.0 |
|
35 | - */ |
|
36 | - public static function get_instance() { |
|
37 | - |
|
38 | - if ( ! isset( self::$instance ) ) { |
|
39 | - self::$instance = new self(); |
|
40 | - } |
|
41 | - |
|
42 | - return self::$instance; |
|
43 | - } |
|
44 | - |
|
45 | - /** |
|
46 | - * Get an attachment ID given a URL. |
|
47 | - * |
|
48 | - * Inspired from https://wpscholar.com/blog/get-attachment-id-from-wp-image-url/ |
|
49 | - * |
|
50 | - * @param string $url The attachment URL. |
|
51 | - * |
|
52 | - * @return int|false Attachment ID on success, false on failure |
|
53 | - * @since 3.10.0 |
|
54 | - */ |
|
55 | - public function get_attachment_id( $url ) { |
|
56 | - |
|
57 | - // Get the upload directory data, we need the base URL to check whether |
|
58 | - // the URL we received is within WP. |
|
59 | - $dir = wp_upload_dir(); |
|
60 | - |
|
61 | - // Get the filename, the extension is kept. |
|
62 | - if ( 1 !== preg_match( "@^{$dir['baseurl']}/(.+?)(?:-\d+x\d+)?(\.\w+)$@", $url, $matches ) ) { |
|
63 | - return false; |
|
64 | - } |
|
65 | - |
|
66 | - $filename = $matches[1] . $matches[2]; |
|
67 | - |
|
68 | - // The following query is CPU-intensive, we need to review it. |
|
69 | - // |
|
70 | - // See https://github.com/insideout10/wordlift-plugin/issues/689. |
|
71 | - // |
|
72 | - // Query for attachments with the specified filename. |
|
73 | - $query = new WP_Query( |
|
74 | - array( |
|
75 | - 'post_type' => 'attachment', |
|
76 | - 'post_status' => 'inherit', |
|
77 | - 'fields' => 'ids', |
|
78 | - 'meta_query' => array( |
|
79 | - array( |
|
80 | - 'value' => $filename, |
|
81 | - 'compare' => '=', |
|
82 | - 'key' => '_wp_attached_file', |
|
83 | - ), |
|
84 | - ), |
|
85 | - 'posts_per_page' => 1, |
|
86 | - 'ignore_sticky_posts' => true, |
|
87 | - ) |
|
88 | - ); |
|
89 | - |
|
90 | - // If there are no posts, return. |
|
91 | - if ( $query->have_posts() ) { |
|
92 | - return $query->posts[0]; |
|
93 | - // foreach ( $query->posts as $attachment_id ) { |
|
94 | - // |
|
95 | - // Get the attachment metadata, we need the filename. |
|
96 | - // $metadata = wp_get_attachment_metadata( $attachment_id ); |
|
97 | - // $original_filename = basename( $metadata['file'] ); |
|
98 | - // |
|
99 | - // Get the cropped filenames, or an empty array in case there are no files. |
|
100 | - // $sizes_filenames = isset( $metadata['sizes'] ) ? wp_list_pluck( $metadata['sizes'], 'file' ) : array(); |
|
101 | - // |
|
102 | - // If the provided filename matches the attachment filename (or one of its resized images), return the id. |
|
103 | - // if ( $original_filename === $filename || in_array( $filename, $sizes_filenames ) ) { |
|
104 | - // return $attachment_id; |
|
105 | - // } |
|
106 | - // } |
|
107 | - } |
|
108 | - |
|
109 | - // If we got here, we couldn't find any attachment. |
|
110 | - return false; |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * Get images embedded in the post content. |
|
115 | - * |
|
116 | - * @param string $content The post content. |
|
117 | - * |
|
118 | - * @return array An array of attachment ids. |
|
119 | - * @since 3.10.0 |
|
120 | - */ |
|
121 | - public function get_image_embeds( $content ) { |
|
122 | - |
|
123 | - // Go over all the images included in the post content, check if they are |
|
124 | - // in the DB, and if so include them. |
|
125 | - $images = array(); |
|
126 | - if ( false === preg_match_all( '#<img [^>]*src="([^\\">]*)"[^>]*>#', $content, $images ) ) { |
|
127 | - return array(); |
|
128 | - } |
|
129 | - |
|
130 | - // Map the image URLs to attachment ids. |
|
131 | - $that = $this; |
|
132 | - $ids = array_map( |
|
133 | - function ( $url ) use ( $that ) { |
|
134 | - return $that->get_attachment_id( $url ); |
|
135 | - }, |
|
136 | - $images[1] |
|
137 | - ); |
|
138 | - |
|
139 | - // Filter out not found ids (i.e. id is false). |
|
140 | - return array_filter( |
|
141 | - $ids, |
|
142 | - function ( $item ) { |
|
143 | - return false !== $item; |
|
144 | - } |
|
145 | - ); |
|
146 | - } |
|
147 | - |
|
148 | - /** |
|
149 | - * Get images linked via the `gallery` shortcode. |
|
150 | - * |
|
151 | - * @param \WP_Post $post A {@link WP_Post} instance. |
|
152 | - * |
|
153 | - * @return array An array of attachment ids. |
|
154 | - * @since 3.10.0 |
|
155 | - */ |
|
156 | - public function get_gallery( $post ) { |
|
157 | - |
|
158 | - // @todo: the `gallery` shortcode has an `exclude` attribute which isn't |
|
159 | - // checked at the moment. |
|
160 | - |
|
161 | - // Prepare the return value. |
|
162 | - $ids = array(); |
|
163 | - |
|
164 | - // As the above for images in galleries. |
|
165 | - // Code inspired by http://wordpress.stackexchange.com/questions/80408/how-to-get-page-post-gallery-attachment-images-in-order-they-are-set-in-backend |
|
166 | - $pattern = get_shortcode_regex(); |
|
167 | - |
|
168 | - if ( preg_match_all( '/' . $pattern . '/s', $post->post_content, $matches ) |
|
169 | - && array_key_exists( 2, $matches ) |
|
170 | - && in_array( 'gallery', $matches[2], true ) |
|
171 | - ) { |
|
172 | - |
|
173 | - $keys = array_keys( $matches[2], 'gallery', true ); |
|
174 | - |
|
175 | - foreach ( $keys as $key ) { |
|
176 | - $atts = shortcode_parse_atts( $matches[3][ $key ] ); |
|
177 | - |
|
178 | - if ( is_array( $atts ) && array_key_exists( 'ids', $atts ) ) { |
|
179 | - // gallery images insert explicitly by their ids. |
|
180 | - |
|
181 | - foreach ( explode( ',', $atts['ids'] ) as $attachment_id ) { |
|
182 | - // Since we do not check for actual image existence |
|
183 | - // when generating the json content, check it now. |
|
184 | - if ( wp_get_attachment_image_src( $attachment_id, 'full' ) ) { |
|
185 | - $ids[ $attachment_id ] = true; |
|
186 | - } |
|
187 | - } |
|
188 | - } else { |
|
189 | - // gallery shortcode with no ids uses all the images |
|
190 | - // attached to the post. |
|
191 | - $images = get_attached_media( 'image', $post->ID ); |
|
192 | - foreach ( $images as $attachment ) { |
|
193 | - $ids[ $attachment->ID ] = true; |
|
194 | - } |
|
195 | - } |
|
196 | - } |
|
197 | - } |
|
198 | - |
|
199 | - return array_keys( $ids ); |
|
200 | - } |
|
19 | + /** |
|
20 | + * Create a {@link Wordlift_Attachment_Service} instance. |
|
21 | + * |
|
22 | + * @since 3.20.0 |
|
23 | + */ |
|
24 | + protected function __construct() { |
|
25 | + |
|
26 | + } |
|
27 | + |
|
28 | + private static $instance = null; |
|
29 | + |
|
30 | + /** |
|
31 | + * Get the singleton instance. |
|
32 | + * |
|
33 | + * @return \Wordlift_Attachment_Service The singleton instance. |
|
34 | + * @since 3.20.0 |
|
35 | + */ |
|
36 | + public static function get_instance() { |
|
37 | + |
|
38 | + if ( ! isset( self::$instance ) ) { |
|
39 | + self::$instance = new self(); |
|
40 | + } |
|
41 | + |
|
42 | + return self::$instance; |
|
43 | + } |
|
44 | + |
|
45 | + /** |
|
46 | + * Get an attachment ID given a URL. |
|
47 | + * |
|
48 | + * Inspired from https://wpscholar.com/blog/get-attachment-id-from-wp-image-url/ |
|
49 | + * |
|
50 | + * @param string $url The attachment URL. |
|
51 | + * |
|
52 | + * @return int|false Attachment ID on success, false on failure |
|
53 | + * @since 3.10.0 |
|
54 | + */ |
|
55 | + public function get_attachment_id( $url ) { |
|
56 | + |
|
57 | + // Get the upload directory data, we need the base URL to check whether |
|
58 | + // the URL we received is within WP. |
|
59 | + $dir = wp_upload_dir(); |
|
60 | + |
|
61 | + // Get the filename, the extension is kept. |
|
62 | + if ( 1 !== preg_match( "@^{$dir['baseurl']}/(.+?)(?:-\d+x\d+)?(\.\w+)$@", $url, $matches ) ) { |
|
63 | + return false; |
|
64 | + } |
|
65 | + |
|
66 | + $filename = $matches[1] . $matches[2]; |
|
67 | + |
|
68 | + // The following query is CPU-intensive, we need to review it. |
|
69 | + // |
|
70 | + // See https://github.com/insideout10/wordlift-plugin/issues/689. |
|
71 | + // |
|
72 | + // Query for attachments with the specified filename. |
|
73 | + $query = new WP_Query( |
|
74 | + array( |
|
75 | + 'post_type' => 'attachment', |
|
76 | + 'post_status' => 'inherit', |
|
77 | + 'fields' => 'ids', |
|
78 | + 'meta_query' => array( |
|
79 | + array( |
|
80 | + 'value' => $filename, |
|
81 | + 'compare' => '=', |
|
82 | + 'key' => '_wp_attached_file', |
|
83 | + ), |
|
84 | + ), |
|
85 | + 'posts_per_page' => 1, |
|
86 | + 'ignore_sticky_posts' => true, |
|
87 | + ) |
|
88 | + ); |
|
89 | + |
|
90 | + // If there are no posts, return. |
|
91 | + if ( $query->have_posts() ) { |
|
92 | + return $query->posts[0]; |
|
93 | + // foreach ( $query->posts as $attachment_id ) { |
|
94 | + // |
|
95 | + // Get the attachment metadata, we need the filename. |
|
96 | + // $metadata = wp_get_attachment_metadata( $attachment_id ); |
|
97 | + // $original_filename = basename( $metadata['file'] ); |
|
98 | + // |
|
99 | + // Get the cropped filenames, or an empty array in case there are no files. |
|
100 | + // $sizes_filenames = isset( $metadata['sizes'] ) ? wp_list_pluck( $metadata['sizes'], 'file' ) : array(); |
|
101 | + // |
|
102 | + // If the provided filename matches the attachment filename (or one of its resized images), return the id. |
|
103 | + // if ( $original_filename === $filename || in_array( $filename, $sizes_filenames ) ) { |
|
104 | + // return $attachment_id; |
|
105 | + // } |
|
106 | + // } |
|
107 | + } |
|
108 | + |
|
109 | + // If we got here, we couldn't find any attachment. |
|
110 | + return false; |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * Get images embedded in the post content. |
|
115 | + * |
|
116 | + * @param string $content The post content. |
|
117 | + * |
|
118 | + * @return array An array of attachment ids. |
|
119 | + * @since 3.10.0 |
|
120 | + */ |
|
121 | + public function get_image_embeds( $content ) { |
|
122 | + |
|
123 | + // Go over all the images included in the post content, check if they are |
|
124 | + // in the DB, and if so include them. |
|
125 | + $images = array(); |
|
126 | + if ( false === preg_match_all( '#<img [^>]*src="([^\\">]*)"[^>]*>#', $content, $images ) ) { |
|
127 | + return array(); |
|
128 | + } |
|
129 | + |
|
130 | + // Map the image URLs to attachment ids. |
|
131 | + $that = $this; |
|
132 | + $ids = array_map( |
|
133 | + function ( $url ) use ( $that ) { |
|
134 | + return $that->get_attachment_id( $url ); |
|
135 | + }, |
|
136 | + $images[1] |
|
137 | + ); |
|
138 | + |
|
139 | + // Filter out not found ids (i.e. id is false). |
|
140 | + return array_filter( |
|
141 | + $ids, |
|
142 | + function ( $item ) { |
|
143 | + return false !== $item; |
|
144 | + } |
|
145 | + ); |
|
146 | + } |
|
147 | + |
|
148 | + /** |
|
149 | + * Get images linked via the `gallery` shortcode. |
|
150 | + * |
|
151 | + * @param \WP_Post $post A {@link WP_Post} instance. |
|
152 | + * |
|
153 | + * @return array An array of attachment ids. |
|
154 | + * @since 3.10.0 |
|
155 | + */ |
|
156 | + public function get_gallery( $post ) { |
|
157 | + |
|
158 | + // @todo: the `gallery` shortcode has an `exclude` attribute which isn't |
|
159 | + // checked at the moment. |
|
160 | + |
|
161 | + // Prepare the return value. |
|
162 | + $ids = array(); |
|
163 | + |
|
164 | + // As the above for images in galleries. |
|
165 | + // Code inspired by http://wordpress.stackexchange.com/questions/80408/how-to-get-page-post-gallery-attachment-images-in-order-they-are-set-in-backend |
|
166 | + $pattern = get_shortcode_regex(); |
|
167 | + |
|
168 | + if ( preg_match_all( '/' . $pattern . '/s', $post->post_content, $matches ) |
|
169 | + && array_key_exists( 2, $matches ) |
|
170 | + && in_array( 'gallery', $matches[2], true ) |
|
171 | + ) { |
|
172 | + |
|
173 | + $keys = array_keys( $matches[2], 'gallery', true ); |
|
174 | + |
|
175 | + foreach ( $keys as $key ) { |
|
176 | + $atts = shortcode_parse_atts( $matches[3][ $key ] ); |
|
177 | + |
|
178 | + if ( is_array( $atts ) && array_key_exists( 'ids', $atts ) ) { |
|
179 | + // gallery images insert explicitly by their ids. |
|
180 | + |
|
181 | + foreach ( explode( ',', $atts['ids'] ) as $attachment_id ) { |
|
182 | + // Since we do not check for actual image existence |
|
183 | + // when generating the json content, check it now. |
|
184 | + if ( wp_get_attachment_image_src( $attachment_id, 'full' ) ) { |
|
185 | + $ids[ $attachment_id ] = true; |
|
186 | + } |
|
187 | + } |
|
188 | + } else { |
|
189 | + // gallery shortcode with no ids uses all the images |
|
190 | + // attached to the post. |
|
191 | + $images = get_attached_media( 'image', $post->ID ); |
|
192 | + foreach ( $images as $attachment ) { |
|
193 | + $ids[ $attachment->ID ] = true; |
|
194 | + } |
|
195 | + } |
|
196 | + } |
|
197 | + } |
|
198 | + |
|
199 | + return array_keys( $ids ); |
|
200 | + } |
|
201 | 201 | |
202 | 202 | } |
@@ -35,7 +35,7 @@ discard block |
||
35 | 35 | */ |
36 | 36 | public static function get_instance() { |
37 | 37 | |
38 | - if ( ! isset( self::$instance ) ) { |
|
38 | + if ( ! isset(self::$instance)) { |
|
39 | 39 | self::$instance = new self(); |
40 | 40 | } |
41 | 41 | |
@@ -52,18 +52,18 @@ discard block |
||
52 | 52 | * @return int|false Attachment ID on success, false on failure |
53 | 53 | * @since 3.10.0 |
54 | 54 | */ |
55 | - public function get_attachment_id( $url ) { |
|
55 | + public function get_attachment_id($url) { |
|
56 | 56 | |
57 | 57 | // Get the upload directory data, we need the base URL to check whether |
58 | 58 | // the URL we received is within WP. |
59 | 59 | $dir = wp_upload_dir(); |
60 | 60 | |
61 | 61 | // Get the filename, the extension is kept. |
62 | - if ( 1 !== preg_match( "@^{$dir['baseurl']}/(.+?)(?:-\d+x\d+)?(\.\w+)$@", $url, $matches ) ) { |
|
62 | + if (1 !== preg_match("@^{$dir['baseurl']}/(.+?)(?:-\d+x\d+)?(\.\w+)$@", $url, $matches)) { |
|
63 | 63 | return false; |
64 | 64 | } |
65 | 65 | |
66 | - $filename = $matches[1] . $matches[2]; |
|
66 | + $filename = $matches[1].$matches[2]; |
|
67 | 67 | |
68 | 68 | // The following query is CPU-intensive, we need to review it. |
69 | 69 | // |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | ); |
89 | 89 | |
90 | 90 | // If there are no posts, return. |
91 | - if ( $query->have_posts() ) { |
|
91 | + if ($query->have_posts()) { |
|
92 | 92 | return $query->posts[0]; |
93 | 93 | // foreach ( $query->posts as $attachment_id ) { |
94 | 94 | // |
@@ -118,20 +118,20 @@ discard block |
||
118 | 118 | * @return array An array of attachment ids. |
119 | 119 | * @since 3.10.0 |
120 | 120 | */ |
121 | - public function get_image_embeds( $content ) { |
|
121 | + public function get_image_embeds($content) { |
|
122 | 122 | |
123 | 123 | // Go over all the images included in the post content, check if they are |
124 | 124 | // in the DB, and if so include them. |
125 | 125 | $images = array(); |
126 | - if ( false === preg_match_all( '#<img [^>]*src="([^\\">]*)"[^>]*>#', $content, $images ) ) { |
|
126 | + if (false === preg_match_all('#<img [^>]*src="([^\\">]*)"[^>]*>#', $content, $images)) { |
|
127 | 127 | return array(); |
128 | 128 | } |
129 | 129 | |
130 | 130 | // Map the image URLs to attachment ids. |
131 | 131 | $that = $this; |
132 | 132 | $ids = array_map( |
133 | - function ( $url ) use ( $that ) { |
|
134 | - return $that->get_attachment_id( $url ); |
|
133 | + function($url) use ($that) { |
|
134 | + return $that->get_attachment_id($url); |
|
135 | 135 | }, |
136 | 136 | $images[1] |
137 | 137 | ); |
@@ -139,7 +139,7 @@ discard block |
||
139 | 139 | // Filter out not found ids (i.e. id is false). |
140 | 140 | return array_filter( |
141 | 141 | $ids, |
142 | - function ( $item ) { |
|
142 | + function($item) { |
|
143 | 143 | return false !== $item; |
144 | 144 | } |
145 | 145 | ); |
@@ -153,7 +153,7 @@ discard block |
||
153 | 153 | * @return array An array of attachment ids. |
154 | 154 | * @since 3.10.0 |
155 | 155 | */ |
156 | - public function get_gallery( $post ) { |
|
156 | + public function get_gallery($post) { |
|
157 | 157 | |
158 | 158 | // @todo: the `gallery` shortcode has an `exclude` attribute which isn't |
159 | 159 | // checked at the moment. |
@@ -165,38 +165,38 @@ discard block |
||
165 | 165 | // Code inspired by http://wordpress.stackexchange.com/questions/80408/how-to-get-page-post-gallery-attachment-images-in-order-they-are-set-in-backend |
166 | 166 | $pattern = get_shortcode_regex(); |
167 | 167 | |
168 | - if ( preg_match_all( '/' . $pattern . '/s', $post->post_content, $matches ) |
|
169 | - && array_key_exists( 2, $matches ) |
|
170 | - && in_array( 'gallery', $matches[2], true ) |
|
168 | + if (preg_match_all('/'.$pattern.'/s', $post->post_content, $matches) |
|
169 | + && array_key_exists(2, $matches) |
|
170 | + && in_array('gallery', $matches[2], true) |
|
171 | 171 | ) { |
172 | 172 | |
173 | - $keys = array_keys( $matches[2], 'gallery', true ); |
|
173 | + $keys = array_keys($matches[2], 'gallery', true); |
|
174 | 174 | |
175 | - foreach ( $keys as $key ) { |
|
176 | - $atts = shortcode_parse_atts( $matches[3][ $key ] ); |
|
175 | + foreach ($keys as $key) { |
|
176 | + $atts = shortcode_parse_atts($matches[3][$key]); |
|
177 | 177 | |
178 | - if ( is_array( $atts ) && array_key_exists( 'ids', $atts ) ) { |
|
178 | + if (is_array($atts) && array_key_exists('ids', $atts)) { |
|
179 | 179 | // gallery images insert explicitly by their ids. |
180 | 180 | |
181 | - foreach ( explode( ',', $atts['ids'] ) as $attachment_id ) { |
|
181 | + foreach (explode(',', $atts['ids']) as $attachment_id) { |
|
182 | 182 | // Since we do not check for actual image existence |
183 | 183 | // when generating the json content, check it now. |
184 | - if ( wp_get_attachment_image_src( $attachment_id, 'full' ) ) { |
|
185 | - $ids[ $attachment_id ] = true; |
|
184 | + if (wp_get_attachment_image_src($attachment_id, 'full')) { |
|
185 | + $ids[$attachment_id] = true; |
|
186 | 186 | } |
187 | 187 | } |
188 | 188 | } else { |
189 | 189 | // gallery shortcode with no ids uses all the images |
190 | 190 | // attached to the post. |
191 | - $images = get_attached_media( 'image', $post->ID ); |
|
192 | - foreach ( $images as $attachment ) { |
|
193 | - $ids[ $attachment->ID ] = true; |
|
191 | + $images = get_attached_media('image', $post->ID); |
|
192 | + foreach ($images as $attachment) { |
|
193 | + $ids[$attachment->ID] = true; |
|
194 | 194 | } |
195 | 195 | } |
196 | 196 | } |
197 | 197 | } |
198 | 198 | |
199 | - return array_keys( $ids ); |
|
199 | + return array_keys($ids); |
|
200 | 200 | } |
201 | 201 | |
202 | 202 | } |
@@ -17,274 +17,274 @@ |
||
17 | 17 | */ |
18 | 18 | class Wordlift_Jsonld_Service { |
19 | 19 | |
20 | - /** |
|
21 | - * A {@link Wordlift_Entity_Service} instance. |
|
22 | - * |
|
23 | - * @since 3.8.0 |
|
24 | - * @access private |
|
25 | - * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance. |
|
26 | - */ |
|
27 | - private $entity_service; |
|
28 | - |
|
29 | - /** |
|
30 | - * A {@link Wordlift_Term_JsonLd_Adapter} instance. |
|
31 | - * |
|
32 | - * @since 3.32.0 |
|
33 | - * @access private |
|
34 | - * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance. |
|
35 | - */ |
|
36 | - private $term_jsonld_adapter; |
|
37 | - |
|
38 | - /** |
|
39 | - * A {@link Wordlift_Post_Converter} instance. |
|
40 | - * |
|
41 | - * @since 3.8.0 |
|
42 | - * @access private |
|
43 | - * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance. |
|
44 | - */ |
|
45 | - private $converter; |
|
46 | - |
|
47 | - /** |
|
48 | - * A {@link Wordlift_Website_Jsonld_Converter} instance. |
|
49 | - * |
|
50 | - * @since 3.14.0 |
|
51 | - * @access private |
|
52 | - * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance. |
|
53 | - */ |
|
54 | - private $website_converter; |
|
55 | - |
|
56 | - /** |
|
57 | - * The singleton instance for the JSON-LD service. |
|
58 | - * |
|
59 | - * @since 3.15.1 |
|
60 | - * |
|
61 | - * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service. |
|
62 | - */ |
|
63 | - private static $instance; |
|
64 | - |
|
65 | - /** |
|
66 | - * Create a JSON-LD service. |
|
67 | - * |
|
68 | - * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance. |
|
69 | - * @param \Wordlift_Post_Converter $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance. |
|
70 | - * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance. |
|
71 | - * @param \Wordlift_Term_JsonLd_Adapter $term_jsonld_adapter |
|
72 | - * |
|
73 | - * @since 3.8.0 |
|
74 | - */ |
|
75 | - public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) { |
|
76 | - |
|
77 | - $this->entity_service = $entity_service; |
|
78 | - $this->converter = $converter; |
|
79 | - $this->website_converter = $website_converter; |
|
80 | - $this->term_jsonld_adapter = $term_jsonld_adapter; |
|
81 | - self::$instance = $this; |
|
82 | - |
|
83 | - } |
|
84 | - |
|
85 | - /** |
|
86 | - * Get the singleton instance for the JSON-LD service. |
|
87 | - * |
|
88 | - * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service. |
|
89 | - * @since 3.15.1 |
|
90 | - */ |
|
91 | - public static function get_instance() { |
|
92 | - |
|
93 | - return self::$instance; |
|
94 | - } |
|
95 | - |
|
96 | - /** |
|
97 | - * Process calls to the AJAX 'wl_jsonld' endpoint. |
|
98 | - * |
|
99 | - * @since 3.8.0 |
|
100 | - */ |
|
101 | - public function get() { |
|
102 | - // Clear the buffer to be sure someone doesn't mess with our response. |
|
103 | - // |
|
104 | - // See https://github.com/insideout10/wordlift-plugin/issues/406. |
|
105 | - // See https://codex.wordpress.org/AJAX_in_Plugins. |
|
20 | + /** |
|
21 | + * A {@link Wordlift_Entity_Service} instance. |
|
22 | + * |
|
23 | + * @since 3.8.0 |
|
24 | + * @access private |
|
25 | + * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance. |
|
26 | + */ |
|
27 | + private $entity_service; |
|
28 | + |
|
29 | + /** |
|
30 | + * A {@link Wordlift_Term_JsonLd_Adapter} instance. |
|
31 | + * |
|
32 | + * @since 3.32.0 |
|
33 | + * @access private |
|
34 | + * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance. |
|
35 | + */ |
|
36 | + private $term_jsonld_adapter; |
|
37 | + |
|
38 | + /** |
|
39 | + * A {@link Wordlift_Post_Converter} instance. |
|
40 | + * |
|
41 | + * @since 3.8.0 |
|
42 | + * @access private |
|
43 | + * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance. |
|
44 | + */ |
|
45 | + private $converter; |
|
46 | + |
|
47 | + /** |
|
48 | + * A {@link Wordlift_Website_Jsonld_Converter} instance. |
|
49 | + * |
|
50 | + * @since 3.14.0 |
|
51 | + * @access private |
|
52 | + * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance. |
|
53 | + */ |
|
54 | + private $website_converter; |
|
55 | + |
|
56 | + /** |
|
57 | + * The singleton instance for the JSON-LD service. |
|
58 | + * |
|
59 | + * @since 3.15.1 |
|
60 | + * |
|
61 | + * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service. |
|
62 | + */ |
|
63 | + private static $instance; |
|
64 | + |
|
65 | + /** |
|
66 | + * Create a JSON-LD service. |
|
67 | + * |
|
68 | + * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance. |
|
69 | + * @param \Wordlift_Post_Converter $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance. |
|
70 | + * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance. |
|
71 | + * @param \Wordlift_Term_JsonLd_Adapter $term_jsonld_adapter |
|
72 | + * |
|
73 | + * @since 3.8.0 |
|
74 | + */ |
|
75 | + public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) { |
|
76 | + |
|
77 | + $this->entity_service = $entity_service; |
|
78 | + $this->converter = $converter; |
|
79 | + $this->website_converter = $website_converter; |
|
80 | + $this->term_jsonld_adapter = $term_jsonld_adapter; |
|
81 | + self::$instance = $this; |
|
82 | + |
|
83 | + } |
|
84 | + |
|
85 | + /** |
|
86 | + * Get the singleton instance for the JSON-LD service. |
|
87 | + * |
|
88 | + * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service. |
|
89 | + * @since 3.15.1 |
|
90 | + */ |
|
91 | + public static function get_instance() { |
|
92 | + |
|
93 | + return self::$instance; |
|
94 | + } |
|
95 | + |
|
96 | + /** |
|
97 | + * Process calls to the AJAX 'wl_jsonld' endpoint. |
|
98 | + * |
|
99 | + * @since 3.8.0 |
|
100 | + */ |
|
101 | + public function get() { |
|
102 | + // Clear the buffer to be sure someone doesn't mess with our response. |
|
103 | + // |
|
104 | + // See https://github.com/insideout10/wordlift-plugin/issues/406. |
|
105 | + // See https://codex.wordpress.org/AJAX_in_Plugins. |
|
106 | 106 | // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
107 | - @ob_clean(); |
|
108 | - |
|
109 | - // Get the parameter from the request. |
|
110 | - $is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
111 | - $post_id = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
112 | - |
|
113 | - // Send the generated JSON-LD. |
|
114 | - $this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) ); |
|
115 | - |
|
116 | - } |
|
117 | - |
|
118 | - /** |
|
119 | - * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type. |
|
120 | - * |
|
121 | - * @param mixed $response Variable (usually an array or object) to encode as JSON, |
|
122 | - * then print and die. |
|
123 | - * |
|
124 | - * @since 3.18.5 |
|
125 | - */ |
|
126 | - private function send_jsonld( $response ) { |
|
107 | + @ob_clean(); |
|
108 | + |
|
109 | + // Get the parameter from the request. |
|
110 | + $is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
111 | + $post_id = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
112 | + |
|
113 | + // Send the generated JSON-LD. |
|
114 | + $this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) ); |
|
115 | + |
|
116 | + } |
|
117 | + |
|
118 | + /** |
|
119 | + * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type. |
|
120 | + * |
|
121 | + * @param mixed $response Variable (usually an array or object) to encode as JSON, |
|
122 | + * then print and die. |
|
123 | + * |
|
124 | + * @since 3.18.5 |
|
125 | + */ |
|
126 | + private function send_jsonld( $response ) { |
|
127 | 127 | // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
128 | - @header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) ); |
|
129 | - echo wp_json_encode( $response ); |
|
130 | - if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) { |
|
131 | - wp_die(); |
|
132 | - } else { |
|
133 | - die; |
|
134 | - } |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Get the JSON-LD. |
|
139 | - * |
|
140 | - * @param bool $is_homepage Whether the JSON-LD for the homepage is being requested. |
|
141 | - * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id. |
|
142 | - * @param int $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum. |
|
143 | - * |
|
144 | - * @return array A JSON-LD structure. |
|
145 | - * @since 3.15.1 |
|
146 | - */ |
|
147 | - public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) { |
|
148 | - |
|
149 | - // Tell NewRelic to ignore us, otherwise NewRelic customers might receive |
|
150 | - // e-mails with a low apdex score. |
|
151 | - // |
|
152 | - // See https://github.com/insideout10/wordlift-plugin/issues/521 |
|
153 | - Wordlift_NewRelic_Adapter::ignore_apdex(); |
|
154 | - |
|
155 | - // Switch to Website converter if is home page. |
|
156 | - if ( $is_homepage ) { |
|
157 | - /** |
|
158 | - * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output. |
|
159 | - * |
|
160 | - * @since 3.14.0 |
|
161 | - * @api bool $display_search Whether or not to display json+ld search on the frontend. |
|
162 | - */ |
|
163 | - if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) { |
|
164 | - return array(); |
|
165 | - } |
|
166 | - |
|
167 | - // Set a reference to the website_converter. |
|
168 | - $website_converter = $this->website_converter; |
|
169 | - |
|
170 | - // Send JSON-LD. |
|
171 | - return $website_converter->create_schema(); |
|
172 | - } |
|
173 | - |
|
174 | - // If no id has been provided return an empty array. |
|
175 | - if ( ! isset( $post_id ) ) { |
|
176 | - return array(); |
|
177 | - } |
|
178 | - |
|
179 | - // An array of references which is captured when converting an URI to a |
|
180 | - // json which we gather to further expand our json-ld. |
|
181 | - $references = array(); |
|
182 | - $references_infos = array(); |
|
183 | - |
|
184 | - // Set a reference to the entity_to_jsonld_converter to use in the closures. |
|
185 | - $entity_to_jsonld_converter = $this->converter; |
|
186 | - |
|
187 | - $jsonld = array( $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos ) ); |
|
188 | - |
|
189 | - $that = $this; |
|
190 | - $expanded_references_jsonld = array_map( |
|
191 | - function ( $item ) use ( $context, $entity_to_jsonld_converter, &$references_infos, $that ) { |
|
192 | - // "2nd level properties" may not output here, e.g. a post |
|
193 | - // mentioning an event, located in a place: the place is referenced |
|
194 | - // via the `@id` but no other properties are loaded. |
|
195 | - $ignored = array(); |
|
196 | - if ( $item instanceof Term_Reference ) { |
|
128 | + @header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) ); |
|
129 | + echo wp_json_encode( $response ); |
|
130 | + if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) { |
|
131 | + wp_die(); |
|
132 | + } else { |
|
133 | + die; |
|
134 | + } |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Get the JSON-LD. |
|
139 | + * |
|
140 | + * @param bool $is_homepage Whether the JSON-LD for the homepage is being requested. |
|
141 | + * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id. |
|
142 | + * @param int $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum. |
|
143 | + * |
|
144 | + * @return array A JSON-LD structure. |
|
145 | + * @since 3.15.1 |
|
146 | + */ |
|
147 | + public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) { |
|
148 | + |
|
149 | + // Tell NewRelic to ignore us, otherwise NewRelic customers might receive |
|
150 | + // e-mails with a low apdex score. |
|
151 | + // |
|
152 | + // See https://github.com/insideout10/wordlift-plugin/issues/521 |
|
153 | + Wordlift_NewRelic_Adapter::ignore_apdex(); |
|
154 | + |
|
155 | + // Switch to Website converter if is home page. |
|
156 | + if ( $is_homepage ) { |
|
157 | + /** |
|
158 | + * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output. |
|
159 | + * |
|
160 | + * @since 3.14.0 |
|
161 | + * @api bool $display_search Whether or not to display json+ld search on the frontend. |
|
162 | + */ |
|
163 | + if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) { |
|
164 | + return array(); |
|
165 | + } |
|
166 | + |
|
167 | + // Set a reference to the website_converter. |
|
168 | + $website_converter = $this->website_converter; |
|
169 | + |
|
170 | + // Send JSON-LD. |
|
171 | + return $website_converter->create_schema(); |
|
172 | + } |
|
173 | + |
|
174 | + // If no id has been provided return an empty array. |
|
175 | + if ( ! isset( $post_id ) ) { |
|
176 | + return array(); |
|
177 | + } |
|
178 | + |
|
179 | + // An array of references which is captured when converting an URI to a |
|
180 | + // json which we gather to further expand our json-ld. |
|
181 | + $references = array(); |
|
182 | + $references_infos = array(); |
|
183 | + |
|
184 | + // Set a reference to the entity_to_jsonld_converter to use in the closures. |
|
185 | + $entity_to_jsonld_converter = $this->converter; |
|
186 | + |
|
187 | + $jsonld = array( $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos ) ); |
|
188 | + |
|
189 | + $that = $this; |
|
190 | + $expanded_references_jsonld = array_map( |
|
191 | + function ( $item ) use ( $context, $entity_to_jsonld_converter, &$references_infos, $that ) { |
|
192 | + // "2nd level properties" may not output here, e.g. a post |
|
193 | + // mentioning an event, located in a place: the place is referenced |
|
194 | + // via the `@id` but no other properties are loaded. |
|
195 | + $ignored = array(); |
|
196 | + if ( $item instanceof Term_Reference ) { |
|
197 | 197 | // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable |
198 | - $term_jsonld = $that->term_jsonld_adapter->get( $item->get_id(), $context ); |
|
199 | - |
|
200 | - // For term references, we publish a jsonld array on the page, use only the first item. |
|
201 | - return count( $term_jsonld ) > 0 ? $term_jsonld[0] : false; |
|
202 | - } elseif ( $item instanceof Post_Reference ) { |
|
203 | - $item = $item->get_id(); |
|
204 | - } |
|
205 | - |
|
206 | - // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable |
|
207 | - return $entity_to_jsonld_converter->convert( $item, $ignored, $references_infos ); |
|
208 | - }, |
|
209 | - array_unique( $references ) |
|
210 | - ); |
|
211 | - |
|
212 | - // Convert each URI to a JSON-LD array, while gathering referenced entities. |
|
213 | - // in the references array. |
|
214 | - $jsonld = array_merge( |
|
215 | - $jsonld, |
|
216 | - // Convert each URI in the references array to JSON-LD. We don't output |
|
217 | - // entities already output above (hence the array_diff). |
|
218 | - array_filter( $expanded_references_jsonld ) |
|
219 | - ); |
|
220 | - |
|
221 | - $required_references = array_filter( |
|
222 | - $references_infos, |
|
223 | - function ( $item ) use ( $references ) { |
|
224 | - |
|
225 | - return isset( $item['reference'] ) && |
|
226 | - // Check that the reference is required |
|
227 | - $item['reference']->get_required() && |
|
228 | - // Check that the reference isn't being output already. |
|
229 | - ! in_array( $item['reference']->get_id(), $references, true ); |
|
230 | - } |
|
231 | - ); |
|
232 | - |
|
233 | - $jsonld = array_merge( |
|
234 | - $jsonld, |
|
235 | - array_filter( |
|
236 | - array_map( |
|
237 | - function ( $item ) use ( $references, $entity_to_jsonld_converter ) { |
|
238 | - |
|
239 | - if ( ! isset( $item['reference'] ) ) { |
|
240 | - return null; |
|
241 | - } |
|
242 | - |
|
243 | - $post_id = $item['reference']->get_id(); |
|
244 | - if ( in_array( $post_id, $references, true ) ) { |
|
245 | - return null; |
|
246 | - } |
|
247 | - |
|
248 | - $references[] = $post_id; |
|
249 | - |
|
250 | - return $entity_to_jsonld_converter->convert( $post_id, $references ); |
|
251 | - }, |
|
252 | - $required_references |
|
253 | - ) |
|
254 | - ) |
|
255 | - ); |
|
256 | - |
|
257 | - /** |
|
258 | - * Filter name: wl_after_get_jsonld |
|
259 | - * |
|
260 | - * @return array |
|
261 | - * @since 3.27.2 |
|
262 | - * @var $jsonld array The final jsonld before outputting to page. |
|
263 | - * @var $post_id int The post id for which the jsonld is generated. |
|
264 | - */ |
|
265 | - $jsonld = apply_filters( 'wl_after_get_jsonld', $jsonld, $post_id, $context ); |
|
266 | - |
|
267 | - return $jsonld; |
|
268 | - } |
|
269 | - |
|
270 | - /** |
|
271 | - * Write the JSON-LD in the head. |
|
272 | - * |
|
273 | - * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the |
|
274 | - * document head, using the `wp_head` hook. |
|
275 | - * |
|
276 | - * @since 3.18.5 |
|
277 | - */ |
|
278 | - public function wp_head() { |
|
279 | - |
|
280 | - // Determine whether this is the home page or whether we're displaying a single post. |
|
281 | - $is_homepage = is_home() || is_front_page(); |
|
282 | - $post_id = is_singular() ? get_the_ID() : null; |
|
283 | - |
|
284 | - $jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) ); |
|
285 | - ?> |
|
198 | + $term_jsonld = $that->term_jsonld_adapter->get( $item->get_id(), $context ); |
|
199 | + |
|
200 | + // For term references, we publish a jsonld array on the page, use only the first item. |
|
201 | + return count( $term_jsonld ) > 0 ? $term_jsonld[0] : false; |
|
202 | + } elseif ( $item instanceof Post_Reference ) { |
|
203 | + $item = $item->get_id(); |
|
204 | + } |
|
205 | + |
|
206 | + // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable |
|
207 | + return $entity_to_jsonld_converter->convert( $item, $ignored, $references_infos ); |
|
208 | + }, |
|
209 | + array_unique( $references ) |
|
210 | + ); |
|
211 | + |
|
212 | + // Convert each URI to a JSON-LD array, while gathering referenced entities. |
|
213 | + // in the references array. |
|
214 | + $jsonld = array_merge( |
|
215 | + $jsonld, |
|
216 | + // Convert each URI in the references array to JSON-LD. We don't output |
|
217 | + // entities already output above (hence the array_diff). |
|
218 | + array_filter( $expanded_references_jsonld ) |
|
219 | + ); |
|
220 | + |
|
221 | + $required_references = array_filter( |
|
222 | + $references_infos, |
|
223 | + function ( $item ) use ( $references ) { |
|
224 | + |
|
225 | + return isset( $item['reference'] ) && |
|
226 | + // Check that the reference is required |
|
227 | + $item['reference']->get_required() && |
|
228 | + // Check that the reference isn't being output already. |
|
229 | + ! in_array( $item['reference']->get_id(), $references, true ); |
|
230 | + } |
|
231 | + ); |
|
232 | + |
|
233 | + $jsonld = array_merge( |
|
234 | + $jsonld, |
|
235 | + array_filter( |
|
236 | + array_map( |
|
237 | + function ( $item ) use ( $references, $entity_to_jsonld_converter ) { |
|
238 | + |
|
239 | + if ( ! isset( $item['reference'] ) ) { |
|
240 | + return null; |
|
241 | + } |
|
242 | + |
|
243 | + $post_id = $item['reference']->get_id(); |
|
244 | + if ( in_array( $post_id, $references, true ) ) { |
|
245 | + return null; |
|
246 | + } |
|
247 | + |
|
248 | + $references[] = $post_id; |
|
249 | + |
|
250 | + return $entity_to_jsonld_converter->convert( $post_id, $references ); |
|
251 | + }, |
|
252 | + $required_references |
|
253 | + ) |
|
254 | + ) |
|
255 | + ); |
|
256 | + |
|
257 | + /** |
|
258 | + * Filter name: wl_after_get_jsonld |
|
259 | + * |
|
260 | + * @return array |
|
261 | + * @since 3.27.2 |
|
262 | + * @var $jsonld array The final jsonld before outputting to page. |
|
263 | + * @var $post_id int The post id for which the jsonld is generated. |
|
264 | + */ |
|
265 | + $jsonld = apply_filters( 'wl_after_get_jsonld', $jsonld, $post_id, $context ); |
|
266 | + |
|
267 | + return $jsonld; |
|
268 | + } |
|
269 | + |
|
270 | + /** |
|
271 | + * Write the JSON-LD in the head. |
|
272 | + * |
|
273 | + * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the |
|
274 | + * document head, using the `wp_head` hook. |
|
275 | + * |
|
276 | + * @since 3.18.5 |
|
277 | + */ |
|
278 | + public function wp_head() { |
|
279 | + |
|
280 | + // Determine whether this is the home page or whether we're displaying a single post. |
|
281 | + $is_homepage = is_home() || is_front_page(); |
|
282 | + $post_id = is_singular() ? get_the_ID() : null; |
|
283 | + |
|
284 | + $jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) ); |
|
285 | + ?> |
|
286 | 286 | <script type="application/ld+json"><?php echo esc_html( $jsonld ); ?></script> |
287 | 287 | <?php |
288 | - } |
|
288 | + } |
|
289 | 289 | |
290 | 290 | } |
@@ -72,7 +72,7 @@ discard block |
||
72 | 72 | * |
73 | 73 | * @since 3.8.0 |
74 | 74 | */ |
75 | - public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) { |
|
75 | + public function __construct($entity_service, $converter, $website_converter, $term_jsonld_adapter) { |
|
76 | 76 | |
77 | 77 | $this->entity_service = $entity_service; |
78 | 78 | $this->converter = $converter; |
@@ -107,11 +107,11 @@ discard block |
||
107 | 107 | @ob_clean(); |
108 | 108 | |
109 | 109 | // Get the parameter from the request. |
110 | - $is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
111 | - $post_id = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
110 | + $is_homepage = isset($_REQUEST['homepage']); //phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
111 | + $post_id = isset($_REQUEST['id']) && is_numeric($_REQUEST['id']) ? intval($_REQUEST['id']) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
112 | 112 | |
113 | 113 | // Send the generated JSON-LD. |
114 | - $this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) ); |
|
114 | + $this->send_jsonld($this->get_jsonld($is_homepage, $post_id)); |
|
115 | 115 | |
116 | 116 | } |
117 | 117 | |
@@ -123,11 +123,11 @@ discard block |
||
123 | 123 | * |
124 | 124 | * @since 3.18.5 |
125 | 125 | */ |
126 | - private function send_jsonld( $response ) { |
|
126 | + private function send_jsonld($response) { |
|
127 | 127 | // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
128 | - @header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) ); |
|
129 | - echo wp_json_encode( $response ); |
|
130 | - if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) { |
|
128 | + @header('Content-Type: application/ld+json; charset='.get_option('blog_charset')); |
|
129 | + echo wp_json_encode($response); |
|
130 | + if (apply_filters('wp_doing_ajax', defined('DOING_AJAX') && DOING_AJAX)) { |
|
131 | 131 | wp_die(); |
132 | 132 | } else { |
133 | 133 | die; |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | * @return array A JSON-LD structure. |
145 | 145 | * @since 3.15.1 |
146 | 146 | */ |
147 | - public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) { |
|
147 | + public function get_jsonld($is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN) { |
|
148 | 148 | |
149 | 149 | // Tell NewRelic to ignore us, otherwise NewRelic customers might receive |
150 | 150 | // e-mails with a low apdex score. |
@@ -153,14 +153,14 @@ discard block |
||
153 | 153 | Wordlift_NewRelic_Adapter::ignore_apdex(); |
154 | 154 | |
155 | 155 | // Switch to Website converter if is home page. |
156 | - if ( $is_homepage ) { |
|
156 | + if ($is_homepage) { |
|
157 | 157 | /** |
158 | 158 | * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output. |
159 | 159 | * |
160 | 160 | * @since 3.14.0 |
161 | 161 | * @api bool $display_search Whether or not to display json+ld search on the frontend. |
162 | 162 | */ |
163 | - if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) { |
|
163 | + if (apply_filters('wordlift_disable_website_json_ld', false)) { |
|
164 | 164 | return array(); |
165 | 165 | } |
166 | 166 | |
@@ -172,7 +172,7 @@ discard block |
||
172 | 172 | } |
173 | 173 | |
174 | 174 | // If no id has been provided return an empty array. |
175 | - if ( ! isset( $post_id ) ) { |
|
175 | + if ( ! isset($post_id)) { |
|
176 | 176 | return array(); |
177 | 177 | } |
178 | 178 | |
@@ -184,29 +184,29 @@ discard block |
||
184 | 184 | // Set a reference to the entity_to_jsonld_converter to use in the closures. |
185 | 185 | $entity_to_jsonld_converter = $this->converter; |
186 | 186 | |
187 | - $jsonld = array( $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos ) ); |
|
187 | + $jsonld = array($entity_to_jsonld_converter->convert($post_id, $references, $references_infos)); |
|
188 | 188 | |
189 | 189 | $that = $this; |
190 | 190 | $expanded_references_jsonld = array_map( |
191 | - function ( $item ) use ( $context, $entity_to_jsonld_converter, &$references_infos, $that ) { |
|
191 | + function($item) use ($context, $entity_to_jsonld_converter, &$references_infos, $that) { |
|
192 | 192 | // "2nd level properties" may not output here, e.g. a post |
193 | 193 | // mentioning an event, located in a place: the place is referenced |
194 | 194 | // via the `@id` but no other properties are loaded. |
195 | 195 | $ignored = array(); |
196 | - if ( $item instanceof Term_Reference ) { |
|
196 | + if ($item instanceof Term_Reference) { |
|
197 | 197 | // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable |
198 | - $term_jsonld = $that->term_jsonld_adapter->get( $item->get_id(), $context ); |
|
198 | + $term_jsonld = $that->term_jsonld_adapter->get($item->get_id(), $context); |
|
199 | 199 | |
200 | 200 | // For term references, we publish a jsonld array on the page, use only the first item. |
201 | - return count( $term_jsonld ) > 0 ? $term_jsonld[0] : false; |
|
202 | - } elseif ( $item instanceof Post_Reference ) { |
|
201 | + return count($term_jsonld) > 0 ? $term_jsonld[0] : false; |
|
202 | + } elseif ($item instanceof Post_Reference) { |
|
203 | 203 | $item = $item->get_id(); |
204 | 204 | } |
205 | 205 | |
206 | 206 | // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable |
207 | - return $entity_to_jsonld_converter->convert( $item, $ignored, $references_infos ); |
|
207 | + return $entity_to_jsonld_converter->convert($item, $ignored, $references_infos); |
|
208 | 208 | }, |
209 | - array_unique( $references ) |
|
209 | + array_unique($references) |
|
210 | 210 | ); |
211 | 211 | |
212 | 212 | // Convert each URI to a JSON-LD array, while gathering referenced entities. |
@@ -215,18 +215,18 @@ discard block |
||
215 | 215 | $jsonld, |
216 | 216 | // Convert each URI in the references array to JSON-LD. We don't output |
217 | 217 | // entities already output above (hence the array_diff). |
218 | - array_filter( $expanded_references_jsonld ) |
|
218 | + array_filter($expanded_references_jsonld) |
|
219 | 219 | ); |
220 | 220 | |
221 | 221 | $required_references = array_filter( |
222 | 222 | $references_infos, |
223 | - function ( $item ) use ( $references ) { |
|
223 | + function($item) use ($references) { |
|
224 | 224 | |
225 | - return isset( $item['reference'] ) && |
|
225 | + return isset($item['reference']) && |
|
226 | 226 | // Check that the reference is required |
227 | 227 | $item['reference']->get_required() && |
228 | 228 | // Check that the reference isn't being output already. |
229 | - ! in_array( $item['reference']->get_id(), $references, true ); |
|
229 | + ! in_array($item['reference']->get_id(), $references, true); |
|
230 | 230 | } |
231 | 231 | ); |
232 | 232 | |
@@ -234,20 +234,20 @@ discard block |
||
234 | 234 | $jsonld, |
235 | 235 | array_filter( |
236 | 236 | array_map( |
237 | - function ( $item ) use ( $references, $entity_to_jsonld_converter ) { |
|
237 | + function($item) use ($references, $entity_to_jsonld_converter) { |
|
238 | 238 | |
239 | - if ( ! isset( $item['reference'] ) ) { |
|
239 | + if ( ! isset($item['reference'])) { |
|
240 | 240 | return null; |
241 | 241 | } |
242 | 242 | |
243 | 243 | $post_id = $item['reference']->get_id(); |
244 | - if ( in_array( $post_id, $references, true ) ) { |
|
244 | + if (in_array($post_id, $references, true)) { |
|
245 | 245 | return null; |
246 | 246 | } |
247 | 247 | |
248 | 248 | $references[] = $post_id; |
249 | 249 | |
250 | - return $entity_to_jsonld_converter->convert( $post_id, $references ); |
|
250 | + return $entity_to_jsonld_converter->convert($post_id, $references); |
|
251 | 251 | }, |
252 | 252 | $required_references |
253 | 253 | ) |
@@ -262,7 +262,7 @@ discard block |
||
262 | 262 | * @var $jsonld array The final jsonld before outputting to page. |
263 | 263 | * @var $post_id int The post id for which the jsonld is generated. |
264 | 264 | */ |
265 | - $jsonld = apply_filters( 'wl_after_get_jsonld', $jsonld, $post_id, $context ); |
|
265 | + $jsonld = apply_filters('wl_after_get_jsonld', $jsonld, $post_id, $context); |
|
266 | 266 | |
267 | 267 | return $jsonld; |
268 | 268 | } |
@@ -281,9 +281,9 @@ discard block |
||
281 | 281 | $is_homepage = is_home() || is_front_page(); |
282 | 282 | $post_id = is_singular() ? get_the_ID() : null; |
283 | 283 | |
284 | - $jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) ); |
|
284 | + $jsonld = wp_json_encode($this->get_jsonld($is_homepage, $post_id, Jsonld_Context_Enum::PAGE)); |
|
285 | 285 | ?> |
286 | - <script type="application/ld+json"><?php echo esc_html( $jsonld ); ?></script> |
|
286 | + <script type="application/ld+json"><?php echo esc_html($jsonld); ?></script> |
|
287 | 287 | <?php |
288 | 288 | } |
289 | 289 |
@@ -18,75 +18,75 @@ |
||
18 | 18 | */ |
19 | 19 | class Wordlift_Category_Taxonomy_Service { |
20 | 20 | |
21 | - /** |
|
22 | - * The {@link Wordlift_Entity_Post_Type_Service} instance. |
|
23 | - * |
|
24 | - * @since 3.11.0 |
|
25 | - * @access private |
|
26 | - * @var \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance. |
|
27 | - */ |
|
28 | - private $entity_post_type_service; |
|
21 | + /** |
|
22 | + * The {@link Wordlift_Entity_Post_Type_Service} instance. |
|
23 | + * |
|
24 | + * @since 3.11.0 |
|
25 | + * @access private |
|
26 | + * @var \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance. |
|
27 | + */ |
|
28 | + private $entity_post_type_service; |
|
29 | 29 | |
30 | - /** |
|
31 | - * Create a {@link Wordlift_Category_Taxonomy_Service} instance. |
|
32 | - * |
|
33 | - * @since 3.11.0 |
|
34 | - * |
|
35 | - * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance. |
|
36 | - */ |
|
37 | - public function __construct( $entity_post_type_service ) { |
|
30 | + /** |
|
31 | + * Create a {@link Wordlift_Category_Taxonomy_Service} instance. |
|
32 | + * |
|
33 | + * @since 3.11.0 |
|
34 | + * |
|
35 | + * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance. |
|
36 | + */ |
|
37 | + public function __construct( $entity_post_type_service ) { |
|
38 | 38 | |
39 | - $this->entity_post_type_service = $entity_post_type_service; |
|
39 | + $this->entity_post_type_service = $entity_post_type_service; |
|
40 | 40 | |
41 | - } |
|
41 | + } |
|
42 | 42 | |
43 | - /** |
|
44 | - * Set the entity post types as one to be included in archive pages. |
|
45 | - * |
|
46 | - * In order to have entities show up in standard WP categories (Posts categories) |
|
47 | - * we configure the `entity` post type, but we also need to alter the main |
|
48 | - * WP query (which by default queries posts only) to include the `entities`. |
|
49 | - * |
|
50 | - * @since 3.11.0 |
|
51 | - * |
|
52 | - * @param WP_Query $query WP's {@link WP_Query} instance. |
|
53 | - */ |
|
54 | - public function pre_get_posts( $query ) { |
|
43 | + /** |
|
44 | + * Set the entity post types as one to be included in archive pages. |
|
45 | + * |
|
46 | + * In order to have entities show up in standard WP categories (Posts categories) |
|
47 | + * we configure the `entity` post type, but we also need to alter the main |
|
48 | + * WP query (which by default queries posts only) to include the `entities`. |
|
49 | + * |
|
50 | + * @since 3.11.0 |
|
51 | + * |
|
52 | + * @param WP_Query $query WP's {@link WP_Query} instance. |
|
53 | + */ |
|
54 | + public function pre_get_posts( $query ) { |
|
55 | 55 | |
56 | - // Only for the main query, avoid problems with widgets and what not. |
|
57 | - if ( ! $query->is_main_query() ) { |
|
58 | - return; |
|
59 | - } |
|
56 | + // Only for the main query, avoid problems with widgets and what not. |
|
57 | + if ( ! $query->is_main_query() ) { |
|
58 | + return; |
|
59 | + } |
|
60 | 60 | |
61 | - // We don't want to alter the query if we're in the admin UI, if this is |
|
62 | - // not a category query, or if the `suppress_filters` is set. |
|
63 | - // |
|
64 | - // Note that it is unlikely for `suppress_filter` to be set on the front |
|
65 | - // end, but let's be safe if it is set the calling code assumes no |
|
66 | - // modifications of queries. |
|
67 | - // |
|
68 | - // is_admin is needed, otherwise category based post filters will show |
|
69 | - // both types and at the current release (4.7) it causes PHP errors. |
|
70 | - if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) { |
|
71 | - return; |
|
72 | - } |
|
61 | + // We don't want to alter the query if we're in the admin UI, if this is |
|
62 | + // not a category query, or if the `suppress_filters` is set. |
|
63 | + // |
|
64 | + // Note that it is unlikely for `suppress_filter` to be set on the front |
|
65 | + // end, but let's be safe if it is set the calling code assumes no |
|
66 | + // modifications of queries. |
|
67 | + // |
|
68 | + // is_admin is needed, otherwise category based post filters will show |
|
69 | + // both types and at the current release (4.7) it causes PHP errors. |
|
70 | + if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) { |
|
71 | + return; |
|
72 | + } |
|
73 | 73 | |
74 | - // Check the current post types, maybe the category archive pages |
|
75 | - // are already associated with other post types. |
|
76 | - // |
|
77 | - // If `post_type` isn't set, WP assumes `post` by default. |
|
78 | - $post_types = $query->get( 'post_type' ); |
|
79 | - $post_types = (array) ( $post_types ? $post_types : 'post' ); |
|
74 | + // Check the current post types, maybe the category archive pages |
|
75 | + // are already associated with other post types. |
|
76 | + // |
|
77 | + // If `post_type` isn't set, WP assumes `post` by default. |
|
78 | + $post_types = $query->get( 'post_type' ); |
|
79 | + $post_types = (array) ( $post_types ? $post_types : 'post' ); |
|
80 | 80 | |
81 | - // Add the entities post type only if the post post type is used in the query |
|
82 | - // since we only want `entities` to appear alongside posts. |
|
83 | - if ( in_array( 'post', $post_types, true ) ) { |
|
84 | - $post_types[] = $this->entity_post_type_service->get_post_type(); |
|
85 | - } |
|
81 | + // Add the entities post type only if the post post type is used in the query |
|
82 | + // since we only want `entities` to appear alongside posts. |
|
83 | + if ( in_array( 'post', $post_types, true ) ) { |
|
84 | + $post_types[] = $this->entity_post_type_service->get_post_type(); |
|
85 | + } |
|
86 | 86 | |
87 | - // Update the query post types. |
|
88 | - $query->set( 'post_type', $post_types ); |
|
87 | + // Update the query post types. |
|
88 | + $query->set( 'post_type', $post_types ); |
|
89 | 89 | |
90 | - } |
|
90 | + } |
|
91 | 91 | |
92 | 92 | } |
@@ -34,7 +34,7 @@ discard block |
||
34 | 34 | * |
35 | 35 | * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance. |
36 | 36 | */ |
37 | - public function __construct( $entity_post_type_service ) { |
|
37 | + public function __construct($entity_post_type_service) { |
|
38 | 38 | |
39 | 39 | $this->entity_post_type_service = $entity_post_type_service; |
40 | 40 | |
@@ -51,10 +51,10 @@ discard block |
||
51 | 51 | * |
52 | 52 | * @param WP_Query $query WP's {@link WP_Query} instance. |
53 | 53 | */ |
54 | - public function pre_get_posts( $query ) { |
|
54 | + public function pre_get_posts($query) { |
|
55 | 55 | |
56 | 56 | // Only for the main query, avoid problems with widgets and what not. |
57 | - if ( ! $query->is_main_query() ) { |
|
57 | + if ( ! $query->is_main_query()) { |
|
58 | 58 | return; |
59 | 59 | } |
60 | 60 | |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | // |
68 | 68 | // is_admin is needed, otherwise category based post filters will show |
69 | 69 | // both types and at the current release (4.7) it causes PHP errors. |
70 | - if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) { |
|
70 | + if (is_admin() || ! is_category() || ! empty($query->query_vars['suppress_filters'])) { |
|
71 | 71 | return; |
72 | 72 | } |
73 | 73 | |
@@ -75,17 +75,17 @@ discard block |
||
75 | 75 | // are already associated with other post types. |
76 | 76 | // |
77 | 77 | // If `post_type` isn't set, WP assumes `post` by default. |
78 | - $post_types = $query->get( 'post_type' ); |
|
79 | - $post_types = (array) ( $post_types ? $post_types : 'post' ); |
|
78 | + $post_types = $query->get('post_type'); |
|
79 | + $post_types = (array) ($post_types ? $post_types : 'post'); |
|
80 | 80 | |
81 | 81 | // Add the entities post type only if the post post type is used in the query |
82 | 82 | // since we only want `entities` to appear alongside posts. |
83 | - if ( in_array( 'post', $post_types, true ) ) { |
|
83 | + if (in_array('post', $post_types, true)) { |
|
84 | 84 | $post_types[] = $this->entity_post_type_service->get_post_type(); |
85 | 85 | } |
86 | 86 | |
87 | 87 | // Update the query post types. |
88 | - $query->set( 'post_type', $post_types ); |
|
88 | + $query->set('post_type', $post_types); |
|
89 | 89 | |
90 | 90 | } |
91 | 91 |
@@ -20,146 +20,146 @@ |
||
20 | 20 | */ |
21 | 21 | class Wordlift_Entity_Type_Adapter { |
22 | 22 | |
23 | - /** |
|
24 | - * A {@link Wordlift_Log_Service} instance. |
|
25 | - * |
|
26 | - * @since 3.15.0 |
|
27 | - * @access private |
|
28 | - * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance. |
|
29 | - */ |
|
30 | - private $log; |
|
31 | - |
|
32 | - /** |
|
33 | - * The {@link Wordlift_Entity_Type_Service} instance. |
|
34 | - * |
|
35 | - * @since 3.15.0 |
|
36 | - * @access private |
|
37 | - * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance. |
|
38 | - */ |
|
39 | - private $entity_type_service; |
|
40 | - |
|
41 | - /** |
|
42 | - * Create a {@link Wordlift_Entity_Type_Adapter} instance. |
|
43 | - * |
|
44 | - * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance. |
|
45 | - * |
|
46 | - * @since 3.15.0 |
|
47 | - */ |
|
48 | - public function __construct( $entity_type_service ) { |
|
49 | - |
|
50 | - $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Adapter' ); |
|
51 | - |
|
52 | - $this->entity_type_service = $entity_type_service; |
|
53 | - |
|
54 | - add_filter( |
|
55 | - 'wl_default_entity_type_for_post_type', |
|
56 | - array( |
|
57 | - $this, |
|
58 | - 'default_entity_type_callback', |
|
59 | - ), |
|
60 | - 10, |
|
61 | - 2 |
|
62 | - ); |
|
63 | - |
|
64 | - } |
|
65 | - |
|
66 | - /** |
|
67 | - * @param $entity_type string Entity type |
|
68 | - * @param $post_type string The post type |
|
69 | - * |
|
70 | - * @return string The default entity type depending on the post type. |
|
71 | - */ |
|
72 | - public function default_entity_type_callback( $entity_type, $post_type ) { |
|
73 | - if ( 'product' === $post_type ) { |
|
74 | - return 'http://schema.org/Product'; |
|
75 | - } |
|
76 | - |
|
77 | - return $entity_type; |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * Hook to `save_post`. |
|
82 | - * |
|
83 | - * This function is called when the `save_post` action is run. The |
|
84 | - * function checks whether an Entity Type term (from the Entity Types |
|
85 | - * taxonomy) is already assigned and, if not, it calls {@link Wordlift_Entity_Type_Service} |
|
86 | - * to set the default taxonomy term. |
|
87 | - * |
|
88 | - * @param int $post_id The {@link WP_Post}'s id. |
|
89 | - * @param WP_Post $post The {@link WP_Post} instance. |
|
90 | - * |
|
91 | - * @since 3.15.0 |
|
92 | - */ |
|
93 | - public function save_post( $post_id, $post ) { |
|
94 | - |
|
95 | - if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post->post_type ) ) { |
|
96 | - $this->log->debug( "Ignoring `{$post->post_type}` post type." ); |
|
97 | - |
|
98 | - // Bail out if the post can not be an entity. |
|
99 | - return; |
|
100 | - } |
|
101 | - |
|
102 | - // Bail out if the post already has an entity type. |
|
103 | - if ( apply_filters( 'wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type( $post_id ) ) ) { |
|
104 | - $this->log->debug( "Post $post_id has already an entity type." ); |
|
105 | - |
|
106 | - return; |
|
107 | - } |
|
108 | - |
|
109 | - $this->log->debug( "Setting `Article` entity type for post $post_id." ); |
|
110 | - |
|
111 | - // Finally set the default entity type. |
|
112 | - |
|
113 | - // For entities use a Thing |
|
114 | - if ( 'entity' === $post->post_type ) { |
|
115 | - $this->entity_type_service->set( $post_id, 'http://schema.org/Thing' ); |
|
116 | - } else { |
|
117 | - // Get the entity types. |
|
118 | - $entity_types = self::get_entity_types( $post->post_type ); |
|
119 | - |
|
120 | - // Set the entity type. |
|
121 | - foreach ( $entity_types as $entity_type ) { |
|
122 | - $this->entity_type_service->set( $post_id, $entity_type, false ); |
|
123 | - } |
|
124 | - } |
|
125 | - |
|
126 | - } |
|
127 | - |
|
128 | - /** |
|
129 | - * Get the entity types for a post type. |
|
130 | - * |
|
131 | - * @param string $post_type The post type. |
|
132 | - * |
|
133 | - * @return array An array of entity types. |
|
134 | - * @since 3.20.0 |
|
135 | - */ |
|
136 | - public static function get_entity_types( $post_type ) { |
|
137 | - |
|
138 | - /** |
|
139 | - * Get the default entity type. |
|
140 | - * |
|
141 | - * @param string $entity_type The preset entity type. |
|
142 | - * @param string $post_type The post type. |
|
143 | - * |
|
144 | - * @since 3.20.0 |
|
145 | - */ |
|
146 | - $default_entity_type = apply_filters( 'wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type ); |
|
147 | - |
|
148 | - /** |
|
149 | - * Get the default entity types. |
|
150 | - * |
|
151 | - * Adding support to assign more than one entity type. |
|
152 | - * |
|
153 | - * @param array $entity_types The default entity types. |
|
154 | - * @param string $post_type The post type. |
|
155 | - * |
|
156 | - * @since 3.20.0 |
|
157 | - * |
|
158 | - * @see Wordlift_Mapping_Service |
|
159 | - */ |
|
160 | - $entity_types = apply_filters( 'wl_default_entity_types_for_post_type', array( $default_entity_type ), $post_type ); |
|
161 | - |
|
162 | - return $entity_types; |
|
163 | - } |
|
23 | + /** |
|
24 | + * A {@link Wordlift_Log_Service} instance. |
|
25 | + * |
|
26 | + * @since 3.15.0 |
|
27 | + * @access private |
|
28 | + * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance. |
|
29 | + */ |
|
30 | + private $log; |
|
31 | + |
|
32 | + /** |
|
33 | + * The {@link Wordlift_Entity_Type_Service} instance. |
|
34 | + * |
|
35 | + * @since 3.15.0 |
|
36 | + * @access private |
|
37 | + * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance. |
|
38 | + */ |
|
39 | + private $entity_type_service; |
|
40 | + |
|
41 | + /** |
|
42 | + * Create a {@link Wordlift_Entity_Type_Adapter} instance. |
|
43 | + * |
|
44 | + * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance. |
|
45 | + * |
|
46 | + * @since 3.15.0 |
|
47 | + */ |
|
48 | + public function __construct( $entity_type_service ) { |
|
49 | + |
|
50 | + $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Adapter' ); |
|
51 | + |
|
52 | + $this->entity_type_service = $entity_type_service; |
|
53 | + |
|
54 | + add_filter( |
|
55 | + 'wl_default_entity_type_for_post_type', |
|
56 | + array( |
|
57 | + $this, |
|
58 | + 'default_entity_type_callback', |
|
59 | + ), |
|
60 | + 10, |
|
61 | + 2 |
|
62 | + ); |
|
63 | + |
|
64 | + } |
|
65 | + |
|
66 | + /** |
|
67 | + * @param $entity_type string Entity type |
|
68 | + * @param $post_type string The post type |
|
69 | + * |
|
70 | + * @return string The default entity type depending on the post type. |
|
71 | + */ |
|
72 | + public function default_entity_type_callback( $entity_type, $post_type ) { |
|
73 | + if ( 'product' === $post_type ) { |
|
74 | + return 'http://schema.org/Product'; |
|
75 | + } |
|
76 | + |
|
77 | + return $entity_type; |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * Hook to `save_post`. |
|
82 | + * |
|
83 | + * This function is called when the `save_post` action is run. The |
|
84 | + * function checks whether an Entity Type term (from the Entity Types |
|
85 | + * taxonomy) is already assigned and, if not, it calls {@link Wordlift_Entity_Type_Service} |
|
86 | + * to set the default taxonomy term. |
|
87 | + * |
|
88 | + * @param int $post_id The {@link WP_Post}'s id. |
|
89 | + * @param WP_Post $post The {@link WP_Post} instance. |
|
90 | + * |
|
91 | + * @since 3.15.0 |
|
92 | + */ |
|
93 | + public function save_post( $post_id, $post ) { |
|
94 | + |
|
95 | + if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post->post_type ) ) { |
|
96 | + $this->log->debug( "Ignoring `{$post->post_type}` post type." ); |
|
97 | + |
|
98 | + // Bail out if the post can not be an entity. |
|
99 | + return; |
|
100 | + } |
|
101 | + |
|
102 | + // Bail out if the post already has an entity type. |
|
103 | + if ( apply_filters( 'wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type( $post_id ) ) ) { |
|
104 | + $this->log->debug( "Post $post_id has already an entity type." ); |
|
105 | + |
|
106 | + return; |
|
107 | + } |
|
108 | + |
|
109 | + $this->log->debug( "Setting `Article` entity type for post $post_id." ); |
|
110 | + |
|
111 | + // Finally set the default entity type. |
|
112 | + |
|
113 | + // For entities use a Thing |
|
114 | + if ( 'entity' === $post->post_type ) { |
|
115 | + $this->entity_type_service->set( $post_id, 'http://schema.org/Thing' ); |
|
116 | + } else { |
|
117 | + // Get the entity types. |
|
118 | + $entity_types = self::get_entity_types( $post->post_type ); |
|
119 | + |
|
120 | + // Set the entity type. |
|
121 | + foreach ( $entity_types as $entity_type ) { |
|
122 | + $this->entity_type_service->set( $post_id, $entity_type, false ); |
|
123 | + } |
|
124 | + } |
|
125 | + |
|
126 | + } |
|
127 | + |
|
128 | + /** |
|
129 | + * Get the entity types for a post type. |
|
130 | + * |
|
131 | + * @param string $post_type The post type. |
|
132 | + * |
|
133 | + * @return array An array of entity types. |
|
134 | + * @since 3.20.0 |
|
135 | + */ |
|
136 | + public static function get_entity_types( $post_type ) { |
|
137 | + |
|
138 | + /** |
|
139 | + * Get the default entity type. |
|
140 | + * |
|
141 | + * @param string $entity_type The preset entity type. |
|
142 | + * @param string $post_type The post type. |
|
143 | + * |
|
144 | + * @since 3.20.0 |
|
145 | + */ |
|
146 | + $default_entity_type = apply_filters( 'wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type ); |
|
147 | + |
|
148 | + /** |
|
149 | + * Get the default entity types. |
|
150 | + * |
|
151 | + * Adding support to assign more than one entity type. |
|
152 | + * |
|
153 | + * @param array $entity_types The default entity types. |
|
154 | + * @param string $post_type The post type. |
|
155 | + * |
|
156 | + * @since 3.20.0 |
|
157 | + * |
|
158 | + * @see Wordlift_Mapping_Service |
|
159 | + */ |
|
160 | + $entity_types = apply_filters( 'wl_default_entity_types_for_post_type', array( $default_entity_type ), $post_type ); |
|
161 | + |
|
162 | + return $entity_types; |
|
163 | + } |
|
164 | 164 | |
165 | 165 | } |
@@ -45,9 +45,9 @@ discard block |
||
45 | 45 | * |
46 | 46 | * @since 3.15.0 |
47 | 47 | */ |
48 | - public function __construct( $entity_type_service ) { |
|
48 | + public function __construct($entity_type_service) { |
|
49 | 49 | |
50 | - $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Adapter' ); |
|
50 | + $this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Type_Adapter'); |
|
51 | 51 | |
52 | 52 | $this->entity_type_service = $entity_type_service; |
53 | 53 | |
@@ -69,8 +69,8 @@ discard block |
||
69 | 69 | * |
70 | 70 | * @return string The default entity type depending on the post type. |
71 | 71 | */ |
72 | - public function default_entity_type_callback( $entity_type, $post_type ) { |
|
73 | - if ( 'product' === $post_type ) { |
|
72 | + public function default_entity_type_callback($entity_type, $post_type) { |
|
73 | + if ('product' === $post_type) { |
|
74 | 74 | return 'http://schema.org/Product'; |
75 | 75 | } |
76 | 76 | |
@@ -90,36 +90,36 @@ discard block |
||
90 | 90 | * |
91 | 91 | * @since 3.15.0 |
92 | 92 | */ |
93 | - public function save_post( $post_id, $post ) { |
|
93 | + public function save_post($post_id, $post) { |
|
94 | 94 | |
95 | - if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post->post_type ) ) { |
|
96 | - $this->log->debug( "Ignoring `{$post->post_type}` post type." ); |
|
95 | + if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type($post->post_type)) { |
|
96 | + $this->log->debug("Ignoring `{$post->post_type}` post type."); |
|
97 | 97 | |
98 | 98 | // Bail out if the post can not be an entity. |
99 | 99 | return; |
100 | 100 | } |
101 | 101 | |
102 | 102 | // Bail out if the post already has an entity type. |
103 | - if ( apply_filters( 'wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type( $post_id ) ) ) { |
|
104 | - $this->log->debug( "Post $post_id has already an entity type." ); |
|
103 | + if (apply_filters('wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type($post_id))) { |
|
104 | + $this->log->debug("Post $post_id has already an entity type."); |
|
105 | 105 | |
106 | 106 | return; |
107 | 107 | } |
108 | 108 | |
109 | - $this->log->debug( "Setting `Article` entity type for post $post_id." ); |
|
109 | + $this->log->debug("Setting `Article` entity type for post $post_id."); |
|
110 | 110 | |
111 | 111 | // Finally set the default entity type. |
112 | 112 | |
113 | 113 | // For entities use a Thing |
114 | - if ( 'entity' === $post->post_type ) { |
|
115 | - $this->entity_type_service->set( $post_id, 'http://schema.org/Thing' ); |
|
114 | + if ('entity' === $post->post_type) { |
|
115 | + $this->entity_type_service->set($post_id, 'http://schema.org/Thing'); |
|
116 | 116 | } else { |
117 | 117 | // Get the entity types. |
118 | - $entity_types = self::get_entity_types( $post->post_type ); |
|
118 | + $entity_types = self::get_entity_types($post->post_type); |
|
119 | 119 | |
120 | 120 | // Set the entity type. |
121 | - foreach ( $entity_types as $entity_type ) { |
|
122 | - $this->entity_type_service->set( $post_id, $entity_type, false ); |
|
121 | + foreach ($entity_types as $entity_type) { |
|
122 | + $this->entity_type_service->set($post_id, $entity_type, false); |
|
123 | 123 | } |
124 | 124 | } |
125 | 125 | |
@@ -133,7 +133,7 @@ discard block |
||
133 | 133 | * @return array An array of entity types. |
134 | 134 | * @since 3.20.0 |
135 | 135 | */ |
136 | - public static function get_entity_types( $post_type ) { |
|
136 | + public static function get_entity_types($post_type) { |
|
137 | 137 | |
138 | 138 | /** |
139 | 139 | * Get the default entity type. |
@@ -143,7 +143,7 @@ discard block |
||
143 | 143 | * |
144 | 144 | * @since 3.20.0 |
145 | 145 | */ |
146 | - $default_entity_type = apply_filters( 'wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type ); |
|
146 | + $default_entity_type = apply_filters('wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type); |
|
147 | 147 | |
148 | 148 | /** |
149 | 149 | * Get the default entity types. |
@@ -157,7 +157,7 @@ discard block |
||
157 | 157 | * |
158 | 158 | * @see Wordlift_Mapping_Service |
159 | 159 | */ |
160 | - $entity_types = apply_filters( 'wl_default_entity_types_for_post_type', array( $default_entity_type ), $post_type ); |
|
160 | + $entity_types = apply_filters('wl_default_entity_types_for_post_type', array($default_entity_type), $post_type); |
|
161 | 161 | |
162 | 162 | return $entity_types; |
163 | 163 | } |
@@ -21,145 +21,145 @@ |
||
21 | 21 | */ |
22 | 22 | class Wordlift_Deactivator_Feedback { |
23 | 23 | |
24 | - /** |
|
25 | - * A {@link Wordlift_Log_Service} instance. |
|
26 | - * |
|
27 | - * @since 3.19.0 |
|
28 | - * @access private |
|
29 | - * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance. |
|
30 | - */ |
|
31 | - private $log; |
|
32 | - |
|
33 | - /** |
|
34 | - * Wordlift_Deactivator_Feedback constructor. |
|
35 | - * |
|
36 | - * @since 3.19.0 |
|
37 | - */ |
|
38 | - public function __construct() { |
|
39 | - |
|
40 | - $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Deactivator_Feedback' ); |
|
41 | - |
|
42 | - } |
|
43 | - |
|
44 | - /** |
|
45 | - * Checks whether we have permissions to show the popup. |
|
46 | - * |
|
47 | - * @return bool `true` if we have permissions, false otherwise. |
|
48 | - * @version 3.19.0 |
|
49 | - */ |
|
50 | - private function has_permission_to_show_popup() { |
|
51 | - // Get the current page. |
|
52 | - global $pagenow; |
|
53 | - |
|
54 | - // Bail if the user doesn't have permissions |
|
55 | - // or if it's not the plugins page. |
|
56 | - if ( 'plugins.php' !== $pagenow ) { |
|
57 | - return false; |
|
58 | - } |
|
59 | - |
|
60 | - // Get the user preferences. We shouldn't show the feedback popup |
|
61 | - // if we don't have permissions for that. |
|
62 | - $user_preferences = Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences(); |
|
63 | - |
|
64 | - // Bail. We don't have preferences to show the popup. |
|
65 | - if ( 'yes' !== $user_preferences ) { |
|
66 | - return false; |
|
67 | - } |
|
68 | - |
|
69 | - return true; |
|
70 | - } |
|
71 | - |
|
72 | - /** |
|
73 | - * Render the feedback popup in the footer. |
|
74 | - * |
|
75 | - * @return void |
|
76 | - * @version 3.19.0 |
|
77 | - */ |
|
78 | - public function render_feedback_popup() { |
|
79 | - // Bail if we don't have permissions to show the popup. |
|
80 | - if ( ! $this->has_permission_to_show_popup() ) { |
|
81 | - return; |
|
82 | - } |
|
83 | - // Include the partial. |
|
84 | - include plugin_dir_path( __FILE__ ) . '../admin/partials/wordlift-admin-deactivation-feedback-popup.php'; |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * Enqueue required popup scripts and styles. |
|
89 | - * |
|
90 | - * @return void |
|
91 | - * @version 3.19.0 |
|
92 | - */ |
|
93 | - public function enqueue_popup_scripts() { |
|
94 | - // Bail if we don't have permissions to show the popup. |
|
95 | - if ( ! $this->has_permission_to_show_popup() ) { |
|
96 | - return; |
|
97 | - } |
|
98 | - |
|
99 | - wp_enqueue_style( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION ); |
|
100 | - wp_enqueue_script( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/js/wordlift-admin-feedback-popup.js', array( 'jquery' ), WORDLIFT_VERSION, false ); |
|
101 | - } |
|
102 | - |
|
103 | - /** |
|
104 | - * Handle the deactivation ajax call |
|
105 | - * and perform a request to external server. |
|
106 | - * |
|
107 | - * @return void |
|
108 | - * @version 3.19.0 |
|
109 | - */ |
|
110 | - public function wl_deactivation_feedback() { |
|
111 | - // Bail if the nonce is not valid. |
|
112 | - if ( |
|
113 | - empty( $_POST['wl_deactivation_feedback_nonce'] ) || // The nonce doens't exists. |
|
114 | - ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['wl_deactivation_feedback_nonce'] ) ), 'wl_deactivation_feedback_nonce' ) // The nonce is invalid. |
|
115 | - ) { |
|
116 | - wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) ); |
|
117 | - } |
|
118 | - |
|
119 | - // We allow user to deactivate without providing a reason |
|
120 | - // so bail and send success response. |
|
121 | - if ( empty( $_POST['code'] ) ) { |
|
122 | - wp_send_json_success(); |
|
123 | - } |
|
124 | - |
|
125 | - $plugin_data = get_plugin_data( plugin_dir_path( __DIR__ ) . 'wordlift.php', false, false ); |
|
126 | - |
|
127 | - // Prepare the options. |
|
128 | - $options = array( |
|
129 | - // The deactivation reason. |
|
130 | - 'code' => sanitize_text_field( wp_unslash( (string) $_POST['code'] ) ), |
|
131 | - // Additional information if provided. |
|
132 | - 'details' => ( ! empty( $_POST['details'] ) ) ? sanitize_text_field( wp_unslash( (string) $_POST['details'] ) ) : '', |
|
133 | - // The website url. |
|
134 | - 'url' => get_bloginfo( 'url' ), |
|
135 | - // WP version. |
|
136 | - 'wordpressVersion' => get_bloginfo( 'version' ), |
|
137 | - // WL version. |
|
138 | - 'wordliftVersion' => $plugin_data['Version'], |
|
139 | - // The admin email. |
|
140 | - 'email' => get_bloginfo( 'admin_email' ), |
|
141 | - ); |
|
142 | - |
|
143 | - $response = wp_remote_post( |
|
144 | - Wordlift_Configuration_Service::get_instance()->get_deactivation_feedback_url(), |
|
145 | - array( |
|
146 | - 'method' => 'POST', |
|
147 | - 'body' => wp_json_encode( $options ), |
|
148 | - 'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ), |
|
149 | - ) |
|
150 | - ); |
|
151 | - |
|
152 | - $code = wp_remote_retrieve_response_code( $response ); |
|
153 | - $message = wp_remote_retrieve_response_message( $response ); |
|
154 | - |
|
155 | - // Add message to the error log if the response code is not 200. |
|
156 | - if ( 201 !== $code ) { |
|
157 | - // Write the error in the logs. |
|
158 | - $this->log->error( 'An error occurred while requesting a feedback endpoint error_code: ' . $code . ' message: ' . $message ); |
|
159 | - } |
|
160 | - |
|
161 | - // We should send success message even when the feedback is not |
|
162 | - // send, because otherwise the plugin cannot be deactivated. |
|
163 | - wp_send_json_success(); |
|
164 | - } |
|
24 | + /** |
|
25 | + * A {@link Wordlift_Log_Service} instance. |
|
26 | + * |
|
27 | + * @since 3.19.0 |
|
28 | + * @access private |
|
29 | + * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance. |
|
30 | + */ |
|
31 | + private $log; |
|
32 | + |
|
33 | + /** |
|
34 | + * Wordlift_Deactivator_Feedback constructor. |
|
35 | + * |
|
36 | + * @since 3.19.0 |
|
37 | + */ |
|
38 | + public function __construct() { |
|
39 | + |
|
40 | + $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Deactivator_Feedback' ); |
|
41 | + |
|
42 | + } |
|
43 | + |
|
44 | + /** |
|
45 | + * Checks whether we have permissions to show the popup. |
|
46 | + * |
|
47 | + * @return bool `true` if we have permissions, false otherwise. |
|
48 | + * @version 3.19.0 |
|
49 | + */ |
|
50 | + private function has_permission_to_show_popup() { |
|
51 | + // Get the current page. |
|
52 | + global $pagenow; |
|
53 | + |
|
54 | + // Bail if the user doesn't have permissions |
|
55 | + // or if it's not the plugins page. |
|
56 | + if ( 'plugins.php' !== $pagenow ) { |
|
57 | + return false; |
|
58 | + } |
|
59 | + |
|
60 | + // Get the user preferences. We shouldn't show the feedback popup |
|
61 | + // if we don't have permissions for that. |
|
62 | + $user_preferences = Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences(); |
|
63 | + |
|
64 | + // Bail. We don't have preferences to show the popup. |
|
65 | + if ( 'yes' !== $user_preferences ) { |
|
66 | + return false; |
|
67 | + } |
|
68 | + |
|
69 | + return true; |
|
70 | + } |
|
71 | + |
|
72 | + /** |
|
73 | + * Render the feedback popup in the footer. |
|
74 | + * |
|
75 | + * @return void |
|
76 | + * @version 3.19.0 |
|
77 | + */ |
|
78 | + public function render_feedback_popup() { |
|
79 | + // Bail if we don't have permissions to show the popup. |
|
80 | + if ( ! $this->has_permission_to_show_popup() ) { |
|
81 | + return; |
|
82 | + } |
|
83 | + // Include the partial. |
|
84 | + include plugin_dir_path( __FILE__ ) . '../admin/partials/wordlift-admin-deactivation-feedback-popup.php'; |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * Enqueue required popup scripts and styles. |
|
89 | + * |
|
90 | + * @return void |
|
91 | + * @version 3.19.0 |
|
92 | + */ |
|
93 | + public function enqueue_popup_scripts() { |
|
94 | + // Bail if we don't have permissions to show the popup. |
|
95 | + if ( ! $this->has_permission_to_show_popup() ) { |
|
96 | + return; |
|
97 | + } |
|
98 | + |
|
99 | + wp_enqueue_style( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION ); |
|
100 | + wp_enqueue_script( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/js/wordlift-admin-feedback-popup.js', array( 'jquery' ), WORDLIFT_VERSION, false ); |
|
101 | + } |
|
102 | + |
|
103 | + /** |
|
104 | + * Handle the deactivation ajax call |
|
105 | + * and perform a request to external server. |
|
106 | + * |
|
107 | + * @return void |
|
108 | + * @version 3.19.0 |
|
109 | + */ |
|
110 | + public function wl_deactivation_feedback() { |
|
111 | + // Bail if the nonce is not valid. |
|
112 | + if ( |
|
113 | + empty( $_POST['wl_deactivation_feedback_nonce'] ) || // The nonce doens't exists. |
|
114 | + ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['wl_deactivation_feedback_nonce'] ) ), 'wl_deactivation_feedback_nonce' ) // The nonce is invalid. |
|
115 | + ) { |
|
116 | + wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) ); |
|
117 | + } |
|
118 | + |
|
119 | + // We allow user to deactivate without providing a reason |
|
120 | + // so bail and send success response. |
|
121 | + if ( empty( $_POST['code'] ) ) { |
|
122 | + wp_send_json_success(); |
|
123 | + } |
|
124 | + |
|
125 | + $plugin_data = get_plugin_data( plugin_dir_path( __DIR__ ) . 'wordlift.php', false, false ); |
|
126 | + |
|
127 | + // Prepare the options. |
|
128 | + $options = array( |
|
129 | + // The deactivation reason. |
|
130 | + 'code' => sanitize_text_field( wp_unslash( (string) $_POST['code'] ) ), |
|
131 | + // Additional information if provided. |
|
132 | + 'details' => ( ! empty( $_POST['details'] ) ) ? sanitize_text_field( wp_unslash( (string) $_POST['details'] ) ) : '', |
|
133 | + // The website url. |
|
134 | + 'url' => get_bloginfo( 'url' ), |
|
135 | + // WP version. |
|
136 | + 'wordpressVersion' => get_bloginfo( 'version' ), |
|
137 | + // WL version. |
|
138 | + 'wordliftVersion' => $plugin_data['Version'], |
|
139 | + // The admin email. |
|
140 | + 'email' => get_bloginfo( 'admin_email' ), |
|
141 | + ); |
|
142 | + |
|
143 | + $response = wp_remote_post( |
|
144 | + Wordlift_Configuration_Service::get_instance()->get_deactivation_feedback_url(), |
|
145 | + array( |
|
146 | + 'method' => 'POST', |
|
147 | + 'body' => wp_json_encode( $options ), |
|
148 | + 'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ), |
|
149 | + ) |
|
150 | + ); |
|
151 | + |
|
152 | + $code = wp_remote_retrieve_response_code( $response ); |
|
153 | + $message = wp_remote_retrieve_response_message( $response ); |
|
154 | + |
|
155 | + // Add message to the error log if the response code is not 200. |
|
156 | + if ( 201 !== $code ) { |
|
157 | + // Write the error in the logs. |
|
158 | + $this->log->error( 'An error occurred while requesting a feedback endpoint error_code: ' . $code . ' message: ' . $message ); |
|
159 | + } |
|
160 | + |
|
161 | + // We should send success message even when the feedback is not |
|
162 | + // send, because otherwise the plugin cannot be deactivated. |
|
163 | + wp_send_json_success(); |
|
164 | + } |
|
165 | 165 | } |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | */ |
38 | 38 | public function __construct() { |
39 | 39 | |
40 | - $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Deactivator_Feedback' ); |
|
40 | + $this->log = Wordlift_Log_Service::get_logger('Wordlift_Deactivator_Feedback'); |
|
41 | 41 | |
42 | 42 | } |
43 | 43 | |
@@ -53,7 +53,7 @@ discard block |
||
53 | 53 | |
54 | 54 | // Bail if the user doesn't have permissions |
55 | 55 | // or if it's not the plugins page. |
56 | - if ( 'plugins.php' !== $pagenow ) { |
|
56 | + if ('plugins.php' !== $pagenow) { |
|
57 | 57 | return false; |
58 | 58 | } |
59 | 59 | |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | $user_preferences = Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences(); |
63 | 63 | |
64 | 64 | // Bail. We don't have preferences to show the popup. |
65 | - if ( 'yes' !== $user_preferences ) { |
|
65 | + if ('yes' !== $user_preferences) { |
|
66 | 66 | return false; |
67 | 67 | } |
68 | 68 | |
@@ -77,11 +77,11 @@ discard block |
||
77 | 77 | */ |
78 | 78 | public function render_feedback_popup() { |
79 | 79 | // Bail if we don't have permissions to show the popup. |
80 | - if ( ! $this->has_permission_to_show_popup() ) { |
|
80 | + if ( ! $this->has_permission_to_show_popup()) { |
|
81 | 81 | return; |
82 | 82 | } |
83 | 83 | // Include the partial. |
84 | - include plugin_dir_path( __FILE__ ) . '../admin/partials/wordlift-admin-deactivation-feedback-popup.php'; |
|
84 | + include plugin_dir_path(__FILE__).'../admin/partials/wordlift-admin-deactivation-feedback-popup.php'; |
|
85 | 85 | } |
86 | 86 | |
87 | 87 | /** |
@@ -92,12 +92,12 @@ discard block |
||
92 | 92 | */ |
93 | 93 | public function enqueue_popup_scripts() { |
94 | 94 | // Bail if we don't have permissions to show the popup. |
95 | - if ( ! $this->has_permission_to_show_popup() ) { |
|
95 | + if ( ! $this->has_permission_to_show_popup()) { |
|
96 | 96 | return; |
97 | 97 | } |
98 | 98 | |
99 | - wp_enqueue_style( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION ); |
|
100 | - wp_enqueue_script( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/js/wordlift-admin-feedback-popup.js', array( 'jquery' ), WORDLIFT_VERSION, false ); |
|
99 | + wp_enqueue_style('wordlift-admin-feedback-popup', plugin_dir_url(__DIR__).'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION); |
|
100 | + wp_enqueue_script('wordlift-admin-feedback-popup', plugin_dir_url(__DIR__).'admin/js/wordlift-admin-feedback-popup.js', array('jquery'), WORDLIFT_VERSION, false); |
|
101 | 101 | } |
102 | 102 | |
103 | 103 | /** |
@@ -110,52 +110,52 @@ discard block |
||
110 | 110 | public function wl_deactivation_feedback() { |
111 | 111 | // Bail if the nonce is not valid. |
112 | 112 | if ( |
113 | - empty( $_POST['wl_deactivation_feedback_nonce'] ) || // The nonce doens't exists. |
|
114 | - ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['wl_deactivation_feedback_nonce'] ) ), 'wl_deactivation_feedback_nonce' ) // The nonce is invalid. |
|
113 | + empty($_POST['wl_deactivation_feedback_nonce']) || // The nonce doens't exists. |
|
114 | + ! wp_verify_nonce(sanitize_text_field(wp_unslash($_POST['wl_deactivation_feedback_nonce'])), 'wl_deactivation_feedback_nonce') // The nonce is invalid. |
|
115 | 115 | ) { |
116 | - wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) ); |
|
116 | + wp_send_json_error(__('Nonce Security Check Failed!', 'wordlift')); |
|
117 | 117 | } |
118 | 118 | |
119 | 119 | // We allow user to deactivate without providing a reason |
120 | 120 | // so bail and send success response. |
121 | - if ( empty( $_POST['code'] ) ) { |
|
121 | + if (empty($_POST['code'])) { |
|
122 | 122 | wp_send_json_success(); |
123 | 123 | } |
124 | 124 | |
125 | - $plugin_data = get_plugin_data( plugin_dir_path( __DIR__ ) . 'wordlift.php', false, false ); |
|
125 | + $plugin_data = get_plugin_data(plugin_dir_path(__DIR__).'wordlift.php', false, false); |
|
126 | 126 | |
127 | 127 | // Prepare the options. |
128 | 128 | $options = array( |
129 | 129 | // The deactivation reason. |
130 | - 'code' => sanitize_text_field( wp_unslash( (string) $_POST['code'] ) ), |
|
130 | + 'code' => sanitize_text_field(wp_unslash((string) $_POST['code'])), |
|
131 | 131 | // Additional information if provided. |
132 | - 'details' => ( ! empty( $_POST['details'] ) ) ? sanitize_text_field( wp_unslash( (string) $_POST['details'] ) ) : '', |
|
132 | + 'details' => ( ! empty($_POST['details'])) ? sanitize_text_field(wp_unslash((string) $_POST['details'])) : '', |
|
133 | 133 | // The website url. |
134 | - 'url' => get_bloginfo( 'url' ), |
|
134 | + 'url' => get_bloginfo('url'), |
|
135 | 135 | // WP version. |
136 | - 'wordpressVersion' => get_bloginfo( 'version' ), |
|
136 | + 'wordpressVersion' => get_bloginfo('version'), |
|
137 | 137 | // WL version. |
138 | 138 | 'wordliftVersion' => $plugin_data['Version'], |
139 | 139 | // The admin email. |
140 | - 'email' => get_bloginfo( 'admin_email' ), |
|
140 | + 'email' => get_bloginfo('admin_email'), |
|
141 | 141 | ); |
142 | 142 | |
143 | 143 | $response = wp_remote_post( |
144 | 144 | Wordlift_Configuration_Service::get_instance()->get_deactivation_feedback_url(), |
145 | 145 | array( |
146 | 146 | 'method' => 'POST', |
147 | - 'body' => wp_json_encode( $options ), |
|
148 | - 'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ), |
|
147 | + 'body' => wp_json_encode($options), |
|
148 | + 'headers' => array('Content-Type' => 'application/json; charset=utf-8'), |
|
149 | 149 | ) |
150 | 150 | ); |
151 | 151 | |
152 | - $code = wp_remote_retrieve_response_code( $response ); |
|
153 | - $message = wp_remote_retrieve_response_message( $response ); |
|
152 | + $code = wp_remote_retrieve_response_code($response); |
|
153 | + $message = wp_remote_retrieve_response_message($response); |
|
154 | 154 | |
155 | 155 | // Add message to the error log if the response code is not 200. |
156 | - if ( 201 !== $code ) { |
|
156 | + if (201 !== $code) { |
|
157 | 157 | // Write the error in the logs. |
158 | - $this->log->error( 'An error occurred while requesting a feedback endpoint error_code: ' . $code . ' message: ' . $message ); |
|
158 | + $this->log->error('An error occurred while requesting a feedback endpoint error_code: '.$code.' message: '.$message); |
|
159 | 159 | } |
160 | 160 | |
161 | 161 | // We should send success message even when the feedback is not |
@@ -23,107 +23,107 @@ |
||
23 | 23 | */ |
24 | 24 | class Wordlift_Loader { |
25 | 25 | |
26 | - /** |
|
27 | - * The array of actions registered with WordPress. |
|
28 | - * |
|
29 | - * @since 1.0.0 |
|
30 | - * @access protected |
|
31 | - * @var array $actions The actions registered with WordPress to fire when the plugin loads. |
|
32 | - */ |
|
33 | - protected $actions; |
|
34 | - |
|
35 | - /** |
|
36 | - * The array of filters registered with WordPress. |
|
37 | - * |
|
38 | - * @since 1.0.0 |
|
39 | - * @access protected |
|
40 | - * @var array $filters The filters registered with WordPress to fire when the plugin loads. |
|
41 | - */ |
|
42 | - protected $filters; |
|
43 | - |
|
44 | - /** |
|
45 | - * Initialize the collections used to maintain the actions and filters. |
|
46 | - * |
|
47 | - * @since 1.0.0 |
|
48 | - */ |
|
49 | - public function __construct() { |
|
50 | - |
|
51 | - $this->actions = array(); |
|
52 | - $this->filters = array(); |
|
53 | - |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * Add a new action to the collection to be registered with WordPress. |
|
58 | - * |
|
59 | - * @since 1.0.0 |
|
60 | - * @param string $hook The name of the WordPress action that is being registered. |
|
61 | - * @param object $component A reference to the instance of the object on which the action is defined. |
|
62 | - * @param string $callback The name of the function definition on the $component. |
|
63 | - * @param int $priority Optional. he priority at which the function should be fired. Default is 10. |
|
64 | - * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1. |
|
65 | - */ |
|
66 | - public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { |
|
67 | - add_action( $hook, array( $component, $callback ), $priority, $accepted_args ); |
|
68 | - } |
|
69 | - |
|
70 | - /** |
|
71 | - * Add a new filter to the collection to be registered with WordPress. |
|
72 | - * |
|
73 | - * @since 1.0.0 |
|
74 | - * @param string $hook The name of the WordPress filter that is being registered. |
|
75 | - * @param object $component A reference to the instance of the object on which the filter is defined. |
|
76 | - * @param string $callback The name of the function definition on the $component. |
|
77 | - * @param int $priority Optional. he priority at which the function should be fired. Default is 10. |
|
78 | - * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1 |
|
79 | - */ |
|
80 | - public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { |
|
81 | - add_filter( $hook, array( $component, $callback ), $priority, $accepted_args ); |
|
82 | - } |
|
83 | - |
|
84 | - /** |
|
85 | - * A utility function that is used to register the actions and hooks into a single |
|
86 | - * collection. |
|
87 | - * |
|
88 | - * @since 1.0.0 |
|
89 | - * @access private |
|
90 | - * @param array $hooks The collection of hooks that is being registered (that is, actions or filters). |
|
91 | - * @param string $hook The name of the WordPress filter that is being registered. |
|
92 | - * @param object $component A reference to the instance of the object on which the filter is defined. |
|
93 | - * @param string $callback The name of the function definition on the $component. |
|
94 | - * @param int $priority The priority at which the function should be fired. |
|
95 | - * @param int $accepted_args The number of arguments that should be passed to the $callback. |
|
96 | - * @return array The collection of actions and filters registered with WordPress. |
|
97 | - */ |
|
98 | - private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) { |
|
99 | - |
|
100 | - $hooks[] = array( |
|
101 | - 'hook' => $hook, |
|
102 | - 'component' => $component, |
|
103 | - 'callback' => $callback, |
|
104 | - 'priority' => $priority, |
|
105 | - 'accepted_args' => $accepted_args, |
|
106 | - ); |
|
107 | - |
|
108 | - return $hooks; |
|
109 | - |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * Register the filters and actions with WordPress. |
|
114 | - * |
|
115 | - * @since 1.0.0 |
|
116 | - */ |
|
117 | - public function run() { |
|
118 | - |
|
119 | - foreach ( $this->filters as $hook ) { |
|
120 | - add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] ); |
|
121 | - } |
|
122 | - |
|
123 | - foreach ( $this->actions as $hook ) { |
|
124 | - add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] ); |
|
125 | - } |
|
126 | - |
|
127 | - } |
|
26 | + /** |
|
27 | + * The array of actions registered with WordPress. |
|
28 | + * |
|
29 | + * @since 1.0.0 |
|
30 | + * @access protected |
|
31 | + * @var array $actions The actions registered with WordPress to fire when the plugin loads. |
|
32 | + */ |
|
33 | + protected $actions; |
|
34 | + |
|
35 | + /** |
|
36 | + * The array of filters registered with WordPress. |
|
37 | + * |
|
38 | + * @since 1.0.0 |
|
39 | + * @access protected |
|
40 | + * @var array $filters The filters registered with WordPress to fire when the plugin loads. |
|
41 | + */ |
|
42 | + protected $filters; |
|
43 | + |
|
44 | + /** |
|
45 | + * Initialize the collections used to maintain the actions and filters. |
|
46 | + * |
|
47 | + * @since 1.0.0 |
|
48 | + */ |
|
49 | + public function __construct() { |
|
50 | + |
|
51 | + $this->actions = array(); |
|
52 | + $this->filters = array(); |
|
53 | + |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * Add a new action to the collection to be registered with WordPress. |
|
58 | + * |
|
59 | + * @since 1.0.0 |
|
60 | + * @param string $hook The name of the WordPress action that is being registered. |
|
61 | + * @param object $component A reference to the instance of the object on which the action is defined. |
|
62 | + * @param string $callback The name of the function definition on the $component. |
|
63 | + * @param int $priority Optional. he priority at which the function should be fired. Default is 10. |
|
64 | + * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1. |
|
65 | + */ |
|
66 | + public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { |
|
67 | + add_action( $hook, array( $component, $callback ), $priority, $accepted_args ); |
|
68 | + } |
|
69 | + |
|
70 | + /** |
|
71 | + * Add a new filter to the collection to be registered with WordPress. |
|
72 | + * |
|
73 | + * @since 1.0.0 |
|
74 | + * @param string $hook The name of the WordPress filter that is being registered. |
|
75 | + * @param object $component A reference to the instance of the object on which the filter is defined. |
|
76 | + * @param string $callback The name of the function definition on the $component. |
|
77 | + * @param int $priority Optional. he priority at which the function should be fired. Default is 10. |
|
78 | + * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1 |
|
79 | + */ |
|
80 | + public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { |
|
81 | + add_filter( $hook, array( $component, $callback ), $priority, $accepted_args ); |
|
82 | + } |
|
83 | + |
|
84 | + /** |
|
85 | + * A utility function that is used to register the actions and hooks into a single |
|
86 | + * collection. |
|
87 | + * |
|
88 | + * @since 1.0.0 |
|
89 | + * @access private |
|
90 | + * @param array $hooks The collection of hooks that is being registered (that is, actions or filters). |
|
91 | + * @param string $hook The name of the WordPress filter that is being registered. |
|
92 | + * @param object $component A reference to the instance of the object on which the filter is defined. |
|
93 | + * @param string $callback The name of the function definition on the $component. |
|
94 | + * @param int $priority The priority at which the function should be fired. |
|
95 | + * @param int $accepted_args The number of arguments that should be passed to the $callback. |
|
96 | + * @return array The collection of actions and filters registered with WordPress. |
|
97 | + */ |
|
98 | + private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) { |
|
99 | + |
|
100 | + $hooks[] = array( |
|
101 | + 'hook' => $hook, |
|
102 | + 'component' => $component, |
|
103 | + 'callback' => $callback, |
|
104 | + 'priority' => $priority, |
|
105 | + 'accepted_args' => $accepted_args, |
|
106 | + ); |
|
107 | + |
|
108 | + return $hooks; |
|
109 | + |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * Register the filters and actions with WordPress. |
|
114 | + * |
|
115 | + * @since 1.0.0 |
|
116 | + */ |
|
117 | + public function run() { |
|
118 | + |
|
119 | + foreach ( $this->filters as $hook ) { |
|
120 | + add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] ); |
|
121 | + } |
|
122 | + |
|
123 | + foreach ( $this->actions as $hook ) { |
|
124 | + add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] ); |
|
125 | + } |
|
126 | + |
|
127 | + } |
|
128 | 128 | |
129 | 129 | } |
@@ -63,8 +63,8 @@ discard block |
||
63 | 63 | * @param int $priority Optional. he priority at which the function should be fired. Default is 10. |
64 | 64 | * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1. |
65 | 65 | */ |
66 | - public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { |
|
67 | - add_action( $hook, array( $component, $callback ), $priority, $accepted_args ); |
|
66 | + public function add_action($hook, $component, $callback, $priority = 10, $accepted_args = 1) { |
|
67 | + add_action($hook, array($component, $callback), $priority, $accepted_args); |
|
68 | 68 | } |
69 | 69 | |
70 | 70 | /** |
@@ -77,8 +77,8 @@ discard block |
||
77 | 77 | * @param int $priority Optional. he priority at which the function should be fired. Default is 10. |
78 | 78 | * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1 |
79 | 79 | */ |
80 | - public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { |
|
81 | - add_filter( $hook, array( $component, $callback ), $priority, $accepted_args ); |
|
80 | + public function add_filter($hook, $component, $callback, $priority = 10, $accepted_args = 1) { |
|
81 | + add_filter($hook, array($component, $callback), $priority, $accepted_args); |
|
82 | 82 | } |
83 | 83 | |
84 | 84 | /** |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | * @param int $accepted_args The number of arguments that should be passed to the $callback. |
96 | 96 | * @return array The collection of actions and filters registered with WordPress. |
97 | 97 | */ |
98 | - private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) { |
|
98 | + private function add($hooks, $hook, $component, $callback, $priority, $accepted_args) { |
|
99 | 99 | |
100 | 100 | $hooks[] = array( |
101 | 101 | 'hook' => $hook, |
@@ -116,12 +116,12 @@ discard block |
||
116 | 116 | */ |
117 | 117 | public function run() { |
118 | 118 | |
119 | - foreach ( $this->filters as $hook ) { |
|
120 | - add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] ); |
|
119 | + foreach ($this->filters as $hook) { |
|
120 | + add_filter($hook['hook'], array($hook['component'], $hook['callback']), $hook['priority'], $hook['accepted_args']); |
|
121 | 121 | } |
122 | 122 | |
123 | - foreach ( $this->actions as $hook ) { |
|
124 | - add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] ); |
|
123 | + foreach ($this->actions as $hook) { |
|
124 | + add_action($hook['hook'], array($hook['component'], $hook['callback']), $hook['priority'], $hook['accepted_args']); |
|
125 | 125 | } |
126 | 126 | |
127 | 127 | } |
@@ -17,202 +17,202 @@ |
||
17 | 17 | */ |
18 | 18 | class Wordlift_Api_Service { |
19 | 19 | |
20 | - /** |
|
21 | - * The {@link Wordlift_Api_Service} singleton instance. |
|
22 | - * |
|
23 | - * @since 3.20.0 |
|
24 | - * @access private |
|
25 | - * @var \Wordlift_Api_Service $instance The singleton instance. |
|
26 | - */ |
|
27 | - private static $instance; |
|
28 | - |
|
29 | - /** |
|
30 | - * @var Api_Headers_Service|null |
|
31 | - */ |
|
32 | - private $headers_service; |
|
33 | - |
|
34 | - /** |
|
35 | - * Create a {@link Wordlift_Api_Service} instance. |
|
36 | - * |
|
37 | - * @since 3.20.0 |
|
38 | - */ |
|
39 | - public function __construct() { |
|
40 | - self::$instance = $this; |
|
41 | - $this->headers_service = Api_Headers_Service::get_instance(); |
|
42 | - } |
|
43 | - |
|
44 | - /** |
|
45 | - * Get the {@link Wordlift_Api_Service} singleton instance. |
|
46 | - * |
|
47 | - * @return \Wordlift_Api_Service The {@link Wordlift_Api_Service} singleton instance. |
|
48 | - * @since 3.20.0 |
|
49 | - */ |
|
50 | - public static function get_instance() { |
|
51 | - |
|
52 | - return self::$instance; |
|
53 | - } |
|
54 | - |
|
55 | - /** |
|
56 | - * Perform a `GET` request towards the requested path. |
|
57 | - * |
|
58 | - * @param string $path The relative path. |
|
59 | - * |
|
60 | - * @return array|WP_Error |
|
61 | - * @since 3.20.0 |
|
62 | - */ |
|
63 | - public function get( $path ) { |
|
64 | - |
|
65 | - // Prepare the target URL. |
|
66 | - $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path; |
|
67 | - |
|
68 | - // Get the response value. |
|
69 | - $response = wp_remote_get( |
|
70 | - $url, |
|
71 | - array( |
|
72 | - 'user-agent' => User_Agent::get_user_agent(), |
|
73 | - 'headers' => array( |
|
74 | - 'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(), |
|
75 | - ) + $this->headers_service->get_wp_headers(), |
|
76 | - /* |
|
20 | + /** |
|
21 | + * The {@link Wordlift_Api_Service} singleton instance. |
|
22 | + * |
|
23 | + * @since 3.20.0 |
|
24 | + * @access private |
|
25 | + * @var \Wordlift_Api_Service $instance The singleton instance. |
|
26 | + */ |
|
27 | + private static $instance; |
|
28 | + |
|
29 | + /** |
|
30 | + * @var Api_Headers_Service|null |
|
31 | + */ |
|
32 | + private $headers_service; |
|
33 | + |
|
34 | + /** |
|
35 | + * Create a {@link Wordlift_Api_Service} instance. |
|
36 | + * |
|
37 | + * @since 3.20.0 |
|
38 | + */ |
|
39 | + public function __construct() { |
|
40 | + self::$instance = $this; |
|
41 | + $this->headers_service = Api_Headers_Service::get_instance(); |
|
42 | + } |
|
43 | + |
|
44 | + /** |
|
45 | + * Get the {@link Wordlift_Api_Service} singleton instance. |
|
46 | + * |
|
47 | + * @return \Wordlift_Api_Service The {@link Wordlift_Api_Service} singleton instance. |
|
48 | + * @since 3.20.0 |
|
49 | + */ |
|
50 | + public static function get_instance() { |
|
51 | + |
|
52 | + return self::$instance; |
|
53 | + } |
|
54 | + |
|
55 | + /** |
|
56 | + * Perform a `GET` request towards the requested path. |
|
57 | + * |
|
58 | + * @param string $path The relative path. |
|
59 | + * |
|
60 | + * @return array|WP_Error |
|
61 | + * @since 3.20.0 |
|
62 | + */ |
|
63 | + public function get( $path ) { |
|
64 | + |
|
65 | + // Prepare the target URL. |
|
66 | + $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path; |
|
67 | + |
|
68 | + // Get the response value. |
|
69 | + $response = wp_remote_get( |
|
70 | + $url, |
|
71 | + array( |
|
72 | + 'user-agent' => User_Agent::get_user_agent(), |
|
73 | + 'headers' => array( |
|
74 | + 'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(), |
|
75 | + ) + $this->headers_service->get_wp_headers(), |
|
76 | + /* |
|
77 | 77 | * Increase the timeout from the default of 5 to 30 secs. |
78 | 78 | * |
79 | 79 | * @see https://github.com/insideout10/wordlift-plugin/issues/906 |
80 | 80 | * |
81 | 81 | * @since 3.20.1 |
82 | 82 | */ |
83 | - 'timeout' => 30, |
|
84 | - ) |
|
85 | - ); |
|
86 | - |
|
87 | - return self::get_message_or_error( $response ); |
|
88 | - } |
|
89 | - |
|
90 | - /** |
|
91 | - * Perform a `POST` request towards the requested path. |
|
92 | - * |
|
93 | - * @param string $path The relative path. |
|
94 | - * @param array|object $body The request body (will be serialized to JSON). |
|
95 | - * |
|
96 | - * @return array|WP_Error |
|
97 | - * @since 3.20.0 |
|
98 | - */ |
|
99 | - public function post( $path, $body ) { |
|
100 | - |
|
101 | - return $this->post_custom_content_type( |
|
102 | - $path, |
|
103 | - wp_json_encode( $body ), |
|
104 | - 'application/json; ' . get_bloginfo( 'charset' ) |
|
105 | - ); |
|
106 | - } |
|
107 | - |
|
108 | - public function post_custom_content_type( $path, $body, $content_type ) { |
|
109 | - |
|
110 | - // Prepare the target URL. |
|
111 | - $url = apply_filters( 'wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url() . $path ); |
|
112 | - |
|
113 | - // Give some time for the operation to complete, more than the time we give to the HTTP operation to complete. |
|
114 | - // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
|
115 | - @set_time_limit( 90 ); |
|
116 | - |
|
117 | - // Get the response value. |
|
118 | - $key = Wordlift_Configuration_Service::get_instance()->get_key(); |
|
119 | - $response = wp_remote_post( |
|
120 | - $url, |
|
121 | - array( |
|
122 | - 'timeout' => 60, |
|
123 | - 'user-agent' => User_Agent::get_user_agent(), |
|
124 | - 'headers' => array( |
|
125 | - 'Content-Type' => $content_type, |
|
126 | - 'X-Authorization' => $key, |
|
127 | - 'Authorization' => "Key $key", |
|
128 | - /* |
|
83 | + 'timeout' => 30, |
|
84 | + ) |
|
85 | + ); |
|
86 | + |
|
87 | + return self::get_message_or_error( $response ); |
|
88 | + } |
|
89 | + |
|
90 | + /** |
|
91 | + * Perform a `POST` request towards the requested path. |
|
92 | + * |
|
93 | + * @param string $path The relative path. |
|
94 | + * @param array|object $body The request body (will be serialized to JSON). |
|
95 | + * |
|
96 | + * @return array|WP_Error |
|
97 | + * @since 3.20.0 |
|
98 | + */ |
|
99 | + public function post( $path, $body ) { |
|
100 | + |
|
101 | + return $this->post_custom_content_type( |
|
102 | + $path, |
|
103 | + wp_json_encode( $body ), |
|
104 | + 'application/json; ' . get_bloginfo( 'charset' ) |
|
105 | + ); |
|
106 | + } |
|
107 | + |
|
108 | + public function post_custom_content_type( $path, $body, $content_type ) { |
|
109 | + |
|
110 | + // Prepare the target URL. |
|
111 | + $url = apply_filters( 'wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url() . $path ); |
|
112 | + |
|
113 | + // Give some time for the operation to complete, more than the time we give to the HTTP operation to complete. |
|
114 | + // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
|
115 | + @set_time_limit( 90 ); |
|
116 | + |
|
117 | + // Get the response value. |
|
118 | + $key = Wordlift_Configuration_Service::get_instance()->get_key(); |
|
119 | + $response = wp_remote_post( |
|
120 | + $url, |
|
121 | + array( |
|
122 | + 'timeout' => 60, |
|
123 | + 'user-agent' => User_Agent::get_user_agent(), |
|
124 | + 'headers' => array( |
|
125 | + 'Content-Type' => $content_type, |
|
126 | + 'X-Authorization' => $key, |
|
127 | + 'Authorization' => "Key $key", |
|
128 | + /* |
|
129 | 129 | * This is required to avoid CURL receiving 502 Bad Gateway errors. |
130 | 130 | * |
131 | 131 | * @see https://stackoverflow.com/questions/30601075/curl-to-google-compute-load-balancer-gets-error-502 |
132 | 132 | */ |
133 | - 'Expect' => '', |
|
134 | - ) + $this->headers_service->get_wp_headers(), |
|
135 | - 'body' => $body, |
|
136 | - ) |
|
137 | - ); |
|
138 | - |
|
139 | - return self::get_message_or_error( $response ); |
|
140 | - } |
|
141 | - |
|
142 | - public function delete( $path ) { |
|
143 | - |
|
144 | - // Prepare the target URL. |
|
145 | - $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path; |
|
146 | - |
|
147 | - // Get the response value. |
|
148 | - $response = wp_remote_request( |
|
149 | - $url, |
|
150 | - array( |
|
151 | - 'method' => 'DELETE', |
|
152 | - 'user-agent' => User_Agent::get_user_agent(), |
|
153 | - 'headers' => array( |
|
154 | - 'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(), |
|
155 | - ) + $this->headers_service->get_wp_headers(), |
|
156 | - ) |
|
157 | - ); |
|
158 | - |
|
159 | - return self::get_message_or_error( $response ); |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * Return the {@link WP_Error} in case of error or the actual reply if successful. |
|
164 | - * |
|
165 | - * @param array|WP_Error $response The response of an http call. |
|
166 | - * |
|
167 | - * @return string|object|WP_Error A {@link WP_Error} instance or the actual response content. |
|
168 | - * @since 3.20.0 |
|
169 | - */ |
|
170 | - private static function get_message_or_error( $response ) { |
|
171 | - |
|
172 | - // Result is WP_Error. |
|
173 | - if ( is_wp_error( $response ) ) { |
|
174 | - return $response; |
|
175 | - } |
|
176 | - |
|
177 | - // `code` not set or not numeric. |
|
178 | - $code = wp_remote_retrieve_response_code( $response ); |
|
179 | - // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
|
180 | - $message = @wp_remote_retrieve_response_message( $response ); |
|
181 | - |
|
182 | - if ( empty( $code ) || ! is_numeric( $code ) ) { |
|
183 | - return new WP_Error( 0, $message ); |
|
184 | - } |
|
185 | - |
|
186 | - // Code not 2xx. |
|
187 | - if ( 2 !== intval( $code / 100 ) ) { |
|
188 | - return new WP_Error( $code, $message ); |
|
189 | - } |
|
190 | - |
|
191 | - // Everything's fine, return the message. |
|
192 | - return self::try_json_decode( $response ); |
|
193 | - } |
|
194 | - |
|
195 | - /** |
|
196 | - * Try to decode the json response |
|
197 | - * |
|
198 | - * @param array $response The response array. |
|
199 | - * |
|
200 | - * @return array|mixed|object The decoded response or the original response body. |
|
201 | - * @since 3.20.0 |
|
202 | - */ |
|
203 | - private static function try_json_decode( $response ) { |
|
204 | - |
|
205 | - // Get the headers. |
|
206 | - $content_type = wp_remote_retrieve_header( $response, 'content-type' ); |
|
207 | - $body = wp_remote_retrieve_body( $response ); |
|
208 | - |
|
209 | - // If it's not an `application/json` return the plain response body. |
|
210 | - if ( 0 !== strpos( strtolower( $content_type ), 'application/json' ) ) { |
|
211 | - return $body; |
|
212 | - } |
|
213 | - |
|
214 | - // Decode and return the structured result. |
|
215 | - return json_decode( $body ); |
|
216 | - } |
|
133 | + 'Expect' => '', |
|
134 | + ) + $this->headers_service->get_wp_headers(), |
|
135 | + 'body' => $body, |
|
136 | + ) |
|
137 | + ); |
|
138 | + |
|
139 | + return self::get_message_or_error( $response ); |
|
140 | + } |
|
141 | + |
|
142 | + public function delete( $path ) { |
|
143 | + |
|
144 | + // Prepare the target URL. |
|
145 | + $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path; |
|
146 | + |
|
147 | + // Get the response value. |
|
148 | + $response = wp_remote_request( |
|
149 | + $url, |
|
150 | + array( |
|
151 | + 'method' => 'DELETE', |
|
152 | + 'user-agent' => User_Agent::get_user_agent(), |
|
153 | + 'headers' => array( |
|
154 | + 'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(), |
|
155 | + ) + $this->headers_service->get_wp_headers(), |
|
156 | + ) |
|
157 | + ); |
|
158 | + |
|
159 | + return self::get_message_or_error( $response ); |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * Return the {@link WP_Error} in case of error or the actual reply if successful. |
|
164 | + * |
|
165 | + * @param array|WP_Error $response The response of an http call. |
|
166 | + * |
|
167 | + * @return string|object|WP_Error A {@link WP_Error} instance or the actual response content. |
|
168 | + * @since 3.20.0 |
|
169 | + */ |
|
170 | + private static function get_message_or_error( $response ) { |
|
171 | + |
|
172 | + // Result is WP_Error. |
|
173 | + if ( is_wp_error( $response ) ) { |
|
174 | + return $response; |
|
175 | + } |
|
176 | + |
|
177 | + // `code` not set or not numeric. |
|
178 | + $code = wp_remote_retrieve_response_code( $response ); |
|
179 | + // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
|
180 | + $message = @wp_remote_retrieve_response_message( $response ); |
|
181 | + |
|
182 | + if ( empty( $code ) || ! is_numeric( $code ) ) { |
|
183 | + return new WP_Error( 0, $message ); |
|
184 | + } |
|
185 | + |
|
186 | + // Code not 2xx. |
|
187 | + if ( 2 !== intval( $code / 100 ) ) { |
|
188 | + return new WP_Error( $code, $message ); |
|
189 | + } |
|
190 | + |
|
191 | + // Everything's fine, return the message. |
|
192 | + return self::try_json_decode( $response ); |
|
193 | + } |
|
194 | + |
|
195 | + /** |
|
196 | + * Try to decode the json response |
|
197 | + * |
|
198 | + * @param array $response The response array. |
|
199 | + * |
|
200 | + * @return array|mixed|object The decoded response or the original response body. |
|
201 | + * @since 3.20.0 |
|
202 | + */ |
|
203 | + private static function try_json_decode( $response ) { |
|
204 | + |
|
205 | + // Get the headers. |
|
206 | + $content_type = wp_remote_retrieve_header( $response, 'content-type' ); |
|
207 | + $body = wp_remote_retrieve_body( $response ); |
|
208 | + |
|
209 | + // If it's not an `application/json` return the plain response body. |
|
210 | + if ( 0 !== strpos( strtolower( $content_type ), 'application/json' ) ) { |
|
211 | + return $body; |
|
212 | + } |
|
213 | + |
|
214 | + // Decode and return the structured result. |
|
215 | + return json_decode( $body ); |
|
216 | + } |
|
217 | 217 | |
218 | 218 | } |
@@ -60,10 +60,10 @@ discard block |
||
60 | 60 | * @return array|WP_Error |
61 | 61 | * @since 3.20.0 |
62 | 62 | */ |
63 | - public function get( $path ) { |
|
63 | + public function get($path) { |
|
64 | 64 | |
65 | 65 | // Prepare the target URL. |
66 | - $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path; |
|
66 | + $url = Wordlift_Configuration_Service::get_instance()->get_api_url().$path; |
|
67 | 67 | |
68 | 68 | // Get the response value. |
69 | 69 | $response = wp_remote_get( |
@@ -84,7 +84,7 @@ discard block |
||
84 | 84 | ) |
85 | 85 | ); |
86 | 86 | |
87 | - return self::get_message_or_error( $response ); |
|
87 | + return self::get_message_or_error($response); |
|
88 | 88 | } |
89 | 89 | |
90 | 90 | /** |
@@ -96,23 +96,23 @@ discard block |
||
96 | 96 | * @return array|WP_Error |
97 | 97 | * @since 3.20.0 |
98 | 98 | */ |
99 | - public function post( $path, $body ) { |
|
99 | + public function post($path, $body) { |
|
100 | 100 | |
101 | 101 | return $this->post_custom_content_type( |
102 | 102 | $path, |
103 | - wp_json_encode( $body ), |
|
104 | - 'application/json; ' . get_bloginfo( 'charset' ) |
|
103 | + wp_json_encode($body), |
|
104 | + 'application/json; '.get_bloginfo('charset') |
|
105 | 105 | ); |
106 | 106 | } |
107 | 107 | |
108 | - public function post_custom_content_type( $path, $body, $content_type ) { |
|
108 | + public function post_custom_content_type($path, $body, $content_type) { |
|
109 | 109 | |
110 | 110 | // Prepare the target URL. |
111 | - $url = apply_filters( 'wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url() . $path ); |
|
111 | + $url = apply_filters('wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url().$path); |
|
112 | 112 | |
113 | 113 | // Give some time for the operation to complete, more than the time we give to the HTTP operation to complete. |
114 | 114 | // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
115 | - @set_time_limit( 90 ); |
|
115 | + @set_time_limit(90); |
|
116 | 116 | |
117 | 117 | // Get the response value. |
118 | 118 | $key = Wordlift_Configuration_Service::get_instance()->get_key(); |
@@ -136,13 +136,13 @@ discard block |
||
136 | 136 | ) |
137 | 137 | ); |
138 | 138 | |
139 | - return self::get_message_or_error( $response ); |
|
139 | + return self::get_message_or_error($response); |
|
140 | 140 | } |
141 | 141 | |
142 | - public function delete( $path ) { |
|
142 | + public function delete($path) { |
|
143 | 143 | |
144 | 144 | // Prepare the target URL. |
145 | - $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path; |
|
145 | + $url = Wordlift_Configuration_Service::get_instance()->get_api_url().$path; |
|
146 | 146 | |
147 | 147 | // Get the response value. |
148 | 148 | $response = wp_remote_request( |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | ) |
157 | 157 | ); |
158 | 158 | |
159 | - return self::get_message_or_error( $response ); |
|
159 | + return self::get_message_or_error($response); |
|
160 | 160 | } |
161 | 161 | |
162 | 162 | /** |
@@ -167,29 +167,29 @@ discard block |
||
167 | 167 | * @return string|object|WP_Error A {@link WP_Error} instance or the actual response content. |
168 | 168 | * @since 3.20.0 |
169 | 169 | */ |
170 | - private static function get_message_or_error( $response ) { |
|
170 | + private static function get_message_or_error($response) { |
|
171 | 171 | |
172 | 172 | // Result is WP_Error. |
173 | - if ( is_wp_error( $response ) ) { |
|
173 | + if (is_wp_error($response)) { |
|
174 | 174 | return $response; |
175 | 175 | } |
176 | 176 | |
177 | 177 | // `code` not set or not numeric. |
178 | - $code = wp_remote_retrieve_response_code( $response ); |
|
178 | + $code = wp_remote_retrieve_response_code($response); |
|
179 | 179 | // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged |
180 | - $message = @wp_remote_retrieve_response_message( $response ); |
|
180 | + $message = @wp_remote_retrieve_response_message($response); |
|
181 | 181 | |
182 | - if ( empty( $code ) || ! is_numeric( $code ) ) { |
|
183 | - return new WP_Error( 0, $message ); |
|
182 | + if (empty($code) || ! is_numeric($code)) { |
|
183 | + return new WP_Error(0, $message); |
|
184 | 184 | } |
185 | 185 | |
186 | 186 | // Code not 2xx. |
187 | - if ( 2 !== intval( $code / 100 ) ) { |
|
188 | - return new WP_Error( $code, $message ); |
|
187 | + if (2 !== intval($code / 100)) { |
|
188 | + return new WP_Error($code, $message); |
|
189 | 189 | } |
190 | 190 | |
191 | 191 | // Everything's fine, return the message. |
192 | - return self::try_json_decode( $response ); |
|
192 | + return self::try_json_decode($response); |
|
193 | 193 | } |
194 | 194 | |
195 | 195 | /** |
@@ -200,19 +200,19 @@ discard block |
||
200 | 200 | * @return array|mixed|object The decoded response or the original response body. |
201 | 201 | * @since 3.20.0 |
202 | 202 | */ |
203 | - private static function try_json_decode( $response ) { |
|
203 | + private static function try_json_decode($response) { |
|
204 | 204 | |
205 | 205 | // Get the headers. |
206 | - $content_type = wp_remote_retrieve_header( $response, 'content-type' ); |
|
207 | - $body = wp_remote_retrieve_body( $response ); |
|
206 | + $content_type = wp_remote_retrieve_header($response, 'content-type'); |
|
207 | + $body = wp_remote_retrieve_body($response); |
|
208 | 208 | |
209 | 209 | // If it's not an `application/json` return the plain response body. |
210 | - if ( 0 !== strpos( strtolower( $content_type ), 'application/json' ) ) { |
|
210 | + if (0 !== strpos(strtolower($content_type), 'application/json')) { |
|
211 | 211 | return $body; |
212 | 212 | } |
213 | 213 | |
214 | 214 | // Decode and return the structured result. |
215 | - return json_decode( $body ); |
|
215 | + return json_decode($body); |
|
216 | 216 | } |
217 | 217 | |
218 | 218 | } |