| @@ -3,22 +3,65 @@ | ||
| 3 | 3 | * @package Polylang |
| 4 | 4 | */ |
| 5 | 5 | |
| 6 | 6 | /** |
| 7 | - * Base class for both admin | |
| 7 | + * Setup features available on all admin pages. | |
| 8 | 8 | * |
| 9 | 9 | * @since 1.8 |
| 10 | 10 | */ |
| 11 | -class PLL_Admin_Base extends PLL_Base { | |
| 12 | - public $filter_lang, $curlang, $pref_lang; | |
| 11 | +abstract class PLL_Admin_Base extends PLL_Base { | |
| 12 | + /** | |
| 13 | + * Current language (used to filter the content). | |
| 14 | + * | |
| 15 | + * @var PLL_Language|null | |
| 16 | + */ | |
| 17 | + public $curlang; | |
| 13 | 18 | |
| 14 | 19 | /** |
| 15 | - * Loads the polylang text domain | |
| 16 | - * Setups actions needed on all admin pages | |
| 20 | + * Language selected in the admin language filter. | |
| 17 | 21 | * |
| 22 | + * @var PLL_Language|null | |
| 23 | + */ | |
| 24 | + public $filter_lang; | |
| 25 | + | |
| 26 | + /** | |
| 27 | + * Preferred language to assign to new contents. | |
| 28 | + * | |
| 29 | + * @var PLL_Language|null | |
| 30 | + */ | |
| 31 | + public $pref_lang; | |
| 32 | + | |
| 33 | + /** | |
| 34 | + * @var PLL_Filters_Links|null | |
| 35 | + */ | |
| 36 | + public $filters_links; | |
| 37 | + | |
| 38 | + /** | |
| 39 | + * @var PLL_Admin_Links|null | |
| 40 | + */ | |
| 41 | + public $links; | |
| 42 | + | |
| 43 | + /** | |
| 44 | + * @var PLL_Admin_Notices|null | |
| 45 | + */ | |
| 46 | + public $notices; | |
| 47 | + | |
| 48 | + /** | |
| 49 | + * @var PLL_Admin_Static_Pages|null | |
| 50 | + */ | |
| 51 | + public $static_pages; | |
| 52 | + | |
| 53 | + /** | |
| 54 | + * @var PLL_Admin_Default_Term|null | |
| 55 | + */ | |
| 56 | + public $default_term; | |
| 57 | + | |
| 58 | + /** | |
| 59 | + * Setups actions needed on all admin pages. | |
| 60 | + * | |
| 18 | 61 | * @since 1.8 |
| 19 | 62 | * |
| 20 | - * @param object $links_model | |
| 63 | + * @param PLL_Links_Model $links_model Reference to the links model. | |
| 21 | 64 | */ |
| 22 | 65 | public function __construct( &$links_model ) { |
| 23 | 66 | parent::__construct( $links_model ); |
| 24 | 67 | |
| @@ -24,13 +67,18 @@ | ||
| 24 | 67 | |
| 25 | 68 | // Adds the link to the languages panel in the WordPress admin menu |
| 26 | 69 | add_action( 'admin_menu', array( $this, 'add_menus' ) ); |
| 27 | 70 | |
| 71 | + add_action( 'admin_menu', array( $this, 'remove_customize_submenu' ) ); | |
| 72 | + | |
| 28 | 73 | // Setup js scripts and css styles |
| 29 | - add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) ); | |
| 30 | - add_action( 'admin_print_footer_scripts', array( $this, 'admin_print_footer_scripts' ), 0 ); // High priority in case an ajax request is sent by an immediately invoked function | |
| 74 | + add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ), 0 ); // High priority in case an ajax request is sent by an immediately invoked function | |
| 31 | 75 | |
| 32 | 76 | add_action( 'customize_controls_enqueue_scripts', array( $this, 'customize_controls_enqueue_scripts' ) ); |
| 77 | + | |
| 78 | + // Early instantiated to be able to correctly initialize language properties. | |
| 79 | + $this->static_pages = new PLL_Admin_Static_Pages( $this ); | |
| 80 | + $this->model->set_languages_ready(); | |
| 33 | 81 | } |
| 34 | 82 | |
| 35 | 83 | /** |
| 36 | 84 | * Setups filters and action needed on all admin pages and on plugins page |
| @@ -42,14 +90,16 @@ | ||
| 42 | 90 | parent::init(); |
| 43 | 91 | |
| 44 | 92 | $this->notices = new PLL_Admin_Notices( $this ); |
| 45 | 93 | |
| 46 | - if ( ! $this->model->get_languages_list() ) { | |
| 94 | + $this->default_term = new PLL_Admin_Default_Term( $this ); | |
| 95 | + $this->default_term->add_hooks(); | |
| 96 | + | |
| 97 | + if ( ! $this->model->has_languages() ) { | |
| 47 | 98 | return; |
| 48 | 99 | } |
| 49 | 100 | |
| 50 | 101 | $this->links = new PLL_Admin_Links( $this ); // FIXME needed here ? |
| 51 | - $this->static_pages = new PLL_Admin_Static_Pages( $this ); // FIXME needed here ? | |
| 52 | 102 | $this->filters_links = new PLL_Filters_Links( $this ); // FIXME needed here ? |
| 53 | 103 | |
| 54 | 104 | // Filter admin language for users |
| 55 | 105 | // We must not call user info before WordPress defines user roles in wp-settings.php |
| @@ -63,8 +113,10 @@ | ||
| 63 | 113 | /** |
| 64 | 114 | * Adds the link to the languages panel in the WordPress admin menu |
| 65 | 115 | * |
| 66 | 116 | * @since 0.1 |
| 117 | + * | |
| 118 | + * @return void | |
| 67 | 119 | */ |
| 68 | 120 | public function add_menus() { |
| 69 | 121 | global $admin_page_hooks; |
| 70 | 122 | |
| @@ -71,10 +123,10 @@ | ||
| 71 | 123 | // Prepare the list of tabs |
| 72 | 124 | $tabs = array( 'lang' => __( 'Languages', 'polylang' ) ); |
| 73 | 125 | |
| 74 | 126 | // Only if at least one language has been created |
| 75 | - if ( $this->model->get_languages_list() ) { | |
| 76 | - $tabs['strings'] = __( 'Strings translations', 'polylang' ); | |
| 127 | + if ( $this->model->has_languages() ) { | |
| 128 | + $tabs['strings'] = __( 'Translations', 'polylang' ); | |
| 77 | 129 | } |
| 78 | 130 | |
| 79 | 131 | $tabs['settings'] = __( 'Settings', 'polylang' ); |
| 80 | 132 | |
| @@ -92,9 +144,9 @@ | ||
| 92 | 144 | foreach ( $tabs as $tab => $title ) { |
| 93 | 145 | $page = 'lang' === $tab ? 'mlang' : "mlang_$tab"; |
| 94 | 146 | if ( empty( $parent ) ) { |
| 95 | 147 | $parent = $page; |
| 96 | - add_menu_page( $title, __( 'Languages', 'polylang' ), 'manage_options', $page, null, 'dashicons-translation' ); | |
| 148 | + add_menu_page( $title, __( 'Languages', 'polylang' ), 'manage_options', $page, '__return_null', 'dashicons-translation' ); | |
| 97 | 149 | $admin_page_hooks[ $page ] = 'languages'; // Hack to avoid the localization of the hook name. See: https://core.trac.wordpress.org/ticket/18857 |
| 98 | 150 | } |
| 99 | 151 | |
| 100 | 152 | add_submenu_page( $parent, $title, $title, 'manage_options', $page, array( $this, 'languages_page' ) ); |
| @@ -101,80 +153,134 @@ | ||
| 101 | 153 | } |
| 102 | 154 | } |
| 103 | 155 | |
| 104 | 156 | /** |
| 157 | + * Dummy method to display the 3 tabs pages: languages, strings translations, settings. | |
| 158 | + * Overwritten in `PLL_Settings`. | |
| 159 | + * | |
| 160 | + * @since 3.7 | |
| 161 | + * | |
| 162 | + * @return void | |
| 163 | + */ | |
| 164 | + public function languages_page() {} | |
| 165 | + | |
| 166 | + /** | |
| 105 | 167 | * Setup js scripts & css styles ( only on the relevant pages ) |
| 106 | 168 | * |
| 107 | 169 | * @since 0.6 |
| 170 | + * | |
| 171 | + * @return void | |
| 108 | 172 | */ |
| 109 | 173 | public function admin_enqueue_scripts() { |
| 174 | + $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; | |
| 175 | + | |
| 176 | + wp_enqueue_script( 'pll_admin', plugins_url( "/js/build/admin{$suffix}.js", POLYLANG_ROOT_FILE ), array( 'jquery' ), POLYLANG_VERSION, true ); | |
| 177 | + $inline_script = sprintf( 'let pll_admin = %s;', wp_json_encode( array( 'ajax_filter' => $this->get_ajax_filter_data() ) ) ); | |
| 178 | + wp_add_inline_script( 'pll_admin', $inline_script, 'before' ); | |
| 179 | + | |
| 110 | 180 | $screen = get_current_screen(); |
| 111 | 181 | if ( empty( $screen ) ) { |
| 112 | 182 | return; |
| 113 | 183 | } |
| 114 | 184 | |
| 115 | - $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; | |
| 116 | - | |
| 117 | 185 | /* |
| 118 | 186 | * For each script: |
| 119 | 187 | * 0 => the pages on which to load the script |
| 120 | 188 | * 1 => the scripts it needs to work |
| 121 | - * 2 => 1 if loaded even if languages have not been defined yet, 0 otherwise | |
| 122 | - * 3 => 1 if loaded in footer | |
| 189 | + * 2 => true if loaded even if languages have not been defined yet, false otherwise | |
| 190 | + * 3 => true if loaded in footer | |
| 123 | 191 | */ |
| 124 | 192 | $scripts = array( |
| 125 | - 'user' => array( array( 'profile', 'user-edit' ), array( 'jquery' ), 0, 0 ), | |
| 126 | - 'widgets' => array( array( 'widgets' ), array( 'jquery' ), 0, 0 ), | |
| 193 | + 'user' => array( array( 'profile', 'user-edit' ), array( 'jquery' ), false, false ), | |
| 194 | + 'widgets' => array( array( 'widgets' ), array( 'jquery' ), false, false ), | |
| 127 | 195 | ); |
| 128 | 196 | |
| 197 | + $block_screens = array( 'widgets', 'site-editor' ); | |
| 198 | + | |
| 129 | 199 | if ( ! empty( $screen->post_type ) && $this->model->is_translated_post_type( $screen->post_type ) ) { |
| 130 | - $scripts['post'] = array( array( 'edit', 'upload' ), array( 'jquery', 'wp-ajax-response' ), 0, 1 ); | |
| 200 | + $scripts['post'] = array( array( 'edit' ), array( 'jquery', 'wp-ajax-response' ), false, true ); | |
| 131 | 201 | |
| 132 | 202 | // Classic editor. |
| 133 | 203 | if ( ! method_exists( $screen, 'is_block_editor' ) || ! $screen->is_block_editor() ) { |
| 134 | - $scripts['classic-editor'] = array( array( 'post', 'media', 'async-upload' ), array( 'jquery', 'wp-ajax-response', 'post' ), 0, 1 ); | |
| 204 | + $scripts['classic-editor'] = array( array( 'post', 'media', 'async-upload' ), array( 'jquery', 'wp-ajax-response', 'post', 'jquery-ui-dialog', 'wp-i18n' ), false, true ); | |
| 135 | 205 | } |
| 136 | 206 | |
| 137 | 207 | // Block editor with legacy metabox in WP 5.0+. |
| 138 | - if ( method_exists( $screen, 'is_block_editor' ) && $screen->is_block_editor() && ! pll_use_block_editor_plugin() ) { | |
| 139 | - $scripts['block-editor'] = array( array( 'post' ), array( 'jquery', 'wp-ajax-response', 'wp-api-fetch' ), 0, 1 ); | |
| 140 | - } | |
| 208 | + $block_screens[] = 'post'; | |
| 141 | 209 | } |
| 142 | 210 | |
| 211 | + if ( $this->options['media_support'] ) { | |
| 212 | + $scripts['media'] = array( array( 'upload' ), array( 'jquery' ), false, true ); | |
| 213 | + } | |
| 214 | + | |
| 215 | + if ( $this->is_block_editor( $screen ) ) { | |
| 216 | + $scripts['block-editor'] = array( $block_screens, array( 'jquery', 'wp-ajax-response', 'wp-api-fetch', 'jquery-ui-dialog', 'wp-i18n' ), false, true ); | |
| 217 | + } | |
| 218 | + | |
| 143 | 219 | if ( ! empty( $screen->taxonomy ) && $this->model->is_translated_taxonomy( $screen->taxonomy ) ) { |
| 144 | - $scripts['term'] = array( array( 'edit-tags', 'term' ), array( 'jquery', 'wp-ajax-response', 'jquery-ui-autocomplete' ), 0, 1 ); | |
| 220 | + $scripts['term'] = array( array( 'edit-tags', 'term' ), array( 'jquery', 'wp-ajax-response', 'jquery-ui-autocomplete' ), false, true ); | |
| 145 | 221 | } |
| 146 | 222 | |
| 147 | 223 | foreach ( $scripts as $script => $v ) { |
| 148 | - if ( in_array( $screen->base, $v[0] ) && ( $v[2] || $this->model->get_languages_list() ) ) { | |
| 149 | - wp_enqueue_script( 'pll_' . $script, plugins_url( '/js/' . $script . $suffix . '.js', POLYLANG_FILE ), $v[1], POLYLANG_VERSION, $v[3] ); | |
| 224 | + if ( in_array( $screen->base, $v[0] ) && ( $v[2] || $this->model->has_languages() ) ) { | |
| 225 | + wp_enqueue_script( "pll_{$script}", plugins_url( "/js/build/{$script}{$suffix}.js", POLYLANG_ROOT_FILE ), $v[1], POLYLANG_VERSION, $v[3] ); | |
| 226 | + if ( 'classic-editor' === $script || 'block-editor' === $script ) { | |
| 227 | + wp_set_script_translations( "pll_{$script}", 'polylang' ); | |
| 228 | + } | |
| 150 | 229 | } |
| 151 | 230 | } |
| 152 | 231 | |
| 153 | - wp_enqueue_style( 'polylang_admin', plugins_url( '/css/admin' . $suffix . '.css', POLYLANG_FILE ), array(), POLYLANG_VERSION ); | |
| 232 | + wp_register_style( 'polylang_admin', plugins_url( "/css/build/admin{$suffix}.css", POLYLANG_ROOT_FILE ), array( 'wp-jquery-ui-dialog' ), POLYLANG_VERSION ); | |
| 233 | + wp_enqueue_style( 'polylang_dialog', plugins_url( "/css/build/dialog{$suffix}.css", POLYLANG_ROOT_FILE ), array( 'polylang_admin' ), POLYLANG_VERSION ); | |
| 154 | 234 | |
| 155 | - $this->localize_scripts(); | |
| 235 | + $this->add_inline_scripts(); | |
| 156 | 236 | } |
| 157 | 237 | |
| 158 | 238 | /** |
| 239 | + * Tells whether or not the given screen is block editor kind. | |
| 240 | + * e.g. widget, site or post editor. | |
| 241 | + * | |
| 242 | + * @since 3.3 | |
| 243 | + * | |
| 244 | + * @param WP_Screen $screen Screen object. | |
| 245 | + * @return bool True if the screen is a block editor, false otherwise. | |
| 246 | + */ | |
| 247 | + protected function is_block_editor( $screen ) { | |
| 248 | + return method_exists( $screen, 'is_block_editor' ) && $screen->is_block_editor() && ! pll_use_block_editor_plugin(); | |
| 249 | + } | |
| 250 | + | |
| 251 | + /** | |
| 159 | 252 | * Enqueue scripts to the WP Customizer. |
| 160 | 253 | * |
| 161 | 254 | * @since 2.4.0 |
| 255 | + * | |
| 256 | + * @return void | |
| 162 | 257 | */ |
| 163 | 258 | public function customize_controls_enqueue_scripts() { |
| 164 | - if ( $this->model->get_languages_list() ) { | |
| 259 | + if ( $this->model->has_languages() ) { | |
| 165 | 260 | $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; |
| 166 | - wp_enqueue_script( 'pll_widgets', plugins_url( '/js/widgets' . $suffix . '.js', POLYLANG_FILE ), array( 'jquery' ), POLYLANG_VERSION, true ); | |
| 167 | - $this->localize_scripts(); | |
| 261 | + wp_enqueue_script( 'pll_widgets', plugins_url( '/js/build/widgets' . $suffix . '.js', POLYLANG_ROOT_FILE ), array( 'jquery' ), POLYLANG_VERSION, true ); | |
| 262 | + $this->add_inline_scripts(); | |
| 168 | 263 | } |
| 169 | 264 | } |
| 170 | 265 | |
| 171 | 266 | /** |
| 172 | - * Localize scripts. | |
| 267 | + * Adds inline scripts to set the default language in JS | |
| 268 | + * and localizes scripts. | |
| 173 | 269 | * |
| 174 | - * @since 2.4.0 | |
| 270 | + * @since 3.3 | |
| 271 | + * | |
| 272 | + * @return void | |
| 175 | 273 | */ |
| 176 | - public function localize_scripts() { | |
| 274 | + private function add_inline_scripts() { | |
| 275 | + if ( wp_script_is( 'pll_block-editor', 'enqueued' ) ) { | |
| 276 | + $default_lang_script = 'const pllDefaultLanguage = "' . $this->options['default_lang'] . '";'; | |
| 277 | + wp_add_inline_script( | |
| 278 | + 'pll_block-editor', | |
| 279 | + $default_lang_script, | |
| 280 | + 'before' | |
| 281 | + ); | |
| 282 | + } | |
| 177 | 283 | if ( wp_script_is( 'pll_widgets', 'enqueued' ) ) { |
| 178 | 284 | wp_localize_script( |
| 179 | 285 | 'pll_widgets', |
| 180 | 286 | 'pll_widgets', |
| @@ -185,69 +291,43 @@ | ||
| 185 | 291 | } |
| 186 | 292 | } |
| 187 | 293 | |
| 188 | 294 | /** |
| 189 | - * Sets pll_ajax_backend on all backend ajax request | |
| 190 | - * The final goal is to detect if an ajax request is made on admin or frontend | |
| 295 | + * Returns the data to use with the AJAX filter. | |
| 296 | + * The final goal is to detect if an ajax request is made on admin or frontend. | |
| 191 | 297 | * |
| 192 | 298 | * Takes care to various situations: |
| 193 | - * when the ajax request has no options.data thanks to ScreenfeedFr | |
| 194 | - * see: https://wordpress.org/support/topic/ajaxprefilter-may-not-work-as-expected | |
| 195 | - * when options.data is a json string | |
| 196 | - * see: https://wordpress.org/support/topic/polylang-breaking-third-party-ajax-requests-on-admin-panels | |
| 197 | - * when options.data is an empty string (GET request with the method 'load') | |
| 198 | - * see: https://wordpress.org/support/topic/invalid-url-during-wordpress-new-dashboard-widget-operation | |
| 299 | + * - When the AJAX request has no `options.data` thanks to ScreenfeedFr. | |
| 300 | + * See: https://wordpress.org/support/topic/ajaxprefilter-may-not-work-as-expected. | |
| 301 | + * - When `options.data` is a JSON string. | |
| 302 | + * See: https://wordpress.org/support/topic/polylang-breaking-third-party-ajax-requests-on-admin-panels. | |
| 303 | + * - When `options.data` is an empty string (GET request with the method 'load'). | |
| 304 | + * See: https://wordpress.org/support/topic/invalid-url-during-wordpress-new-dashboard-widget-operation. | |
| 199 | 305 | * |
| 200 | - * @since 1.4 | |
| 306 | + * @since 3.7 | |
| 307 | + * | |
| 308 | + * @return array | |
| 201 | 309 | */ |
| 202 | - public function admin_print_footer_scripts() { | |
| 203 | - global $post_ID, $tag_ID; | |
| 310 | + public function get_ajax_filter_data(): array { | |
| 311 | + global $post, $tag; | |
| 204 | 312 | |
| 205 | 313 | $params = array( 'pll_ajax_backend' => 1 ); |
| 206 | - if ( ! empty( $post_ID ) ) { | |
| 207 | - $params = array_merge( $params, array( 'pll_post_id' => (int) $post_ID ) ); | |
| 314 | + if ( $post instanceof WP_Post && $this->model->post_types->is_translated( $post->post_type ) ) { | |
| 315 | + $params['pll_post_id'] = $post->ID; | |
| 208 | 316 | } |
| 209 | 317 | |
| 210 | - if ( ! empty( $tag_ID ) ) { | |
| 211 | - $params = array_merge( $params, array( 'pll_term_id' => (int) $tag_ID ) ); | |
| 318 | + if ( $tag instanceof WP_Term && $this->model->taxonomies->is_translated( $tag->taxonomy ) ) { | |
| 319 | + $params['pll_term_id'] = $tag->term_id; | |
| 212 | 320 | } |
| 213 | 321 | |
| 214 | - $str = http_build_query( $params ); | |
| 215 | - $arr = wp_json_encode( $params ); | |
| 216 | - ?> | |
| 217 | - <script type="text/javascript"> | |
| 218 | - if (typeof jQuery != 'undefined') { | |
| 219 | - jQuery( | |
| 220 | - function($){ | |
| 221 | - $.ajaxPrefilter(function (options, originalOptions, jqXHR) { | |
| 222 | - if ( -1 != options.url.indexOf( ajaxurl ) || -1 != ajaxurl.indexOf( options.url ) ) { | |
| 223 | - if ( 'undefined' === typeof options.data ) { | |
| 224 | - options.data = ( 'get' === options.type.toLowerCase() ) ? '<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>' : <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?>; | |
| 225 | - } else { | |
| 226 | - if ( 'string' === typeof options.data ) { | |
| 227 | - if ( '' === options.data && 'get' === options.type.toLowerCase() ) { | |
| 228 | - options.url = options.url+'&<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>'; | |
| 229 | - } else { | |
| 230 | - try { | |
| 231 | - var o = JSON.parse(options.data); | |
| 232 | - o = $.extend(o, <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?>); | |
| 233 | - options.data = JSON.stringify(o); | |
| 234 | - } | |
| 235 | - catch(e) { | |
| 236 | - options.data = '<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>&'+options.data; | |
| 237 | - } | |
| 238 | - } | |
| 239 | - } else { | |
| 240 | - options.data = $.extend(options.data, <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?>); | |
| 241 | - } | |
| 242 | - } | |
| 243 | - } | |
| 244 | - }); | |
| 245 | - } | |
| 246 | - ); | |
| 247 | - } | |
| 248 | - </script> | |
| 249 | - <?php | |
| 322 | + /** | |
| 323 | + * Filters the list of parameters to add to the admin ajax request. | |
| 324 | + * | |
| 325 | + * @since 3.4.5 | |
| 326 | + * | |
| 327 | + * @param array $params List of parameters to add to the admin ajax request. | |
| 328 | + */ | |
| 329 | + return (array) apply_filters( 'pll_admin_ajax_params', $params ); | |
| 250 | 330 | } |
| 251 | 331 | |
| 252 | 332 | /** |
| 253 | 333 | * Sets the admin current language, used to filter the content |
| @@ -252,8 +332,10 @@ | ||
| 252 | 332 | /** |
| 253 | 333 | * Sets the admin current language, used to filter the content |
| 254 | 334 | * |
| 255 | 335 | * @since 2.0 |
| 336 | + * | |
| 337 | + * @return void | |
| 256 | 338 | */ |
| 257 | 339 | public function set_current_language() { |
| 258 | 340 | $this->curlang = $this->filter_lang; |
| 259 | 341 | |
| @@ -283,10 +365,20 @@ | ||
| 283 | 365 | if ( wp_doing_ajax() && ! empty( $_REQUEST['lang'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification |
| 284 | 366 | $this->curlang = $this->model->get_language( sanitize_key( $_REQUEST['lang'] ) ); // phpcs:ignore WordPress.Security.NonceVerification |
| 285 | 367 | } |
| 286 | 368 | |
| 369 | + /** | |
| 370 | + * Filters the current language used by Polylang in the admin context. | |
| 371 | + * | |
| 372 | + * @since 3.2 | |
| 373 | + * | |
| 374 | + * @param PLL_Language|false|null $curlang Instance of the current language. | |
| 375 | + * @param PLL_Admin_Base $polylang Instance of the main Polylang's object. | |
| 376 | + */ | |
| 377 | + $this->curlang = apply_filters( 'pll_admin_current_language', $this->curlang, $this ); | |
| 378 | + | |
| 287 | 379 | // Inform that the admin language has been set. |
| 288 | - if ( $this->curlang ) { | |
| 380 | + if ( $this->curlang instanceof PLL_Language ) { | |
| 289 | 381 | /** This action is documented in frontend/choose-lang.php */ |
| 290 | 382 | do_action( 'pll_language_defined', $this->curlang->slug, $this->curlang ); |
| 291 | 383 | } else { |
| 292 | 384 | /** This action is documented in include/class-polylang.php */ |
| @@ -297,8 +389,10 @@ | ||
| 297 | 389 | /** |
| 298 | 390 | * Defines the backend language and the admin language filter based on user preferences |
| 299 | 391 | * |
| 300 | 392 | * @since 1.2.3 |
| 393 | + * | |
| 394 | + * @return void | |
| 301 | 395 | */ |
| 302 | 396 | public function init_user() { |
| 303 | 397 | // Language for admin language filter: may be empty |
| 304 | 398 | // $_GET['lang'] is numeric when editing a language, not when selecting a new language in the filter |
| @@ -309,24 +403,21 @@ | ||
| 309 | 403 | |
| 310 | 404 | $this->filter_lang = $this->model->get_language( get_user_meta( get_current_user_id(), 'pll_filter_content', true ) ); |
| 311 | 405 | |
| 312 | 406 | // Set preferred language for use when saving posts and terms: must not be empty |
| 313 | - $this->pref_lang = empty( $this->filter_lang ) ? $this->model->get_language( $this->options['default_lang'] ) : $this->filter_lang; | |
| 407 | + $this->pref_lang = empty( $this->filter_lang ) ? $this->model->get_default_language() : $this->filter_lang; | |
| 314 | 408 | |
| 315 | 409 | /** |
| 316 | - * Filter the preferred language on admin side | |
| 317 | - * The preferred language is used for example to determine the language of a new post | |
| 410 | + * Filters the preferred language on admin side. | |
| 411 | + * The preferred language is used for example to determine the language of a new post. | |
| 318 | 412 | * |
| 319 | 413 | * @since 1.2.3 |
| 320 | 414 | * |
| 321 | - * @param object $pref_lang preferred language | |
| 415 | + * @param PLL_Language $pref_lang Preferred language. | |
| 322 | 416 | */ |
| 323 | 417 | $this->pref_lang = apply_filters( 'pll_admin_preferred_language', $this->pref_lang ); |
| 324 | 418 | |
| 325 | 419 | $this->set_current_language(); |
| 326 | - | |
| 327 | - // Plugin i18n, only needed for backend. | |
| 328 | - load_plugin_textdomain( 'polylang' ); | |
| 329 | 420 | } |
| 330 | 421 | |
| 331 | 422 | /** |
| 332 | 423 | * Avoids parsing a tax query when all languages are requested |
| @@ -335,9 +426,9 @@ | ||
| 335 | 426 | * @see https://core.trac.wordpress.org/ticket/31246 the suggestion of @boonebgorges. |
| 336 | 427 | * |
| 337 | 428 | * @since 1.6.5 |
| 338 | 429 | * |
| 339 | - * @param array $qvars | |
| 430 | + * @param array $qvars The array of requested query variables. | |
| 340 | 431 | * @return array |
| 341 | 432 | */ |
| 342 | 433 | public function request( $qvars ) { |
| 343 | 434 | if ( isset( $qvars['lang'] ) && 'all' === $qvars['lang'] ) { |
| @@ -347,13 +438,14 @@ | ||
| 347 | 438 | return $qvars; |
| 348 | 439 | } |
| 349 | 440 | |
| 350 | 441 | /** |
| 351 | - * Adds the languages list in admin bar for the admin languages filter | |
| 442 | + * Adds the languages list in admin bar for the admin languages filter. | |
| 352 | 443 | * |
| 353 | 444 | * @since 0.9 |
| 354 | 445 | * |
| 355 | - * @param object $wp_admin_bar | |
| 446 | + * @param WP_Admin_Bar $wp_admin_bar WP_Admin_Bar global object. | |
| 447 | + * @return void | |
| 356 | 448 | */ |
| 357 | 449 | public function admin_bar_menu( $wp_admin_bar ) { |
| 358 | 450 | $all_item = (object) array( |
| 359 | 451 | 'slug' => 'all', |
| @@ -364,9 +456,9 @@ | ||
| 364 | 456 | $selected = empty( $this->filter_lang ) ? $all_item : $this->filter_lang; |
| 365 | 457 | |
| 366 | 458 | $title = sprintf( |
| 367 | 459 | '<span class="ab-label"%1$s><span class="screen-reader-text">%2$s</span>%3$s</span>', |
| 368 | - 'all' === $selected->slug ? '' : sprintf( ' lang="%s"', esc_attr( $selected->get_locale( 'display' ) ) ), | |
| 460 | + $selected instanceof PLL_Language ? sprintf( ' lang="%s"', esc_attr( $selected->get_locale( 'display' ) ) ) : '', | |
| 369 | 461 | __( 'Filters content by language', 'polylang' ), |
| 370 | 462 | esc_html( $selected->name ) |
| 371 | 463 | ); |
| 372 | 464 | |
| @@ -378,17 +470,23 @@ | ||
| 378 | 470 | * @param array $items The admin languages filter submenu items. |
| 379 | 471 | */ |
| 380 | 472 | $items = apply_filters( 'pll_admin_languages_filter', array_merge( array( $all_item ), $this->model->get_languages_list() ) ); |
| 381 | 473 | |
| 474 | + $menu = array( | |
| 475 | + 'id' => 'languages', | |
| 476 | + 'title' => $selected->flag . $title, | |
| 477 | + 'href' => esc_url( add_query_arg( 'lang', $selected->slug, remove_query_arg( 'paged' ) ) ), | |
| 478 | + 'meta' => array( | |
| 479 | + 'title' => __( 'Filters content by language', 'polylang' ), | |
| 480 | + ), | |
| 481 | + ); | |
| 482 | + | |
| 483 | + if ( 'all' !== $selected->slug ) { | |
| 484 | + $menu['meta']['class'] = 'pll-filtered-languages'; | |
| 485 | + } | |
| 486 | + | |
| 382 | 487 | if ( ! empty( $items ) ) { |
| 383 | - $wp_admin_bar->add_menu( | |
| 384 | - array( | |
| 385 | - 'id' => 'languages', | |
| 386 | - 'title' => $selected->flag . $title, | |
| 387 | - 'href' => esc_url( add_query_arg( 'lang', $selected->slug, remove_query_arg( 'paged' ) ) ), | |
| 388 | - 'meta' => array( 'title' => __( 'Filters content by language', 'polylang' ) ), | |
| 389 | - ) | |
| 390 | - ); | |
| 488 | + $wp_admin_bar->add_menu( $menu ); | |
| 391 | 489 | } |
| 392 | 490 | |
| 393 | 491 | foreach ( $items as $lang ) { |
| 394 | 492 | if ( $selected->slug === $lang->slug ) { |
| @@ -403,7 +501,34 @@ | ||
| 403 | 501 | 'href' => esc_url( add_query_arg( 'lang', $lang->slug, remove_query_arg( 'paged' ) ) ), |
| 404 | 502 | 'meta' => 'all' === $lang->slug ? array() : array( 'lang' => esc_attr( $lang->get_locale( 'display' ) ) ), |
| 405 | 503 | ) |
| 406 | 504 | ); |
| 505 | + } | |
| 506 | + } | |
| 507 | + | |
| 508 | + /** | |
| 509 | + * Remove the customize submenu when using a block theme. | |
| 510 | + * | |
| 511 | + * WordPress removes the Customizer menu if a block theme is activated and no other plugins interact with it. | |
| 512 | + * As Polylang interacts with the Customizer, we have to delete this menu ourselves in the case of a block theme, | |
| 513 | + * unless another plugin than Polylang interacts with the Customizer. | |
| 514 | + * | |
| 515 | + * @since 3.2 | |
| 516 | + * | |
| 517 | + * @return void | |
| 518 | + */ | |
| 519 | + public function remove_customize_submenu() { | |
| 520 | + if ( ! $this->should_customize_menu_be_removed() ) { | |
| 521 | + return; | |
| 522 | + } | |
| 523 | + | |
| 524 | + global $submenu; | |
| 525 | + | |
| 526 | + if ( ! empty( $submenu['themes.php'] ) ) { | |
| 527 | + foreach ( $submenu['themes.php'] as $submenu_item ) { | |
| 528 | + if ( 'customize' === $submenu_item[1] ) { | |
| 529 | + remove_submenu_page( 'themes.php', $submenu_item[2] ); | |
| 530 | + } | |
| 531 | + } | |
| 407 | 532 | } |
| 408 | 533 | } |
| 409 | 534 | } |
