| @@ -1,31 +1,76 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * @package Polylang | |
| 4 | + */ | |
| 2 | 5 | |
| 3 | 6 | /** |
| 4 | - * Base class for both admin | |
| 7 | + * Setup features available on all admin pages. | |
| 5 | 8 | * |
| 6 | 9 | * @since 1.8 |
| 7 | 10 | */ |
| 8 | -class PLL_Admin_Base extends PLL_Base { | |
| 9 | - 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; | |
| 10 | 18 | |
| 11 | 19 | /** |
| 12 | - * Loads the polylang text domain | |
| 13 | - * Setups actions needed on all admin pages | |
| 20 | + * Language selected in the admin language filter. | |
| 14 | 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 | + * | |
| 15 | 61 | * @since 1.8 |
| 16 | 62 | * |
| 17 | - * @param object $links_model | |
| 63 | + * @param PLL_Links_Model $links_model Reference to the links model. | |
| 18 | 64 | */ |
| 19 | 65 | public function __construct( &$links_model ) { |
| 20 | 66 | parent::__construct( $links_model ); |
| 21 | 67 | |
| 22 | - // Plugin i18n, only needed for backend | |
| 23 | - load_plugin_textdomain( 'polylang', false, basename( POLYLANG_DIR ) . '/languages' ); | |
| 24 | - | |
| 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 | 74 | add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) ); |
| 30 | 75 | 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 |
| 31 | 76 | |
| @@ -30,14 +75,11 @@ | ||
| 30 | 75 | 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 |
| 31 | 76 | |
| 32 | 77 | add_action( 'customize_controls_enqueue_scripts', array( $this, 'customize_controls_enqueue_scripts' ) ); |
| 33 | 78 | |
| 34 | - if ( defined( 'POLYLANG_PRO' ) ) { | |
| 35 | - new PLL_Pro(); | |
| 36 | - } elseif ( ! defined( 'PLL_LINGOTEK_AD' ) || PLL_LINGOTEK_AD ) { | |
| 37 | - require_once POLYLANG_DIR . '/lingotek/lingotek.php'; // Lingotek | |
| 38 | - add_action( 'wp_loaded', array( new PLL_Lingotek(), 'init' ) ); | |
| 39 | - } | |
| 79 | + // Early instantiated to be able to correctly initialize language properties. | |
| 80 | + $this->static_pages = new PLL_Admin_Static_Pages( $this ); | |
| 81 | + $this->model->set_languages_ready(); | |
| 40 | 82 | } |
| 41 | 83 | |
| 42 | 84 | /** |
| 43 | 85 | * Setups filters and action needed on all admin pages and on plugins page |
| @@ -49,22 +91,16 @@ | ||
| 49 | 91 | parent::init(); |
| 50 | 92 | |
| 51 | 93 | $this->notices = new PLL_Admin_Notices( $this ); |
| 52 | 94 | |
| 53 | - if ( Polylang::is_wizard() && class_exists( 'PLL_Wizard_Pro' ) ) { | |
| 54 | - // Instantiate PLL_Wizard_Pro class after all PLL_Admin object is all initialized. | |
| 55 | - // After PLL_Admin::maybe_load_sync_post which is hooked on admin_init with priority 20. | |
| 56 | - add_action( 'admin_init', array( $this, 'instantiate_wizard_pro' ), 30 ); | |
| 57 | - } | |
| 95 | + $this->default_term = new PLL_Admin_Default_Term( $this ); | |
| 96 | + $this->default_term->add_hooks(); | |
| 58 | 97 | |
| 59 | - $this->wizard = new PLL_Wizard( $this ); | |
| 60 | - | |
| 61 | - if ( ! $this->model->get_languages_list() ) { | |
| 98 | + if ( ! $this->model->has_languages() ) { | |
| 62 | 99 | return; |
| 63 | 100 | } |
| 64 | 101 | |
| 65 | 102 | $this->links = new PLL_Admin_Links( $this ); // FIXME needed here ? |
| 66 | - $this->static_pages = new PLL_Admin_Static_Pages( $this ); // FIXME needed here ? | |
| 67 | 103 | $this->filters_links = new PLL_Filters_Links( $this ); // FIXME needed here ? |
| 68 | 104 | |
| 69 | 105 | // Filter admin language for users |
| 70 | 106 | // We must not call user info before WordPress defines user roles in wp-settings.php |
| @@ -72,14 +108,8 @@ | ||
| 72 | 108 | add_filter( 'request', array( $this, 'request' ) ); |
| 73 | 109 | |
| 74 | 110 | // Adds the languages in admin bar |
| 75 | 111 | add_action( 'admin_bar_menu', array( $this, 'admin_bar_menu' ), 100 ); // 100 determines the position |
| 76 | - | |
| 77 | - // Translate slugs, only for pretty permalinks | |
| 78 | - if ( get_option( 'permalink_structure' ) && class_exists( 'PLL_Translate_Slugs' ) ) { | |
| 79 | - $slugs_model = new PLL_Translate_Slugs_Model( $this ); | |
| 80 | - $this->translate_slugs = new PLL_Translate_Slugs( $slugs_model, $this->curlang ); | |
| 81 | - } | |
| 82 | 112 | } |
| 83 | 113 | |
| 84 | 114 | /** |
| 85 | 115 | * Adds the link to the languages panel in the WordPress admin menu |
| @@ -84,8 +114,10 @@ | ||
| 84 | 114 | /** |
| 85 | 115 | * Adds the link to the languages panel in the WordPress admin menu |
| 86 | 116 | * |
| 87 | 117 | * @since 0.1 |
| 118 | + * | |
| 119 | + * @return void | |
| 88 | 120 | */ |
| 89 | 121 | public function add_menus() { |
| 90 | 122 | global $admin_page_hooks; |
| 91 | 123 | |
| @@ -92,10 +124,10 @@ | ||
| 92 | 124 | // Prepare the list of tabs |
| 93 | 125 | $tabs = array( 'lang' => __( 'Languages', 'polylang' ) ); |
| 94 | 126 | |
| 95 | 127 | // Only if at least one language has been created |
| 96 | - if ( $this->model->get_languages_list() ) { | |
| 97 | - $tabs['strings'] = __( 'Strings translations', 'polylang' ); | |
| 128 | + if ( $this->model->has_languages() ) { | |
| 129 | + $tabs['strings'] = __( 'Translations', 'polylang' ); | |
| 98 | 130 | } |
| 99 | 131 | |
| 100 | 132 | $tabs['settings'] = __( 'Settings', 'polylang' ); |
| 101 | 133 | |
| @@ -113,9 +145,9 @@ | ||
| 113 | 145 | foreach ( $tabs as $tab => $title ) { |
| 114 | 146 | $page = 'lang' === $tab ? 'mlang' : "mlang_$tab"; |
| 115 | 147 | if ( empty( $parent ) ) { |
| 116 | 148 | $parent = $page; |
| 117 | - add_menu_page( $title, __( 'Languages', 'polylang' ), 'manage_options', $page, null, 'dashicons-translation' ); | |
| 149 | + add_menu_page( $title, __( 'Languages', 'polylang' ), 'manage_options', $page, '__return_null', 'dashicons-translation' ); | |
| 118 | 150 | $admin_page_hooks[ $page ] = 'languages'; // Hack to avoid the localization of the hook name. See: https://core.trac.wordpress.org/ticket/18857 |
| 119 | 151 | } |
| 120 | 152 | |
| 121 | 153 | add_submenu_page( $parent, $title, $title, 'manage_options', $page, array( $this, 'languages_page' ) ); |
| @@ -125,8 +157,10 @@ | ||
| 125 | 157 | /** |
| 126 | 158 | * Setup js scripts & css styles ( only on the relevant pages ) |
| 127 | 159 | * |
| 128 | 160 | * @since 0.6 |
| 161 | + * | |
| 162 | + * @return void | |
| 129 | 163 | */ |
| 130 | 164 | public function admin_enqueue_scripts() { |
| 131 | 165 | $screen = get_current_screen(); |
| 132 | 166 | if ( empty( $screen ) ) { |
| @@ -134,79 +168,102 @@ | ||
| 134 | 168 | } |
| 135 | 169 | |
| 136 | 170 | $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; |
| 137 | 171 | |
| 138 | - // For each script: | |
| 139 | - // 0 => the pages on which to load the script | |
| 140 | - // 1 => the scripts it needs to work | |
| 141 | - // 2 => 1 if loaded even if languages have not been defined yet, 0 otherwise | |
| 142 | - // 3 => 1 if loaded in footer | |
| 143 | - // FIXME: check if I can load more scripts in footer | |
| 172 | + /* | |
| 173 | + * For each script: | |
| 174 | + * 0 => the pages on which to load the script | |
| 175 | + * 1 => the scripts it needs to work | |
| 176 | + * 2 => true if loaded even if languages have not been defined yet, false otherwise | |
| 177 | + * 3 => true if loaded in footer | |
| 178 | + */ | |
| 144 | 179 | $scripts = array( |
| 145 | - 'post' => array( array( 'edit', 'upload' ), array( 'jquery', 'wp-ajax-response' ), 0, 1 ), | |
| 146 | - 'term' => array( array( 'edit-tags', 'term' ), array( 'jquery', 'wp-ajax-response', 'jquery-ui-autocomplete' ), 0, 1 ), | |
| 147 | - 'user' => array( array( 'profile', 'user-edit' ), array( 'jquery' ), 0, 0 ), | |
| 148 | - 'widgets' => array( array( 'widgets' ), array( 'jquery' ), 0, 0 ), | |
| 180 | + 'user' => array( array( 'profile', 'user-edit' ), array( 'jquery' ), false, false ), | |
| 181 | + 'widgets' => array( array( 'widgets' ), array( 'jquery' ), false, false ), | |
| 149 | 182 | ); |
| 150 | 183 | |
| 184 | + $block_screens = array( 'widgets', 'site-editor' ); | |
| 185 | + | |
| 151 | 186 | if ( ! empty( $screen->post_type ) && $this->model->is_translated_post_type( $screen->post_type ) ) { |
| 187 | + $scripts['post'] = array( array( 'edit', 'upload' ), array( 'jquery', 'wp-ajax-response' ), false, true ); | |
| 188 | + | |
| 152 | 189 | // Classic editor. |
| 153 | 190 | if ( ! method_exists( $screen, 'is_block_editor' ) || ! $screen->is_block_editor() ) { |
| 154 | - $scripts['classic-editor'] = array( array( 'post', 'media', 'async-upload' ), array( 'jquery', 'wp-ajax-response', 'post' ), 0, 1 ); | |
| 191 | + $scripts['classic-editor'] = array( array( 'post', 'media', 'async-upload' ), array( 'jquery', 'wp-ajax-response', 'post', 'jquery-ui-dialog', 'wp-i18n' ), false, true ); | |
| 155 | 192 | } |
| 156 | 193 | |
| 157 | 194 | // Block editor with legacy metabox in WP 5.0+. |
| 158 | - if ( method_exists( $screen, 'is_block_editor' ) && $screen->is_block_editor() && ! pll_use_block_editor_plugin() ) { | |
| 159 | - $scripts['block-editor'] = array( array( 'post' ), array( 'jquery', 'wp-ajax-response', 'wp-api-fetch' ), 0, 1 ); | |
| 160 | - } | |
| 195 | + $block_screens[] = 'post'; | |
| 161 | 196 | } |
| 162 | 197 | |
| 198 | + if ( $this->is_block_editor( $screen ) ) { | |
| 199 | + $scripts['block-editor'] = array( $block_screens, array( 'jquery', 'wp-ajax-response', 'wp-api-fetch', 'jquery-ui-dialog', 'wp-i18n' ), false, true ); | |
| 200 | + } | |
| 201 | + | |
| 202 | + if ( ! empty( $screen->taxonomy ) && $this->model->is_translated_taxonomy( $screen->taxonomy ) ) { | |
| 203 | + $scripts['term'] = array( array( 'edit-tags', 'term' ), array( 'jquery', 'wp-ajax-response', 'jquery-ui-autocomplete' ), false, true ); | |
| 204 | + } | |
| 205 | + | |
| 163 | 206 | foreach ( $scripts as $script => $v ) { |
| 164 | - if ( in_array( $screen->base, $v[0] ) && ( $v[2] || $this->model->get_languages_list() ) ) { | |
| 165 | - wp_enqueue_script( 'pll_' . $script, plugins_url( '/js/' . $script . $suffix . '.js', POLYLANG_FILE ), $v[1], POLYLANG_VERSION, $v[3] ); | |
| 207 | + if ( in_array( $screen->base, $v[0] ) && ( $v[2] || $this->model->has_languages() ) ) { | |
| 208 | + wp_enqueue_script( 'pll_' . $script, plugins_url( '/js/build/' . $script . $suffix . '.js', POLYLANG_ROOT_FILE ), $v[1], POLYLANG_VERSION, $v[3] ); | |
| 209 | + if ( 'classic-editor' === $script || 'block-editor' === $script ) { | |
| 210 | + wp_set_script_translations( 'pll_' . $script, 'polylang' ); | |
| 211 | + } | |
| 166 | 212 | } |
| 167 | 213 | } |
| 168 | 214 | |
| 169 | - wp_enqueue_style( 'polylang_admin', plugins_url( '/css/admin' . $suffix . '.css', POLYLANG_FILE ), array(), POLYLANG_VERSION ); | |
| 215 | + wp_register_style( 'polylang_admin', plugins_url( '/css/build/admin' . $suffix . '.css', POLYLANG_ROOT_FILE ), array( 'wp-jquery-ui-dialog' ), POLYLANG_VERSION ); | |
| 216 | + wp_enqueue_style( 'polylang_dialog', plugins_url( '/css/build/dialog' . $suffix . '.css', POLYLANG_ROOT_FILE ), array( 'polylang_admin' ), POLYLANG_VERSION ); | |
| 170 | 217 | |
| 171 | - $this->localize_scripts(); | |
| 218 | + $this->add_inline_scripts(); | |
| 172 | 219 | } |
| 173 | 220 | |
| 174 | 221 | /** |
| 222 | + * Tells whether or not the given screen is block editor kind. | |
| 223 | + * e.g. widget, site or post editor. | |
| 224 | + * | |
| 225 | + * @since 3.3 | |
| 226 | + * | |
| 227 | + * @param WP_Screen $screen Screen object. | |
| 228 | + * @return bool True if the screen is a block editor, false otherwise. | |
| 229 | + */ | |
| 230 | + protected function is_block_editor( $screen ) { | |
| 231 | + return method_exists( $screen, 'is_block_editor' ) && $screen->is_block_editor() && ! pll_use_block_editor_plugin(); | |
| 232 | + } | |
| 233 | + | |
| 234 | + /** | |
| 175 | 235 | * Enqueue scripts to the WP Customizer. |
| 176 | 236 | * |
| 177 | 237 | * @since 2.4.0 |
| 238 | + * | |
| 239 | + * @return void | |
| 178 | 240 | */ |
| 179 | 241 | public function customize_controls_enqueue_scripts() { |
| 180 | - if ( $this->model->get_languages_list() ) { | |
| 242 | + if ( $this->model->has_languages() ) { | |
| 181 | 243 | $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; |
| 182 | - wp_enqueue_script( 'pll_widgets', plugins_url( '/js/widgets' . $suffix . '.js', POLYLANG_FILE ), array( 'jquery' ), POLYLANG_VERSION, true ); | |
| 183 | - $this->localize_scripts(); | |
| 244 | + wp_enqueue_script( 'pll_widgets', plugins_url( '/js/build/widgets' . $suffix . '.js', POLYLANG_ROOT_FILE ), array( 'jquery' ), POLYLANG_VERSION, true ); | |
| 245 | + $this->add_inline_scripts(); | |
| 184 | 246 | } |
| 185 | 247 | } |
| 186 | 248 | |
| 187 | 249 | /** |
| 188 | - * Localize scripts. | |
| 250 | + * Adds inline scripts to set the default language in JS | |
| 251 | + * and localizes scripts. | |
| 189 | 252 | * |
| 190 | - * @since 2.4.0 | |
| 253 | + * @since 3.3 | |
| 254 | + * | |
| 255 | + * @return void | |
| 191 | 256 | */ |
| 192 | - public function localize_scripts() { | |
| 193 | - if ( wp_script_is( 'pll_classic-editor', 'enqueued' ) ) { | |
| 194 | - wp_localize_script( | |
| 195 | - 'pll_classic-editor', | |
| 196 | - 'confirm_text', | |
| 197 | - __( 'You are about to overwrite an existing translation. Are you sure you want to proceed?', 'polylang' ) | |
| 198 | - ); | |
| 199 | - } | |
| 200 | - | |
| 257 | + private function add_inline_scripts() { | |
| 201 | 258 | if ( wp_script_is( 'pll_block-editor', 'enqueued' ) ) { |
| 202 | - wp_localize_script( | |
| 259 | + $default_lang_script = 'const pllDefaultLanguage = "' . $this->options['default_lang'] . '";'; | |
| 260 | + wp_add_inline_script( | |
| 203 | 261 | 'pll_block-editor', |
| 204 | - 'confirm_text', | |
| 205 | - __( 'You are about to overwrite an existing translation. Are you sure you want to proceed?', 'polylang' ) | |
| 262 | + $default_lang_script, | |
| 263 | + 'before' | |
| 206 | 264 | ); |
| 207 | 265 | } |
| 208 | - | |
| 209 | 266 | if ( wp_script_is( 'pll_widgets', 'enqueued' ) ) { |
| 210 | 267 | wp_localize_script( |
| 211 | 268 | 'pll_widgets', |
| 212 | 269 | 'pll_widgets', |
| @@ -229,8 +286,10 @@ | ||
| 229 | 286 | * when options.data is an empty string (GET request with the method 'load') |
| 230 | 287 | * see: https://wordpress.org/support/topic/invalid-url-during-wordpress-new-dashboard-widget-operation |
| 231 | 288 | * |
| 232 | 289 | * @since 1.4 |
| 290 | + * | |
| 291 | + * @return void | |
| 233 | 292 | */ |
| 234 | 293 | public function admin_print_footer_scripts() { |
| 235 | 294 | global $post_ID, $tag_ID; |
| 236 | 295 | |
| @@ -242,39 +301,71 @@ | ||
| 242 | 301 | if ( ! empty( $tag_ID ) ) { |
| 243 | 302 | $params = array_merge( $params, array( 'pll_term_id' => (int) $tag_ID ) ); |
| 244 | 303 | } |
| 245 | 304 | |
| 305 | + /** | |
| 306 | + * Filters the list of parameters to add to the admin ajax request. | |
| 307 | + * | |
| 308 | + * @since 3.4.5 | |
| 309 | + * | |
| 310 | + * @param array $params List of parameters to add to the admin ajax request. | |
| 311 | + */ | |
| 312 | + $params = apply_filters( 'pll_admin_ajax_params', $params ); | |
| 313 | + | |
| 246 | 314 | $str = http_build_query( $params ); |
| 247 | 315 | $arr = wp_json_encode( $params ); |
| 248 | 316 | ?> |
| 249 | - <script type="text/javascript"> | |
| 317 | + <script> | |
| 250 | 318 | if (typeof jQuery != 'undefined') { |
| 251 | - (function($){ | |
| 252 | - $.ajaxPrefilter(function (options, originalOptions, jqXHR) { | |
| 253 | - if ( -1 != options.url.indexOf( ajaxurl ) || -1 != ajaxurl.indexOf( options.url ) ) { | |
| 254 | - if ( 'undefined' === typeof options.data ) { | |
| 255 | - options.data = ( 'get' === options.type.toLowerCase() ) ? '<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>' : <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?>; | |
| 256 | - } else { | |
| 257 | - if ( 'string' === typeof options.data ) { | |
| 258 | - if ( '' === options.data && 'get' === options.type.toLowerCase() ) { | |
| 259 | - options.url = options.url+'&<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>'; | |
| 319 | + jQuery( | |
| 320 | + function( $ ){ | |
| 321 | + $.ajaxPrefilter( function ( options, originalOptions, jqXHR ) { | |
| 322 | + if ( -1 != options.url.indexOf( ajaxurl ) || -1 != ajaxurl.indexOf( options.url ) ) { | |
| 323 | + | |
| 324 | + function addPolylangParametersAsString() { | |
| 325 | + if ( 'undefined' === typeof options.data || '' === options.data.trim() ) { | |
| 326 | + // Only Polylang data need to be send. So it could be as a simple query string. | |
| 327 | + options.data = '<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>'; | |
| 260 | 328 | } else { |
| 329 | + /* | |
| 330 | + * In some cases data could be a JSON string like in third party plugins. | |
| 331 | + * So we need not to break their process by adding polylang parameters as valid JSON data. | |
| 332 | + */ | |
| 261 | 333 | try { |
| 262 | - var o = $.parseJSON(options.data); | |
| 263 | - o = $.extend(o, <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?>); | |
| 264 | - options.data = JSON.stringify(o); | |
| 334 | + options.data = JSON.stringify( Object.assign( JSON.parse( options.data ), <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?> ) ); | |
| 335 | + } catch( exception ) { | |
| 336 | + // Add Polylang data to the existing query string. | |
| 337 | + options.data = options.data + '&<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>'; | |
| 265 | 338 | } |
| 266 | - catch(e) { | |
| 267 | - options.data = '<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>&'+options.data; | |
| 268 | - } | |
| 269 | 339 | } |
| 340 | + } | |
| 341 | + | |
| 342 | + /* | |
| 343 | + * options.processData set to true is the default jQuery process where the data is converted in a query string by using jQuery.param(). | |
| 344 | + * This step is done before applying filters. Thus here the options.data is already a string in this case. | |
| 345 | + * @See https://github.com/jquery/jquery/blob/3.5.1/src/ajax.js#L563-L569 jQuery ajax function. | |
| 346 | + * It is the most case WordPress send ajax request this way however third party plugins or themes could be send JSON string. | |
| 347 | + * Use JSON format is recommended in jQuery.param() documentation to be able to send complex data structures. | |
| 348 | + * @See https://api.jquery.com/jquery.param/ jQuery param function. | |
| 349 | + */ | |
| 350 | + if ( options.processData ) { | |
| 351 | + addPolylangParametersAsString(); | |
| 270 | 352 | } else { |
| 271 | - options.data = $.extend(options.data, <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?>); | |
| 353 | + /* | |
| 354 | + * If options.processData is set to false data could be undefined or pass as a string. | |
| 355 | + * So data as to be processed as if options.processData is set to true. | |
| 356 | + */ | |
| 357 | + if ( 'undefined' === typeof options.data || 'string' === typeof options.data ) { | |
| 358 | + addPolylangParametersAsString(); | |
| 359 | + } else { | |
| 360 | + // Otherwise options.data is probably an object. | |
| 361 | + options.data = Object.assign( options.data || {} , <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?> ); | |
| 362 | + } | |
| 272 | 363 | } |
| 273 | 364 | } |
| 274 | - } | |
| 275 | - }); | |
| 276 | - })(jQuery) | |
| 365 | + }); | |
| 366 | + } | |
| 367 | + ); | |
| 277 | 368 | } |
| 278 | 369 | </script> |
| 279 | 370 | <?php |
| 280 | 371 | } |
| @@ -282,8 +373,10 @@ | ||
| 282 | 373 | /** |
| 283 | 374 | * Sets the admin current language, used to filter the content |
| 284 | 375 | * |
| 285 | 376 | * @since 2.0 |
| 377 | + * | |
| 378 | + * @return void | |
| 286 | 379 | */ |
| 287 | 380 | public function set_current_language() { |
| 288 | 381 | $this->curlang = $this->filter_lang; |
| 289 | 382 | |
| @@ -289,9 +382,9 @@ | ||
| 289 | 382 | |
| 290 | 383 | // Edit Post |
| 291 | 384 | if ( isset( $_REQUEST['pll_post_id'] ) && $lang = $this->model->post->get_language( (int) $_REQUEST['pll_post_id'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification |
| 292 | 385 | $this->curlang = $lang; |
| 293 | - } elseif ( 'post.php' === $GLOBALS['pagenow'] && isset( $_GET['post'] ) && $lang = $this->model->post->get_language( (int) $_GET['post'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 386 | + } elseif ( 'post.php' === $GLOBALS['pagenow'] && isset( $_GET['post'] ) && $this->model->is_translated_post_type( get_post_type( (int) $_GET['post'] ) ) && $lang = $this->model->post->get_language( (int) $_GET['post'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 294 | 387 | $this->curlang = $lang; |
| 295 | 388 | } elseif ( 'post-new.php' === $GLOBALS['pagenow'] && ( empty( $_GET['post_type'] ) || $this->model->is_translated_post_type( sanitize_key( $_GET['post_type'] ) ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification |
| 296 | 389 | $this->curlang = empty( $_GET['new_lang'] ) ? $this->pref_lang : $this->model->get_language( sanitize_key( $_GET['new_lang'] ) ); // phpcs:ignore WordPress.Security.NonceVerification |
| 297 | 390 | } |
| @@ -296,15 +389,14 @@ | ||
| 296 | 389 | $this->curlang = empty( $_GET['new_lang'] ) ? $this->pref_lang : $this->model->get_language( sanitize_key( $_GET['new_lang'] ) ); // phpcs:ignore WordPress.Security.NonceVerification |
| 297 | 390 | } |
| 298 | 391 | |
| 299 | 392 | // Edit Term |
| 300 | - // FIXME 'edit-tags.php' for backward compatibility with WP < 4.5 | |
| 301 | - elseif ( in_array( $GLOBALS['pagenow'], array( 'edit-tags.php', 'term.php' ) ) && isset( $_GET['tag_ID'] ) && $lang = $this->model->term->get_language( (int) $_GET['tag_ID'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 393 | + elseif ( isset( $_REQUEST['pll_term_id'] ) && $lang = $this->model->term->get_language( (int) $_REQUEST['pll_term_id'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 302 | 394 | $this->curlang = $lang; |
| 303 | - } elseif ( isset( $_REQUEST['pll_term_id'] ) && $lang = $this->model->term->get_language( (int) $_REQUEST['pll_term_id'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 304 | - $this->curlang = $lang; | |
| 305 | - } elseif ( 'edit-tags.php' === $GLOBALS['pagenow'] && isset( $_GET['taxonomy'] ) && $this->model->is_translated_taxonomy( sanitize_key( $_GET['taxonomy'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 306 | - if ( ! empty( $_GET['new_lang'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 395 | + } elseif ( in_array( $GLOBALS['pagenow'], array( 'edit-tags.php', 'term.php' ) ) && isset( $_GET['taxonomy'] ) && $this->model->is_translated_taxonomy( sanitize_key( $_GET['taxonomy'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 396 | + if ( isset( $_GET['tag_ID'] ) && $lang = $this->model->term->get_language( (int) $_GET['tag_ID'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 397 | + $this->curlang = $lang; | |
| 398 | + } elseif ( ! empty( $_GET['new_lang'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 307 | 399 | $this->curlang = $this->model->get_language( sanitize_key( $_GET['new_lang'] ) ); // phpcs:ignore WordPress.Security.NonceVerification |
| 308 | 400 | } elseif ( empty( $this->curlang ) ) { |
| 309 | 401 | $this->curlang = $this->pref_lang; |
| 310 | 402 | } |
| @@ -313,8 +405,27 @@ | ||
| 313 | 405 | // Ajax |
| 314 | 406 | if ( wp_doing_ajax() && ! empty( $_REQUEST['lang'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification |
| 315 | 407 | $this->curlang = $this->model->get_language( sanitize_key( $_REQUEST['lang'] ) ); // phpcs:ignore WordPress.Security.NonceVerification |
| 316 | 408 | } |
| 409 | + | |
| 410 | + /** | |
| 411 | + * Filters the current language used by Polylang in the admin context. | |
| 412 | + * | |
| 413 | + * @since 3.2 | |
| 414 | + * | |
| 415 | + * @param PLL_Language|false|null $curlang Instance of the current language. | |
| 416 | + * @param PLL_Admin_Base $polylang Instance of the main Polylang's object. | |
| 417 | + */ | |
| 418 | + $this->curlang = apply_filters( 'pll_admin_current_language', $this->curlang, $this ); | |
| 419 | + | |
| 420 | + // Inform that the admin language has been set. | |
| 421 | + if ( $this->curlang instanceof PLL_Language ) { | |
| 422 | + /** This action is documented in frontend/choose-lang.php */ | |
| 423 | + do_action( 'pll_language_defined', $this->curlang->slug, $this->curlang ); | |
| 424 | + } else { | |
| 425 | + /** This action is documented in include/class-polylang.php */ | |
| 426 | + do_action( 'pll_no_language_defined' ); // To load overridden textdomains. | |
| 427 | + } | |
| 317 | 428 | } |
| 318 | 429 | |
| 319 | 430 | /** |
| 320 | 431 | * Defines the backend language and the admin language filter based on user preferences |
| @@ -319,8 +430,10 @@ | ||
| 319 | 430 | /** |
| 320 | 431 | * Defines the backend language and the admin language filter based on user preferences |
| 321 | 432 | * |
| 322 | 433 | * @since 1.2.3 |
| 434 | + * | |
| 435 | + * @return void | |
| 323 | 436 | */ |
| 324 | 437 | public function init_user() { |
| 325 | 438 | // Language for admin language filter: may be empty |
| 326 | 439 | // $_GET['lang'] is numeric when editing a language, not when selecting a new language in the filter |
| @@ -331,31 +444,21 @@ | ||
| 331 | 444 | |
| 332 | 445 | $this->filter_lang = $this->model->get_language( get_user_meta( get_current_user_id(), 'pll_filter_content', true ) ); |
| 333 | 446 | |
| 334 | 447 | // Set preferred language for use when saving posts and terms: must not be empty |
| 335 | - $this->pref_lang = empty( $this->filter_lang ) ? $this->model->get_language( $this->options['default_lang'] ) : $this->filter_lang; | |
| 448 | + $this->pref_lang = empty( $this->filter_lang ) ? $this->model->get_default_language() : $this->filter_lang; | |
| 336 | 449 | |
| 337 | 450 | /** |
| 338 | - * Filter the preferred language on admin side | |
| 339 | - * The preferred language is used for example to determine the language of a new post | |
| 451 | + * Filters the preferred language on admin side. | |
| 452 | + * The preferred language is used for example to determine the language of a new post. | |
| 340 | 453 | * |
| 341 | 454 | * @since 1.2.3 |
| 342 | 455 | * |
| 343 | - * @param object $pref_lang preferred language | |
| 456 | + * @param PLL_Language $pref_lang Preferred language. | |
| 344 | 457 | */ |
| 345 | 458 | $this->pref_lang = apply_filters( 'pll_admin_preferred_language', $this->pref_lang ); |
| 346 | 459 | |
| 347 | 460 | $this->set_current_language(); |
| 348 | - | |
| 349 | - // Inform that the admin language has been set | |
| 350 | - // Only if the admin language is one of the Polylang defined language | |
| 351 | - if ( $curlang = $this->model->get_language( get_user_locale() ) ) { | |
| 352 | - /** This action is documented in frontend/choose-lang.php */ | |
| 353 | - do_action( 'pll_language_defined', $curlang->slug, $curlang ); | |
| 354 | - } else { | |
| 355 | - /** This action is documented in include/class-polylang.php */ | |
| 356 | - do_action( 'pll_no_language_defined' ); // to load overridden textdomains | |
| 357 | - } | |
| 358 | 461 | } |
| 359 | 462 | |
| 360 | 463 | /** |
| 361 | 464 | * Avoids parsing a tax query when all languages are requested |
| @@ -360,13 +463,13 @@ | ||
| 360 | 463 | /** |
| 361 | 464 | * Avoids parsing a tax query when all languages are requested |
| 362 | 465 | * Fixes https://wordpress.org/support/topic/notice-undefined-offset-0-in-wp-includesqueryphp-on-line-3877 introduced in WP 4.1 |
| 363 | 466 | * |
| 364 | - * @see the suggestion of @boonebgorges, https://core.trac.wordpress.org/ticket/31246 | |
| 467 | + * @see https://core.trac.wordpress.org/ticket/31246 the suggestion of @boonebgorges. | |
| 365 | 468 | * |
| 366 | 469 | * @since 1.6.5 |
| 367 | 470 | * |
| 368 | - * @param array $qvars | |
| 471 | + * @param array $qvars The array of requested query variables. | |
| 369 | 472 | * @return array |
| 370 | 473 | */ |
| 371 | 474 | public function request( $qvars ) { |
| 372 | 475 | if ( isset( $qvars['lang'] ) && 'all' === $qvars['lang'] ) { |
| @@ -376,13 +479,14 @@ | ||
| 376 | 479 | return $qvars; |
| 377 | 480 | } |
| 378 | 481 | |
| 379 | 482 | /** |
| 380 | - * Adds the languages list in admin bar for the admin languages filter | |
| 483 | + * Adds the languages list in admin bar for the admin languages filter. | |
| 381 | 484 | * |
| 382 | 485 | * @since 0.9 |
| 383 | 486 | * |
| 384 | - * @param object $wp_admin_bar | |
| 487 | + * @param WP_Admin_Bar $wp_admin_bar WP_Admin_Bar global object. | |
| 488 | + * @return void | |
| 385 | 489 | */ |
| 386 | 490 | public function admin_bar_menu( $wp_admin_bar ) { |
| 387 | 491 | $all_item = (object) array( |
| 388 | 492 | 'slug' => 'all', |
| @@ -393,9 +497,9 @@ | ||
| 393 | 497 | $selected = empty( $this->filter_lang ) ? $all_item : $this->filter_lang; |
| 394 | 498 | |
| 395 | 499 | $title = sprintf( |
| 396 | 500 | '<span class="ab-label"%1$s><span class="screen-reader-text">%2$s</span>%3$s</span>', |
| 397 | - 'all' === $selected->slug ? '' : sprintf( ' lang="%s"', esc_attr( $selected->get_locale( 'display' ) ) ), | |
| 501 | + $selected instanceof PLL_Language ? sprintf( ' lang="%s"', esc_attr( $selected->get_locale( 'display' ) ) ) : '', | |
| 398 | 502 | __( 'Filters content by language', 'polylang' ), |
| 399 | 503 | esc_html( $selected->name ) |
| 400 | 504 | ); |
| 401 | 505 | |
| @@ -407,17 +511,23 @@ | ||
| 407 | 511 | * @param array $items The admin languages filter submenu items. |
| 408 | 512 | */ |
| 409 | 513 | $items = apply_filters( 'pll_admin_languages_filter', array_merge( array( $all_item ), $this->model->get_languages_list() ) ); |
| 410 | 514 | |
| 515 | + $menu = array( | |
| 516 | + 'id' => 'languages', | |
| 517 | + 'title' => $selected->flag . $title, | |
| 518 | + 'href' => esc_url( add_query_arg( 'lang', $selected->slug, remove_query_arg( 'paged' ) ) ), | |
| 519 | + 'meta' => array( | |
| 520 | + 'title' => __( 'Filters content by language', 'polylang' ), | |
| 521 | + ), | |
| 522 | + ); | |
| 523 | + | |
| 524 | + if ( 'all' !== $selected->slug ) { | |
| 525 | + $menu['meta']['class'] = 'pll-filtered-languages'; | |
| 526 | + } | |
| 527 | + | |
| 411 | 528 | if ( ! empty( $items ) ) { |
| 412 | - $wp_admin_bar->add_menu( | |
| 413 | - array( | |
| 414 | - 'id' => 'languages', | |
| 415 | - 'title' => $selected->flag . $title, | |
| 416 | - 'href' => esc_url( add_query_arg( 'lang', $selected->slug, remove_query_arg( 'paged' ) ) ), | |
| 417 | - 'meta' => array( 'title' => __( 'Filters content by language', 'polylang' ) ), | |
| 418 | - ) | |
| 419 | - ); | |
| 529 | + $wp_admin_bar->add_menu( $menu ); | |
| 420 | 530 | } |
| 421 | 531 | |
| 422 | 532 | foreach ( $items as $lang ) { |
| 423 | 533 | if ( $selected->slug === $lang->slug ) { |
| @@ -434,13 +544,32 @@ | ||
| 434 | 544 | ) |
| 435 | 545 | ); |
| 436 | 546 | } |
| 437 | 547 | } |
| 548 | + | |
| 438 | 549 | /** |
| 439 | - * Instantiate PLL_Wizard_Pro class. | |
| 550 | + * Remove the customize submenu when using a block theme. | |
| 440 | 551 | * |
| 441 | - * @since 2.7 | |
| 552 | + * WordPress removes the Customizer menu if a block theme is activated and no other plugins interact with it. | |
| 553 | + * As Polylang interacts with the Customizer, we have to delete this menu ourselves in the case of a block theme, | |
| 554 | + * unless another plugin than Polylang interacts with the Customizer. | |
| 555 | + * | |
| 556 | + * @since 3.2 | |
| 557 | + * | |
| 558 | + * @return void | |
| 442 | 559 | */ |
| 443 | - public function instantiate_wizard_pro() { | |
| 444 | - $this->wizard_pro = new PLL_Wizard_Pro( $this ); | |
| 560 | + public function remove_customize_submenu() { | |
| 561 | + if ( ! $this->should_customize_menu_be_removed() ) { | |
| 562 | + return; | |
| 563 | + } | |
| 564 | + | |
| 565 | + global $submenu; | |
| 566 | + | |
| 567 | + if ( ! empty( $submenu['themes.php'] ) ) { | |
| 568 | + foreach ( $submenu['themes.php'] as $submenu_item ) { | |
| 569 | + if ( 'customize' === $submenu_item[1] ) { | |
| 570 | + remove_submenu_page( 'themes.php', $submenu_item[2] ); | |
| 571 | + } | |
| 572 | + } | |
| 573 | + } | |
| 445 | 574 | } |
| 446 | 575 | } |
