canonical-presenter.php
1.11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<?php
namespace Yoast\WP\SEO\Presenters;
use Yoast\WP\SEO\Presentations\Indexable_Presentation;
/**
* Presenter class for the canonical.
*/
class Canonical_Presenter extends Abstract_Indexable_Tag_Presenter {
/**
* The tag key name.
*
* @var string
*/
protected $key = 'canonical';
/**
* The tag format including placeholders.
*
* @var string
*/
protected $tag_format = self::LINK_REL_HREF;
/**
* The method of escaping to use.
*
* @var string
*/
protected $escaping = 'url';
/**
* Run the canonical content through the `wpseo_canonical` filter.
*
* @return string The filtered canonical.
*/
public function get() {
if ( \in_array( 'noindex', $this->presentation->robots, true ) ) {
return '';
}
/**
* Filter: 'wpseo_canonical' - Allow filtering of the canonical URL put out by Yoast SEO.
*
* @api string $canonical The canonical URL.
*
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
return \urldecode( (string) \trim( \apply_filters( 'wpseo_canonical', $this->presentation->canonical, $this->presentation ) ) );
}
}