polylang / include / links-directory.php

links-directory.php in Polylang 1.3, at include/links-directory.php

219 lines 7.4 KB

Raw Download Zip

1	<?php
2
3	/*
4	* links model for use when the language code is added in url as a directory
5	* for example mysite.com/en/something
6	* implements the "links_model interface"
7	*
8	* @since 1.2
9	*/
10	class PLL_Links_Directory {
11	public $model, $options;
12	protected $home, $rewrite_rules = array();
13	protected $always_rewrite = array('date', 'root', 'comments', 'search', 'author', 'post_format', 'language');
14
15	/*
16	* constructor
17	*
18	* @since 1.2
19	*
20	* @param object $model PLL_Model instance
21	*/
22	public function __construct($model) {
23	$this->model = &$model;
24	$this->options = &$model->options;
25	$this->home = get_option('home');
26
27	add_action ('setup_theme', array(&$this, 'add_permastruct'));
28
29	// refresh rewrite rules if the 'page_on_front' option is modified
30	add_action('update_option_page_on_front', 'flush_rewrite_rules');
31
32	// make sure to prepare rewrite rules when flushing
33	add_action ('pre_option_rewrite_rules', array(&$this, 'prepare_rewrite_rules'));
34	}
35
36	/*
37	* adds the language code in url
38	* links_model interface
39	*
40	* @since 1.2
41	*
42	* @param string $url url to modify
43	* @param object $lang language
44	* @return string modified url
45	*/
46	public function add_language_to_link($url, $lang) {
47	if (!empty($lang)) {
48	global $wp_rewrite;
49
50	$base = $this->options['rewrite'] ? '' : 'language/';
51	$slug = $this->options['default_lang'] == $lang->slug && $this->options['hide_default'] ? '' : $base.$lang->slug.'/';
52	return str_replace($this->home.'/'.$wp_rewrite->root, $this->home.'/'.$wp_rewrite->root.$slug, $url);
53	}
54	return $url;
55	}
56
57	/*
58	* returns the url without language code
59	* links_model interface
60	*
61	* @since 1.2
62	*
63	* @param string $url url to modify
64	* @return string modified url
65	*/
66	function remove_language_from_link($url) {
67	foreach ($this->model->get_languages_list() as $language)
68	if (!$this->options['hide_default'] \|\| $this->options['default_lang'] != $language->slug)
69	$languages[] = $language->slug;
70
71	if (!empty($languages)) {
72	global $wp_rewrite;
73	$pattern = '#' . ($this->options['rewrite'] ? '' : '\/language') . '\/('.implode('\|', $languages).')\/#';
74	$url = preg_replace($pattern, $wp_rewrite->root . '/', $url);
75	}
76	return $url;
77	}
78
79	/*
80	* returns the link to the first page
81	* links_model interface
82	*
83	* @since 1.2
84	*
85	* @param string $url url to modify
86	* @return string modified url
87	*/
88	function remove_paged_from_link($url) {
89	return preg_replace('#\/page\/[0-9]+\/#', '/', $url);
90	}
91
92	/*
93	* returns the language based on language code in url
94	* links_model interface
95	*
96	* @since 1.2
97	*
98	* @return string language slug
99	*/
100	public function get_language_from_url() {
101	$root = $this->options['rewrite'] ? '' : 'language/';
102	$pattern = '#\/'.$root.'('.implode('\|', $this->model->get_languages_list(array('fields' => 'slug'))).')\/#';
103	return preg_match($pattern, trailingslashit($_SERVER['REQUEST_URI']), $matches) ? $matches[1] : ''; // $matches[1] is the slug of the requested language
104	}
105
106	/*
107	* optionaly removes 'language' in permalinks so that we get http://www.myblog/en/ instead of http://www.myblog/language/en/
108	*
109	* @since 1.2
110	*/
111	function add_permastruct() {
112	// language information always in front of the uri ('with_front' => false)
113	// the 3rd parameter structure has been modified in WP 3.4
114	// backward compatibility WP < 3.4
115	add_permastruct('language', $this->options['rewrite'] ? '%language%' : 'language/%language%',
116	version_compare($GLOBALS['wp_version'], '3.4' , '<') ? false : array('with_front' => false));
117	}
118
119	/*
120	* prepares rewrite rules filters
121	*
122	* @since 0.8.1
123	*
124	* @param array $pre not used
125	* @return unmodified $pre
126	*/
127	public function prepare_rewrite_rules($pre) {
128	//clean filters which could have been set in a previous call (may occur when changing Polylang settings)
129	foreach ($this->rewrite_rules as $type)
130	remove_filter($type . '_rewrite_rules', array(&$this, 'rewrite_rules'));
131
132	// don't modify the rules if there is no languages created yet
133	if ($this->model->get_languages_list()) {
134	// make sure we have the right post types and taxonomies
135	$types = array_values(array_merge($this->model->get_translated_post_types(), $this->model->get_translated_taxonomies()));
136	$types = array_merge($this->always_rewrite, $types);
137	$this->rewrite_rules = apply_filters('pll_rewrite_rules', $types); // allow plugins to add rewrite rules to the language filter
138
139	foreach ($this->rewrite_rules as $type)
140	add_filter($type . '_rewrite_rules', array(&$this, 'rewrite_rules'));
141
142	add_filter('rewrite_rules_array', array(&$this, 'rewrite_rules')); // needed for post type archives
143	}
144	return $pre;
145	}
146
147	/*
148	* the rewrite rules !
149	* always make sure the default language is at the end in case the language information is hidden for default language
150	* thanks to brbrbr http://wordpress.org/support/topic/plugin-polylang-rewrite-rules-not-correct
151	*
152	* @since 0.8.1
153	*
154	* @param array $rules rewrite rules
155	* @return array modified rewrite rules
156	*/
157	public function rewrite_rules($rules) {
158	$filter = str_replace('_rewrite_rules', '', current_filter());
159
160	// suppress the rules created by WordPress for our taxonomy
161	if ($filter == 'language')
162	return array();
163
164	global $wp_rewrite;
165	$newrules = array();
166
167	$languages = $this->model->get_languages_list(array('fields' => 'slug'));
168	if ($this->options['hide_default'])
169	$languages = array_diff($languages, array($this->options['default_lang']));
170
171	if (!empty($languages))
172	$slug = $wp_rewrite->root . ($this->options['rewrite'] ? '' : 'language/') . '('.implode('\|', $languages).')/';
173
174	// for custom post type archives
175	$cpts = array_intersect($this->model->post_types, get_post_types(array('_builtin' => false)));
176	$cpts = $cpts ? '#post_type=('.implode('\|', $cpts).')#' : '';
177
178	foreach ($rules as $key => $rule) {
179	// we don't need the lang parameter for post types and taxonomies
180	// moreover adding it would create issues for pages and taxonomies
181	if ($this->options['force_lang'] && in_array($filter, array_merge($this->model->post_types, $this->model->taxonomies))) {
182	if (isset($slug))
183	$newrules[$slug.str_replace($wp_rewrite->root, '', $key)] = str_replace(
184	array('[8]', '[7]', '[6]', '[5]', '[4]', '[3]', '[2]', '[1]'),
185	array('[9]', '[8]', '[7]', '[6]', '[5]', '[4]', '[3]', '[2]'),
186	$rule
187	); // hopefully it is sufficient!
188
189	if ($this->options['hide_default']) {
190	$newrules[$key] = $rules[$key];
191	// unset only if we hide the code for the default language as check_language_code_in_url will do its job in other cases
192	unset($rules[$key]);
193	}
194	}
195
196	// rewrite rules filtered by language
197	elseif (in_array($filter, $this->always_rewrite) \|\| ($cpts && preg_match($cpts, $rule) && !strpos($rule, 'name=')) \|\| ($filter != 'rewrite_rules_array' && $this->options['force_lang'])) {
198	if (isset($slug))
199	$newrules[$slug.str_replace($wp_rewrite->root, '', $key)] = str_replace(
200	array('[8]', '[7]', '[6]', '[5]', '[4]', '[3]', '[2]', '[1]', '?'),
201	array('[9]', '[8]', '[7]', '[6]', '[5]', '[4]', '[3]', '[2]', '?lang=$matches[1]&'),
202	$rule
203	); // should be enough!
204
205	if ($this->options['hide_default'])
206	$newrules[$key] = str_replace('?', '?lang='.$this->options['default_lang'].'&', $rule);
207
208	unset($rules[$key]); // now useless
209	}
210	}
211
212	// the home rewrite rule
213	if ($filter == 'root' && isset($slug))
214	$newrules[$slug.'?$'] = $wp_rewrite->index.'?lang=$matches[1]';
215
216	return $newrules + $rules;
217	}
218	}
219