AJAX
1 day ago
Admin_Page
3 weeks ago
Click_Tracking
1 month ago
ColumnOptions
7 months ago
Cron
9 months ago
Data_Pruning
2 weeks ago
Date_Picker
4 months ago
Date_Range
6 months ago
Ecommerce
1 day ago
Email_Reports
3 weeks ago
Examiner
4 months ago
Favicon
3 months ago
Form_Submissions
1 month ago
Integrations
1 month ago
Journey
3 months ago
Migrations
6 months ago
Models
1 day ago
Overview
3 months ago
Public_API
6 months ago
RealTime
2 weeks ago
Rows
2 weeks ago
Statistics
1 month ago
Tables
3 weeks ago
Utils
3 weeks ago
Views
1 month ago
ViewsColumn
1 month ago
WooCommerceOrderMetaBox
6 months ago
ActivationLifecycle.php
4 months ago
Admin_Bar_Stats.php
1 month ago
Appearance.php
1 year ago
BreakdanceFormAction.php
1 month ago
Campaign_Builder.php
1 month ago
Capability_Manager.php
1 month ago
Chart.php
3 months ago
Chart_Data.php
1 year ago
Click_Tracking.php
3 months ago
ComplianzIntegration.php
4 months ago
Cron_Job.php
6 months ago
Cron_Manager.php
6 months ago
Dashboard_Options.php
7 months ago
Dashboard_Widget.php
3 months ago
Database.php
9 months ago
Database_Manager.php
1 month ago
Empty_Report_Option.php
2 years ago
Env.php
1 month ago
Examiner_Config.php
1 year ago
FetchFaviconsJob.php
6 months ago
Filters.php
3 weeks ago
Geo_Database_Health_Check_Job.php
9 months ago
Geo_Database_Manager.php
7 months ago
Geoposition.php
1 year ago
Icon_Directory.php
7 months ago
Icon_Directory_Factory.php
2 years ago
Illuminate_Builder.php
11 months ago
Independent_Analytics.php
1 week ago
Interrupt.php
4 months ago
Known_Referrers.php
1 month ago
MainWP.php
3 months ago
Map.php
9 months ago
Map_Data.php
1 year ago
Migration_Fixer_Job.php
6 months ago
Patch.php
1 year ago
Payload_Validator.php
9 months ago
Plugin_Conflict_Detector.php
1 month ago
Plugin_Group.php
7 months ago
Plugin_Group_Option.php
2 years ago
Query.php
1 year ago
Query_Taps.php
4 months ago
Quick_Stats.php
4 months ago
REST_API.php
1 month ago
Report.php
1 year ago
Report_Finder.php
7 months ago
Report_Options_Parser.php
9 months ago
Resource_Identifier.php
1 day ago
Settings.php
3 months ago
Sort_Configuration.php
9 months ago
Tables.php
9 months ago
Track_Resource_Changes.php
1 year ago
View_Counter.php
7 months ago
VisitorSaltRefreshInterval.php
7 months ago
WP_Option_Cache_Bust.php
2 years ago
Resource_Identifier.php
236 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP; |
| 4 | |
| 5 | use IAWP\Utils\Request; |
| 6 | /** @internal */ |
| 7 | class Resource_Identifier |
| 8 | { |
| 9 | private $type; |
| 10 | private $meta_key; |
| 11 | private $meta_value; |
| 12 | /** |
| 13 | * @param string $type |
| 14 | * @param string|null $meta_key |
| 15 | * @param int|string|null $meta_value |
| 16 | */ |
| 17 | private function __construct(string $type, ?string $meta_key = null, $meta_value = null) |
| 18 | { |
| 19 | $this->type = $type; |
| 20 | $this->meta_key = $meta_key; |
| 21 | $this->meta_value = $meta_value; |
| 22 | } |
| 23 | /** |
| 24 | * @return string |
| 25 | */ |
| 26 | public function type() : string |
| 27 | { |
| 28 | return $this->type; |
| 29 | } |
| 30 | /** |
| 31 | * @return string|null |
| 32 | */ |
| 33 | public function meta_key() : ?string |
| 34 | { |
| 35 | return $this->meta_key; |
| 36 | } |
| 37 | /** |
| 38 | * @return int|string|null |
| 39 | */ |
| 40 | public function meta_value() |
| 41 | { |
| 42 | return $this->meta_value; |
| 43 | } |
| 44 | /** |
| 45 | * @return bool |
| 46 | */ |
| 47 | public function has_meta() : bool |
| 48 | { |
| 49 | return !\is_null($this->meta_key) && !\is_null($this->meta_value); |
| 50 | } |
| 51 | /** |
| 52 | * @return self|null |
| 53 | */ |
| 54 | public static function for_resource_being_viewed() : ?self |
| 55 | { |
| 56 | if (self::is_searchiq_results()) { |
| 57 | $type = 'search'; |
| 58 | $meta_key = 'search_query'; |
| 59 | $meta_value = \get_query_var(\get_option('_siq_search_query_param_name', 'q')); |
| 60 | } elseif (\is_string(self::get_virtual_page_id())) { |
| 61 | $type = 'virtual_page'; |
| 62 | $meta_key = 'virtual_page_id'; |
| 63 | $meta_value = self::get_virtual_page_id(); |
| 64 | } elseif (\is_singular()) { |
| 65 | $singular_id = \get_queried_object_id(); |
| 66 | if (\get_post($singular_id)) { |
| 67 | $type = 'singular'; |
| 68 | $meta_key = 'singular_id'; |
| 69 | $meta_value = $singular_id; |
| 70 | } else { |
| 71 | return null; |
| 72 | } |
| 73 | } elseif (\is_author()) { |
| 74 | $author_id = \get_queried_object_id(); |
| 75 | if (\get_user_by('id', $author_id)) { |
| 76 | $type = 'author_archive'; |
| 77 | $meta_key = 'author_id'; |
| 78 | $meta_value = $author_id; |
| 79 | } else { |
| 80 | return null; |
| 81 | } |
| 82 | } elseif (\is_date()) { |
| 83 | $type = 'date_archive'; |
| 84 | $meta_key = 'date_archive'; |
| 85 | $meta_value = self::get_date_archive_date(); |
| 86 | } elseif (\is_search()) { |
| 87 | $type = 'search'; |
| 88 | $meta_key = 'search_query'; |
| 89 | $meta_value = \get_search_query(); |
| 90 | } elseif (\is_post_type_archive() && !\is_tax()) { |
| 91 | $type = 'post_type_archive'; |
| 92 | $meta_key = 'post_type'; |
| 93 | $meta_value = ''; |
| 94 | $queried_object = \get_queried_object(); |
| 95 | if ($queried_object instanceof \WP_Post_Type) { |
| 96 | $meta_value = $queried_object->name; |
| 97 | } elseif ($queried_object instanceof \WP_Post) { |
| 98 | $post_type_name = \get_query_var('post_type'); |
| 99 | $meta_value = \is_array($post_type_name) ? \reset($post_type_name) : $post_type_name; |
| 100 | } |
| 101 | } elseif (\is_category()) { |
| 102 | $category_id = \get_queried_object_id(); |
| 103 | $category_name = \get_the_category_by_ID($category_id); |
| 104 | if (\is_wp_error($category_name)) { |
| 105 | return null; |
| 106 | } |
| 107 | $type = 'term_archive'; |
| 108 | $meta_key = 'term_id'; |
| 109 | $meta_value = $category_id; |
| 110 | } elseif (\is_tag()) { |
| 111 | $tag_id = \get_queried_object_id(); |
| 112 | $tag = \get_tag($tag_id); |
| 113 | if ($tag === null || \is_wp_error($tag)) { |
| 114 | return null; |
| 115 | } |
| 116 | $type = 'term_archive'; |
| 117 | $meta_key = 'term_id'; |
| 118 | $meta_value = $tag_id; |
| 119 | } elseif (\is_tax()) { |
| 120 | $term_id = \get_queried_object_id(); |
| 121 | $term = \get_term($term_id); |
| 122 | if ($term === null || \is_wp_error($term)) { |
| 123 | return null; |
| 124 | } |
| 125 | $type = 'term_archive'; |
| 126 | $meta_key = 'term_id'; |
| 127 | $meta_value = $term_id; |
| 128 | } elseif (\is_home()) { |
| 129 | $type = 'home'; |
| 130 | $meta_key = null; |
| 131 | $meta_value = null; |
| 132 | } elseif (\is_404()) { |
| 133 | $path = Request::path_relative_to_site_url(); |
| 134 | if (\is_null($path)) { |
| 135 | return null; |
| 136 | } |
| 137 | $type = '404'; |
| 138 | $meta_key = 'not_found_url'; |
| 139 | $meta_value = $path; |
| 140 | } else { |
| 141 | return null; |
| 142 | } |
| 143 | return new self($type, $meta_key, $meta_value); |
| 144 | } |
| 145 | /** |
| 146 | * @return self|null |
| 147 | */ |
| 148 | public static function for_resource_being_edited() : ?self |
| 149 | { |
| 150 | if (!\is_admin()) { |
| 151 | return null; |
| 152 | } |
| 153 | $screen = \get_current_screen(); |
| 154 | $is_post_editing_screen = !\is_null($screen) && $screen->base === 'post'; |
| 155 | if (!$is_post_editing_screen) { |
| 156 | return null; |
| 157 | } |
| 158 | // Check if the current screen is post editing page |
| 159 | $singular_id = \get_the_ID(); |
| 160 | if (\is_int($singular_id)) { |
| 161 | $singular_id = \strval($singular_id); |
| 162 | } else { |
| 163 | return null; |
| 164 | } |
| 165 | // Add an exception for the WooCommerce shop page |
| 166 | if (\IAWPSCOPED\iawp()->is_woocommerce_support_enabled()) { |
| 167 | $shop_id = \strval(wc_get_page_id('shop')); |
| 168 | if ($shop_id === $singular_id) { |
| 169 | return new self('post_type_archive', 'post_type', 'product'); |
| 170 | } |
| 171 | } |
| 172 | return new self('singular', 'singular_id', $singular_id); |
| 173 | } |
| 174 | public static function for_post_id(int $post_id) : ?self |
| 175 | { |
| 176 | return new self('singular', 'singular_id', $post_id); |
| 177 | } |
| 178 | private static function get_virtual_page_id() : ?string |
| 179 | { |
| 180 | if (\is_404()) { |
| 181 | return null; |
| 182 | } |
| 183 | $post = \get_post(); |
| 184 | if (\IAWPSCOPED\iawp()->is_woocommerce_support_enabled() && is_checkout() && is_wc_endpoint_url('order-received')) { |
| 185 | return 'wc_checkout_success'; |
| 186 | } |
| 187 | if (\IAWPSCOPED\iawp()->is_surecart_support_enabled() && \is_object($post) && $post->post_type === 'sc_product' && \property_exists($post, 'sc_id')) { |
| 188 | return 'sc_product_' . $post->sc_id; |
| 189 | } |
| 190 | if (\IAWPSCOPED\iawp()->is_surecart_support_enabled() && \is_object($post) && $post->post_type === 'sc_collection' && \property_exists($post, 'sc_id')) { |
| 191 | return 'sc_collection_' . $post->sc_id; |
| 192 | } |
| 193 | if (\IAWPSCOPED\iawp()->is_surecart_support_enabled() && \is_object($post) && $post->post_type === 'sc_upsell' && \property_exists($post, 'sc_id')) { |
| 194 | return 'sc_upsell_' . $post->sc_id; |
| 195 | } |
| 196 | // TODO - What's the pro slug? |
| 197 | if (\is_plugin_active('clickwhale/clickwhale.php') && \is_object($post) && \property_exists($post, 'linkpage') && \is_array($post->linkpage)) { |
| 198 | return 'clickwhale_link_page_' . $post->linkpage['id']; |
| 199 | } |
| 200 | return null; |
| 201 | } |
| 202 | /** |
| 203 | * Build a date archive string with the year and possibly a month and date |
| 204 | * |
| 205 | * Examples would be "2023", "2023-01", or "2023-01-21" |
| 206 | * |
| 207 | * @return mixed|string |
| 208 | */ |
| 209 | private static function get_date_archive_date() |
| 210 | { |
| 211 | $str = \get_query_var('year'); |
| 212 | if (\is_month() || \is_day()) { |
| 213 | $month = \get_query_var('monthnum'); |
| 214 | $str = $str . '-' . \str_pad($month, 2, '0', \STR_PAD_LEFT); |
| 215 | } |
| 216 | if (\is_day()) { |
| 217 | $day = \get_query_var('day'); |
| 218 | $str = $str . '-' . \str_pad($day, 2, '0', \STR_PAD_LEFT); |
| 219 | } |
| 220 | return $str; |
| 221 | } |
| 222 | private static function is_searchiq_results() |
| 223 | { |
| 224 | if (!\is_plugin_active('searchiq/searchiq.php')) { |
| 225 | return \false; |
| 226 | } |
| 227 | if (\get_query_var(\get_option('_siq_search_query_param_name', 'q')) !== '') { |
| 228 | $post = \get_post(\get_queried_object_id()); |
| 229 | if (\has_shortcode($post->post_content, 'siq_ajax_search')) { |
| 230 | return \true; |
| 231 | } |
| 232 | } |
| 233 | return \false; |
| 234 | } |
| 235 | } |
| 236 |