polylang / include / base.php

base.php in Polylang 2.8.4, at include/base.php

190 lines 5.3 KB

Raw Download Zip

1	<?php
2	/**
3	* @package Polylang
4	*/
5
6	/**
7	* Base class for both admin and frontend
8	*
9	* @since 1.2
10	*/
11	abstract class PLL_Base {
12	/**
13	* Stores the plugin options.
14	*
15	* @var array
16	*/
17	public $options;
18
19	/**
20	* Instance of PLL_Model.
21	*
22	* @var PLL_Model
23	*/
24	public $model;
25
26	/**
27	* Instance of a child class of PLL_Links_Model.
28	*
29	* @var PLL_Links_Model
30	*/
31	public $links_model;
32
33	/**
34	* Registers hooks on insert / update post related actions and filters.
35	*
36	* @var PLL_CRUD_Posts
37	*/
38	public $posts;
39
40	/**
41	* Registers hooks on insert / update term related action and filters.
42	*
43	* @var PLL_CRUD_Terms
44	*/
45	public $terms;
46
47	/**
48	* Constructor
49	*
50	* @since 1.2
51	*
52	* @param object $links_model
53	*/
54	public function __construct( &$links_model ) {
55	$this->links_model = &$links_model;
56	$this->model = &$links_model->model;
57	$this->options = &$this->model->options;
58
59	$GLOBALS['l10n_unloaded']['pll_string'] = true; // Short-circuit _load_textdomain_just_in_time() for 'pll_string' domain in WP 4.6+
60
61	add_action( 'widgets_init', array( $this, 'widgets_init' ) );
62
63	// User defined strings translations
64	add_action( 'pll_language_defined', array( $this, 'load_strings_translations' ), 5 );
65	add_action( 'change_locale', array( $this, 'load_strings_translations' ) ); // Since WP 4.7
66
67	// Switch_to_blog
68	add_action( 'switch_blog', array( $this, 'switch_blog' ), 10, 2 );
69	}
70
71	/**
72	* Instantiates classes reacting to CRUD operations on posts and terms,
73	* only when at least one language is defined.
74	*
75	* @since 2.6
76	*/
77	public function init() {
78	if ( $this->model->get_languages_list() ) {
79	$this->posts = new PLL_CRUD_Posts( $this );
80	$this->terms = new PLL_CRUD_Terms( $this );
81	}
82	}
83
84	/**
85	* Registers our widgets
86	*
87	* @since 0.1
88	*/
89	public function widgets_init() {
90	register_widget( 'PLL_Widget_Languages' );
91
92	// Overwrites the calendar widget to filter posts by language
93	if ( ! defined( 'PLL_WIDGET_CALENDAR' ) \|\| PLL_WIDGET_CALENDAR ) {
94	unregister_widget( 'WP_Widget_Calendar' );
95	register_widget( 'PLL_Widget_Calendar' );
96	}
97	}
98
99	/**
100	* Loads user defined strings translations
101	*
102	* @since 1.2
103	* @since 2.1.3 $locale parameter added.
104	*
105	* @param string $locale Locale. Defaults to current locale.
106	*/
107	public function load_strings_translations( $locale = '' ) {
108	if ( empty( $locale ) ) {
109	$locale = get_locale();
110	}
111
112	$language = $this->model->get_language( $locale );
113
114	if ( ! empty( $language ) ) {
115	$mo = new PLL_MO();
116	$mo->import_from_db( $language );
117	$GLOBALS['l10n']['pll_string'] = &$mo;
118	} else {
119	unset( $GLOBALS['l10n']['pll_string'] );
120	}
121	}
122
123	/**
124	* Resets some variables when switching blog
125	* Applies only if Polylang is active on the new blog
126	*
127	* @since 1.5.1
128	*
129	* @param int $new_blog
130	* @param int $old_blog
131	* @return bool not used by WP but by child class
132	*/
133	public function switch_blog( $new_blog, $old_blog ) {
134	$plugins = ( $sitewide_plugins = get_site_option( 'active_sitewide_plugins' ) ) && is_array( $sitewide_plugins ) ? array_keys( $sitewide_plugins ) : array();
135	$plugins = array_merge( $plugins, get_option( 'active_plugins', array() ) );
136
137	// 2nd test needed when Polylang is not networked activated
138	// 3rd test needed when Polylang is networked activated and a new site is created
139	if ( $new_blog != $old_blog && in_array( POLYLANG_BASENAME, $plugins ) && get_option( 'polylang' ) ) {
140	$this->options = get_option( 'polylang' ); // Needed for menus
141	remove_action( 'pre_option_rewrite_rules', array( $this->links_model, 'prepare_rewrite_rules' ) );
142	$this->links_model = $this->model->get_links_model();
143	return true;
144	}
145	return false;
146	}
147
148	/**
149	* Some backward compatibility with Polylang < 1.2
150	* Allows for example to call $polylang->get_languages_list() instead of $polylang->model->get_languages_list()
151	* This works but should be slower than the direct call, thus an error is triggered in debug mode
152	*
153	* @since 1.2
154	*
155	* @param string $func function name
156	* @param array $args function arguments
157	*/
158	public function __call( $func, $args ) {
159	foreach ( $this as $prop => &$obj ) {
160	if ( is_object( $obj ) && method_exists( $obj, $func ) ) {
161	if ( WP_DEBUG ) {
162	$debug = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions
163	$i = 1 + empty( $debug[1]['line'] ); // The file and line are in $debug[2] if the function was called using call_user_func
164	trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions
165	sprintf(
166	'%1$s was called incorrectly in %3$s on line %4$s: the call to $polylang->%1$s() has been deprecated in Polylang 1.2, use PLL()->%2$s->%1$s() instead.' . "\nError handler",
167	esc_html( $func ),
168	esc_html( $prop ),
169	esc_html( $debug[ $i ]['file'] ),
170	absint( $debug[ $i ]['line'] )
171	)
172	);
173	}
174	return call_user_func_array( array( $obj, $func ), $args );
175	}
176	}
177
178	$debug = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions
179	trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions
180	sprintf(
181	'Call to undefined function PLL()->%1$s() in %2$s on line %3$s' . "\nError handler",
182	esc_html( $func ),
183	esc_html( $debug[0]['file'] ),
184	absint( $debug[0]['line'] )
185	),
186	E_USER_ERROR
187	);
188	}
189	}
190