Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
369 lines (322 sloc) 12.4 KB
<?php
/**
* Setup filters common to admin and frontend
*
* @since 1.4
*/
class PLL_Filters {
public $links_model, $model, $options, $curlang;
/**
* Constructor: setups filters
*
* @since 1.4
*
* @param object $polylang
*/
public function __construct( &$polylang ) {
$this->links_model = &$polylang->links_model;
$this->model = &$polylang->model;
$this->options = &$polylang->options;
$this->curlang = &$polylang->curlang;
// Filters the comments according to the current language
add_action( 'parse_comment_query', array( $this, 'parse_comment_query' ) );
add_filter( 'comments_clauses', array( $this, 'comments_clauses' ), 10, 2 );
// Filters the get_pages function according to the current language
add_filter( 'get_pages', array( $this, 'get_pages' ), 10, 2 );
// Rewrites next and previous post links to filter them by language
add_filter( 'get_previous_post_join', array( $this, 'posts_join' ), 10, 5 );
add_filter( 'get_next_post_join', array( $this, 'posts_join' ), 10, 5 );
add_filter( 'get_previous_post_where', array( $this, 'posts_where' ), 10, 5 );
add_filter( 'get_next_post_where', array( $this, 'posts_where' ), 10, 5 );
// Converts the locale to a valid W3C locale
add_filter( 'language_attributes', array( $this, 'language_attributes' ) );
// Prevents deleting all the translations of the default category
add_filter( 'map_meta_cap', array( $this, 'fix_delete_default_category' ), 10, 4 );
// Translate the site title in emails sent to users
add_filter( 'password_change_email', array( $this, 'translate_user_email' ) );
add_filter( 'email_change_email', array( $this, 'translate_user_email' ) );
// Translates the privacy policy page
add_filter( 'option_wp_page_for_privacy_policy', array( $this, 'translate_page_for_privacy_policy' ), 20 ); // Since WP 4.9.6
add_filter( 'map_meta_cap', array( $this, 'fix_privacy_policy_page_editing' ), 10, 4 );
// Personal data exporter
add_filter( 'wp_privacy_personal_data_exporters', array( $this, 'register_personal_data_exporter' ), 0 ); // Since WP 4.9.6
}
/**
* Get the language to filter a comments query
*
* @since 2.0
*
* @param object $query
* @return object|bool the language(s) to use in the filter, false otherwise
*/
protected function get_comments_queried_language( $query ) {
// Don't filter comments if comment ids or post ids are specified
$plucked = wp_array_slice_assoc( $query->query_vars, array( 'comment__in', 'parent', 'post_id', 'post__in', 'post_parent' ) );
$fields = array_filter( $plucked );
if ( ! empty( $fields ) ) {
return false;
}
// Don't filter comments if a non translated post type is specified
if ( ! empty( $query->query_vars['post_type'] ) && ! $this->model->is_translated_post_type( $query->query_vars['post_type'] ) ) {
return false;
}
return empty( $query->query_vars['lang'] ) ? $this->curlang : $this->model->get_language( $query->query_vars['lang'] );
}
/**
* Adds language dependent cache domain when querying comments
* Useful as the 'lang' parameter is not included in cache key by WordPress
* Needed since WP 4.6 as comments have been added to persistent cache. See #36906, #37419
*
* @since 2.0
*
* @param object $query
*/
public function parse_comment_query( $query ) {
if ( $lang = $this->get_comments_queried_language( $query ) ) {
$key = '_' . ( is_array( $lang ) ? implode( ',', $lang ) : $this->model->get_language( $lang )->slug );
$query->query_vars['cache_domain'] = empty( $query->query_vars['cache_domain'] ) ? 'pll' . $key : $query->query_vars['cache_domain'] . $key;
}
}
/**
* Filters the comments according to the current language
* Used by the recent comments widget and admin language filter
*
* @since 0.2
*
* @param array $clauses sql clauses
* @param object $query WP_Comment_Query object
* @return array modified $clauses
*/
public function comments_clauses( $clauses, $query ) {
global $wpdb;
$lang = $this->get_comments_queried_language( $query );
if ( ! empty( $lang ) ) {
// If this clause is not already added by WP
if ( ! strpos( $clauses['join'], '.ID' ) ) {
$clauses['join'] .= " JOIN $wpdb->posts ON $wpdb->posts.ID = $wpdb->comments.comment_post_ID";
}
$clauses['join'] .= $this->model->post->join_clause();
$clauses['where'] .= $this->model->post->where_clause( $lang );
}
return $clauses;
}
/**
* Filters get_pages per language
*
* @since 1.4
*
* @param array $pages an array of pages already queried
* @param array $args get_pages arguments
* @return array modified list of pages
*/
public function get_pages( $pages, $args ) {
if ( isset( $args['lang'] ) && empty( $args['lang'] ) ) {
return $pages;
}
$language = empty( $args['lang'] ) ? $this->curlang : $this->model->get_language( $args['lang'] );
if ( empty( $language ) || empty( $pages ) || ! $this->model->is_translated_post_type( $args['post_type'] ) ) {
return $pages;
}
static $once = false;
// Obliged to redo the get_pages query if we want to get the right number
if ( ! empty( $args['number'] ) && ! $once ) {
$once = true; // avoid infinite loop
$r = array(
'lang' => 0, // So this query is not filtered
'numberposts' => -1,
'nopaging' => true,
'post_type' => $args['post_type'],
'fields' => 'ids',
'tax_query' => array(
array(
'taxonomy' => 'language',
'field' => 'term_taxonomy_id', // Since WP 3.5
'terms' => $language->term_taxonomy_id,
'operator' => 'NOT IN',
),
),
);
// Take care that 'exclude' argument accepts integer or strings too
$args['exclude'] = array_merge( wp_parse_id_list( $args['exclude'] ), get_posts( $r ) );
$pages = get_pages( $args );
}
$ids = wp_list_pluck( $pages, 'ID' );
// Filters the queried list of pages by language
if ( ! $once ) {
$ids = array_intersect( $ids, $this->model->post->get_objects_in_language( $language ) );
foreach ( $pages as $key => $page ) {
if ( ! in_array( $page->ID, $ids ) ) {
unset( $pages[ $key ] );
}
}
$pages = array_values( $pages ); // In case 3rd parties suppose the existence of $pages[0]
}
// Not done by WP but extremely useful for performance when manipulating taxonomies
update_object_term_cache( $ids, $args['post_type'] );
$once = false; // In case get_pages is called another time
return $pages;
}
/**
* Modifies the sql request for get_adjacent_post to filter by the current language
*
* @since 0.1
*
* @param string $sql The JOIN clause in the SQL.
* @param bool $in_same_term Whether post should be in a same taxonomy term.
* @param array $excluded_terms Array of excluded term IDs.
* @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true.
* @param WP_Post $post WP_Post object.
* @return string modified JOIN clause
*/
public function posts_join( $sql, $in_same_term, $excluded_terms, $taxonomy = '', $post = null ) {
return $this->model->is_translated_post_type( $post->post_type ) && ! empty( $this->curlang ) ? $sql . $this->model->post->join_clause( 'p' ) : $sql;
}
/**
* Modifies the sql request for wp_get_archives and get_adjacent_post to filter by the current language
*
* @since 0.1
*
* @param string $sql The WHERE clause in the SQL.
* @param bool $in_same_term Whether post should be in a same taxonomy term.
* @param array $excluded_terms Array of excluded term IDs.
* @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true.
* @param WP_Post $post WP_Post object.
* @return string modified WHERE clause
*/
public function posts_where( $sql, $in_same_term, $excluded_terms, $taxonomy = '', $post = null ) {
return $this->model->is_translated_post_type( $post->post_type ) && ! empty( $this->curlang ) ? $sql . $this->model->post->where_clause( $this->curlang ) : $sql;
}
/**
* Converts WordPress locale to valid W3 locale in html language attributes
*
* @since 1.8
*
* @param string $output language attributes
* @return string
*/
public function language_attributes( $output ) {
if ( $language = $this->model->get_language( is_admin() ? get_user_locale() : get_locale() ) ) {
$output = str_replace( '"' . get_bloginfo( 'language' ) . '"', '"' . $language->get_locale( 'display' ) . '"', $output );
}
return $output;
}
/**
* Prevents deleting all the translations of the default category
*
* @since 2.1
*
* @param array $caps The user's actual capabilities.
* @param string $cap Capability name.
* @param int $user_id The user ID.
* @param array $args Adds the context to the cap. The category id.
* @return array
*/
public function fix_delete_default_category( $caps, $cap, $user_id, $args ) {
if ( 'delete_term' === $cap ) {
$term = get_term( reset( $args ) ); // Since WP 4.4, we can get the term to get the taxonomy
if ( $term instanceof WP_Term ) {
$default_cat = get_option( 'default_' . $term->taxonomy );
if ( $default_cat && array_intersect( $args, $this->model->term->get_translations( $default_cat ) ) ) {
$caps[] = 'do_not_allow';
}
}
}
return $caps;
}
/**
* Translates the site title in emails sent to the user (change email, reset password)
* It is necessary to filter the email because WP evaluates the site title before calling switch_to_locale()
*
* @since 2.1.3
*
* @param array $email
* @return array
*/
public function translate_user_email( $email ) {
$blog_name = wp_specialchars_decode( pll__( get_option( 'blogname' ) ), ENT_QUOTES );
$email['subject'] = sprintf( $email['subject'], $blog_name );
$email['message'] = str_replace( '###SITENAME###', $blog_name, $email['message'] );
return $email;
}
/**
* Translates the privacy policy page, on both frontend and admin
*
* @since 2.3.6
*
* @param int $id Privacy policy page id
* @return int
*/
public function translate_page_for_privacy_policy( $id ) {
return empty( $this->curlang ) ? $id : $this->model->post->get( $id, $this->curlang );
}
/**
* Prevents edit and delete links for the translations of the privacy policy page for non admin
*
* @since 2.3.7
*
* @param array $caps The user's actual capabilities.
* @param string $cap Capability name.
* @param int $user_id The user ID.
* @param array $args Adds the context to the cap. The category id.
* @return array
*/
public function fix_privacy_policy_page_editing( $caps, $cap, $user_id, $args ) {
if ( in_array( $cap, array( 'edit_page', 'edit_post', 'delete_page', 'delete_post' ) ) ) {
$privacy_page = get_option( 'wp_page_for_privacy_policy' );
if ( $privacy_page && array_intersect( $args, $this->model->post->get_translations( $privacy_page ) ) ) {
$caps = array_merge( $caps, map_meta_cap( 'manage_privacy_options', $user_id ) );
}
}
return $caps;
}
/**
* Register our personal data exporter
*
* @since 2.3.6
*
* @param array $exporters Personal data exporters
* @retun array
*/
public function register_personal_data_exporter( $exporters ) {
$exporters[] = array(
'exporter_friendly_name' => __( 'Translated user descriptions', 'polylang' ),
'callback' => array( $this, 'user_data_exporter' ),
);
return $exporters;
}
/**
* Export translated user description as WP exports only the description in the default language
*
* @since 2.3.6
*
* @param string $email_address User email address
* @return array Personal data
*/
public function user_data_exporter( $email_address ) {
$email_address = trim( $email_address );
$data_to_export = array();
if ( $user = get_user_by( 'email', $email_address ) ) {
foreach ( $this->model->get_languages_list() as $lang ) {
if ( $lang->slug !== $this->options['default_lang'] && $value = get_user_meta( $user->ID, 'description_' . $lang->slug, true ) ) {
$user_data_to_export[] = array(
/* translators: %s is a language native name */
'name' => sprintf( __( 'User description - %s', 'polylang' ), $lang->name ),
'value' => $value,
);
}
}
if ( ! empty( $user_data_to_export ) ) {
$data_to_export[] = array(
'group_id' => 'user',
'group_label' => __( 'User' ),
'item_id' => "user-{$user->ID}",
'data' => $user_data_to_export,
);
}
}
return array(
'data' => $data_to_export,
'done' => true,
);
}
}