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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
<?php
/**
* WPSEO plugin file.
*
* @package WPSEO\Frontend\Schema
*/
/**
* Returns schema Breadcrumb data.
*
* @since 10.2
*/
class WPSEO_Schema_Breadcrumb implements WPSEO_Graph_Piece {
/**
* A value object with context variables.
*
* @var WPSEO_Schema_Context
*/
private $context;
/**
* Current position in the List.
*
* @var int
*/
private $index;
/**
* WPSEO_Schema_Breadcrumb constructor.
*
* @param WPSEO_Schema_Context $context A value object with context variables.
*/
public function __construct( WPSEO_Schema_Context $context ) {
$this->context = $context;
}
/**
* Determine if we should add a breadcrumb attribute.
*
* @return bool
*/
public function is_needed() {
if ( is_404() ) {
return false;
}
if ( is_front_page() ) {
return false;
}
if ( $this->context->breadcrumbs_enabled ) {
return true;
}
return false;
}
/**
* Returns Schema breadcrumb data to allow recognition of page's position in the site hierarchy.
*
* @link https://developers.google.com/search/docs/data-types/breadcrumb
*
* @return bool|array Array on success, false on failure.
*/
public function generate() {
$breadcrumbs_instance = WPSEO_Breadcrumbs::get_instance();
$breadcrumbs = $breadcrumbs_instance->get_links();
$broken = false;
$list_elements = array();
foreach ( $breadcrumbs as $index => $breadcrumb ) {
if ( ! empty( $breadcrumb['hide_in_schema'] ) ) {
continue;
}
if ( ! array_key_exists( 'url', $breadcrumb ) || ! array_key_exists( 'text', $breadcrumb ) ) {
$broken = true;
break;
}
$list_elements[] = $this->add_breadcrumb( $index, $breadcrumb );
$this->index = $index;
}
if ( is_paged() ) {
$list_elements[] = $this->add_paginated_state();
}
$data = array(
'@type' => 'BreadcrumbList',
'@id' => $this->context->canonical . WPSEO_Schema_IDs::BREADCRUMB_HASH,
'itemListElement' => $list_elements,
);
// Only output if JSON is correctly formatted.
if ( ! $broken ) {
return $data;
}
return false;
}
/**
* Returns a breadcrumb array.
*
* @param int $index The position in the list.
* @param array $breadcrumb The breadcrumb array.
*
* @return array A breadcrumb listItem.
*/
private function add_breadcrumb( $index, $breadcrumb ) {
if ( empty( $breadcrumb['url'] ) ) {
if ( is_paged() ) {
// Retrieve the un-paginated state of the current page.
$breadcrumb['url'] = WPSEO_Frontend::get_instance()->canonical( false, true );
}
else {
$breadcrumb['url'] = $this->context->canonical;
}
}
if ( empty( $breadcrumb['text'] ) ) {
$breadcrumb['url'] = $this->context->title;
}
return array(
'@type' => 'ListItem',
'position' => ( $index + 1 ),
'item' => array(
'@type' => 'WebPage',
'@id' => $breadcrumb['url'],
'url' => $breadcrumb['url'], // For future proofing, we're trying to change the standard for this.
'name' => $breadcrumb['text'],
),
);
}
/**
* Adds the paginated state to the breadcrumb array.
*
* @return array A breadcrumb listItem.
*/
private function add_paginated_state() {
$this->index++;
return $this->add_breadcrumb(
$this->index,
array(
'url' => $this->context->canonical,
'text' => $this->context->title,
)
);
}
}
|