Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<?php
/*
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC. All rights reserved. |
| |
| This work is published under the GNU AGPLv3 license with some |
| permitted exceptions and without any warranty. For full license |
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC https://civicrm.org/licensing
*
*/
// This file must not accessed directly.
if (!defined('ABSPATH')) {
exit;
}
/**
* Polylang plugin compatatibility class.
*
* @since 5.66
*/
class CiviCRM_For_WordPress_Compat_Polylang {
/**
* @var object
* Plugin object reference.
* @since 5.66
* @access public
*/
public $civi;
/**
* @var array
* Base Page data.
* @since 5.66
* @access private
*/
private $basepages = [];
/**
* @var array
* Collected rewrites.
* @since 5.66
* @access private
*/
private $rewrites = [];
/**
* Instance constructor.
*
* @since 5.66
*/
public function __construct() {
// Store reference to CiviCRM plugin object.
$this->civi = civi_wp();
// Register plugin compatibility hooks.
$this->register_hooks();
}
/**
* Register hooks.
*
* This is called via the constructor during the "plugins_loaded" action which
* is much earlier that CiviCRM's own internal hooks. The reason for this is
* that compability may need callbacks for events that fire well before "init"
* which is when CiviCRM begins to load.
*
* @since 5.66
*/
public function register_hooks() {
// Bail if CiviCRM not installed yet.
if (!CIVICRM_INSTALLED) {
return;
}
// Bail if Polylang is not present.
if (!function_exists('pll_languages_list')) {
return;
}
// Register Polylang compatibility callbacks.
add_action('civicrm_after_rewrite_rules', [$this, 'rewrite_rules'], 10, 2);
add_filter('pll_check_canonical_url', [$this, 'canonical_url'], 10, 2);
add_filter('civicrm/basepage/match', [$this, 'basepage_match'], 10, 2);
add_filter('civicrm/core/url/base', [$this, 'base_url_filter'], 10, 2);
add_filter('civicrm/core/locale', [$this, 'locale_filter'], 10, 2);
}
/**
* Support Polylang.
*
* @since 5.24
* @since 5.66 Moved to this class.
*
* @param bool $flush_rewrite_rules True if rules flushed, false otherwise.
* @param WP_Post $basepage The Base Page post object.
*/
public function rewrite_rules($flush_rewrite_rules, $basepage) {
/*
* Collect all rewrite rules into an array.
*
* Because the array of specific Post IDs is added *after* the array of
* paths for the Base Page ID, those specific rewrite rules will "win" over
* the more general Base Page rules.
*/
$collected_rewrites = [];
// Support prefixes for a single Base Page.
$basepage_url = get_permalink($basepage->ID);
$basepage_raw_url = PLL()->links_model->remove_language_from_link($basepage_url);
$language_slugs = pll_languages_list();
foreach ($language_slugs as $slug) {
$language = PLL()->model->get_language($slug);
$language_url = PLL()->links_model->add_language_to_link($basepage_raw_url, $language);
$parsed_url = wp_parse_url($language_url, PHP_URL_PATH);
$regex_path = substr($parsed_url, 1);
$collected_rewrites[$basepage->ID][] = $regex_path;
$post_id = pll_get_post($basepage->ID, $slug);
if (!empty($post_id)) {
$collected_rewrites[$post_id][] = $regex_path;
}
};
// Support prefixes for Base Pages in multiple languages.
foreach ($language_slugs as $slug) {
$post_id = pll_get_post($basepage->ID, $slug);
if (empty($post_id)) {
continue;
}
$url = get_permalink($post_id);
$parsed_url = wp_parse_url($url, PHP_URL_PATH);
$regex_path = substr($parsed_url, 1);
$collected_rewrites[$basepage->ID][] = $regex_path;
$collected_rewrites[$post_id][] = $regex_path;
};
// Make collection unique and add remaining rewrite rules.
$this->rewrites = array_map('array_unique', $collected_rewrites);
if (!empty($this->rewrites)) {
foreach ($this->rewrites as $post_id => $rewrite) {
foreach ($rewrite as $path) {
add_rewrite_rule(
'^' . $path . '([^?]*)?',
'index.php?page_id=' . $post_id . '&civiwp=CiviCRM&q=civicrm%2F$matches[1]',
'top'
);
}
}
}
// Maybe force flush.
if ($flush_rewrite_rules) {
flush_rewrite_rules();
}
}
/**
* Prevents Polylang from redirecting CiviCRM URLs.
*
* @since 5.66
*
* @param string|false $redirect_url False or the URL to redirect to.
* @param PLL_Language $language The language detected.
* @return string|false $redirect_url False or the URL to redirect to.
*/
public function canonical_url($redirect_url, $language) {
// Bail if this is not a Page.
if (!is_page()) {
return $redirect_url;
}
if (!($post instanceof WP_Post)) {
return $redirect_url;
}
// Bail if this is not a Base Page.
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
if (!empty($this->rewrites)) {
foreach ($this->rewrites as $post_id => $rewrite) {
if ($post_id === $post->ID) {
return FALSE;
}
}
}
return $redirect_url;
}
/**
* Checks Polylang for CiviCRM Base Page matches.
*
* @since 5.66
*
* @param bool $is_basepage TRUE if the Post ID matches the Base Page ID, FALSE otherwise.
* @param int $post_id The WordPress Post ID to check.
* @return bool $is_basepage TRUE if the Post ID matches the Base Page ID, FALSE otherwise.
*/
public function basepage_match($is_basepage, $post_id) {
// Bail if this is already the Base Page.
if ($is_basepage) {
return $is_basepage;
}
// Bail if there are no rewrites.
if (empty($this->rewrites)) {
return $is_basepage;
}
foreach ($this->rewrites as $page_id => $rewrite) {
if ($post_id === $page_id) {
$is_basepage = TRUE;
}
}
return $is_basepage;
}
/**
* Filters the CiviCRM Base URL for the current language reported by Polylang.
*
* Only filters URLs that point to the front-end, since WordPress admin URLs are not
* rewritten by Polylang.
*
* @since 5.66
*
* @param str $url The URL as built by CiviCRM.
* @param bool $admin_request True if building an admin URL, false otherwise.
* @return str $url The URL as modified by Polylang.
*/
public function base_url_filter($url, $admin_request) {
// Skip when not defined.
if (empty($url) || $admin_request) {
return $url;
}
// Find the language slug.
$slug = pll_current_language();
if (empty($slug)) {
return $url;
}
// Build the modified URL.
$raw_url = PLL()->links_model->remove_language_from_link($url);
$language = PLL()->model->get_language($slug);
$language_url = PLL()->links_model->add_language_to_link($raw_url, $language);
return $language_url;
}
/**
* Filters the CiviCRM locale for the current language as set by Polylang.
*
* @since 5.66
*
* @param str $locale The locale as reported by WordPress.
* @return str $locale The locale as modified by Polylang.
*/
public function locale_filter($locale) {
$pll_locale = pll_current_language('locale');
if (!empty($pll_locale)) {
$locale = $pll_locale;
}
return $locale;
}
}