: str_replace(): Passing null to parameter #2 ($replace) of type array|string is deprecated in
* @author OnTheGo Systems
const CANONICAL_FOR_DUPLICATED_POST = 'duplicate';
const CANONICAL_FOR_NON_TRANSLATABLE_POST = 'non-translatable';
/** @var WPML_Translations */
private $wpml_translations;
/** @var WPML_Translation_Element_Factory */
private $translation_element_factory;
* WPML_Canonicals constructor.
* @param SitePress $sitepress
* @param WPML_Translation_Element_Factory $translation_element_factory
* @param WPML_Translations $wpml_translations
public function __construct(
WPML_Translation_Element_Factory $translation_element_factory,
WPML_Translations $wpml_translations = null
$this->sitepress = $sitepress;
$this->translation_element_factory = $translation_element_factory;
$this->wpml_translations = $wpml_translations;
* @throws \InvalidArgumentException
private function must_filter_permalink( $post_id ) {
$this->init_wpml_translations();
$post_element = $this->translation_element_factory->create( $post_id, 'post' );
$must_handle_canonicals = $this->must_handle_a_canonical_url();
if ( $post_element->is_translatable() ) {
if ( $must_handle_canonicals && $this->wpml_translations->is_a_duplicate_of( $post_element ) && $this->is_permalink_filter_from_rel_canonical() ) {
return self::CANONICAL_FOR_DUPLICATED_POST;
} elseif ( $must_handle_canonicals ) {
return self::CANONICAL_FOR_NON_TRANSLATABLE_POST;
* @throws \InvalidArgumentException
public function permalink_filter( $link, $post_id ) {
switch ( $this->must_filter_permalink( $post_id ) ) {
case self::CANONICAL_FOR_DUPLICATED_POST:
$post_element = $this->translation_element_factory->create( $post_id, 'post' );
return $this->get_canonical_of_duplicate( $post_element );
case self::CANONICAL_FOR_NON_TRANSLATABLE_POST:
return $this->get_url_in_default_language_if_rel_canonical( $link );
* @param string $canonical_url
public function get_canonical_url( $canonical_url, $post, $request_language ) {
if ( $post && $this->sitepress->get_wp_api()->is_front_end() ) {
/** @var WPML_Post_Element $post_element */
$post_element = $this->translation_element_factory->create( $post->ID, 'post' );
$should_translate_canonical_url = apply_filters(
'wpml_must_translate_canonical_url', true, $post_element
if ( ! $should_translate_canonical_url ) {
if ( ! $post_element->is_translatable() ) {
global $wpml_url_filters;
$wpml_url_filters->remove_global_hooks();
$canonical_url = $this->sitepress->convert_url_string( $canonical_url, $this->sitepress->get_default_language() );
$wpml_url_filters->add_global_hooks();
$this->init_wpml_translations();
if ( $this->wpml_translations->is_a_duplicate_of( $post_element ) ) {
$canonical_url = (string) $this->get_canonical_of_duplicate( $post_element );
} elseif ( $post_element->get_language_code() != $request_language ) {
$canonical_url = $this->sitepress->convert_url_string( $canonical_url, $post_element->get_language_code() );
} catch ( InvalidArgumentException $e ) {
public function get_general_canonical_url( $url ) {
global $wpml_url_filters;
$wpml_url_filters->remove_global_hooks();
$canonical_url = $this->sitepress->convert_url_string( $url, $this->sitepress->get_current_language() );
$wpml_url_filters->add_global_hooks();
private function has_wp_get_canonical_url() {
return $this->sitepress->get_wp_api()->function_exists( 'wp_get_canonical_url' );
private function is_permalink_filter_from_rel_canonical() {
$back_trace_stack = $this->sitepress->get_wp_api()->get_backtrace( 20 );
$keywords = array( 'rel_canonical', 'canonical', 'generate_canonical' );
if ( $back_trace_stack ) {
foreach ( $back_trace_stack as $key => $value ) {
foreach ( $keywords as $keyword ) {
if ( 'function' === $key && $keyword === $value ) {
private function get_url_in_default_language_if_rel_canonical( $link ) {
if ( $this->is_permalink_filter_from_rel_canonical() ) {
$default_language = $this->sitepress->get_default_language();
$link = (string) $this->sitepress->convert_url( $link, $default_language );
* @param WPML_Post_Element $post_element
private function get_canonical_of_duplicate( $post_element ) {
$source_element = $post_element->get_source_element();
$source_element_id = $source_element->get_id();
$source_language_code = $source_element->get_language_code();
$current_language = $this->sitepress->get_current_language();
$this->sitepress->switch_lang( $source_language_code );
$new_link = get_permalink( $source_element_id );
$this->sitepress->switch_lang( $current_language );
$new_link = get_permalink( $post_element->get_id() );
private function must_handle_a_canonical_url() {
return ! $this->has_wp_get_canonical_url() && $this->sitepress->get_wp_api()->is_front_end();
private function init_wpml_translations() {
if ( ! $this->wpml_translations ) {
$this->wpml_translations = new WPML_Translations( $this->sitepress );