wordpress-seo / src / generators / schema / person.php

person.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 28.3, at src/generators/schema/person.php

322 lines 9.6 KB

Raw Download Zip

1	<?php
2
3	namespace Yoast\WP\SEO\Generators\Schema;
4
5	use WP_User;
6	use Yoast\WP\SEO\Config\Schema_IDs;
7
8	/**
9	* Returns schema Person data.
10	*/
11	class Person extends Abstract_Schema_Piece {
12
13	/**
14	* Array of the social profiles we display for a Person.
15	*
16	* @var string[]
17	*/
18	private $social_profiles = [
19	'facebook',
20	'instagram',
21	'linkedin',
22	'pinterest',
23	'twitter',
24	'myspace',
25	'youtube',
26	'soundcloud',
27	'tumblr',
28	'wikipedia',
29	];
30
31	/**
32	* The Schema type we use for this class.
33	*
34	* @var string[]
35	*/
36	protected $type = [ 'Person', 'Organization' ];
37
38	/**
39	* Determine whether we should return Person schema.
40	*
41	* @return bool
42	*/
43	public function is_needed() {
44	// Using an author piece instead.
45	if ( $this->site_represents_current_author() ) {
46	return false;
47	}
48
49	return $this->context->site_represents === 'person';
50	}
51
52	/**
53	* Returns Person Schema data.
54	*
55	* @return bool\|array<string\|string[]> Person data on success, false on failure.
56	*/
57	public function generate() {
58	$user_id = $this->determine_user_id();
59	if ( ! $user_id ) {
60	return false;
61	}
62
63	return $this->build_person_data( $user_id );
64	}
65
66	/**
67	* Determines a User ID for the Person data.
68	*
69	* @return bool\|int User ID or false upon return.
70	*/
71	protected function determine_user_id() {
72	/**
73	* Filter: 'wpseo_schema_person_user_id' - Allows filtering of user ID used for person output.
74	*
75	* @param int\|bool $user_id The user ID currently determined.
76	*/
77	$user_id = \apply_filters( 'wpseo_schema_person_user_id', $this->context->site_user_id );
78
79	// It should to be an integer higher than 0.
80	if ( \is_int( $user_id ) && $user_id > 0 ) {
81	return $user_id;
82	}
83
84	return false;
85	}
86
87	/**
88	* Retrieve a list of social profile URLs for Person.
89	*
90	* @param string[] $same_as_urls Array of SameAs URLs.
91	* @param int $user_id User ID.
92	*
93	* @return string[] A list of SameAs URLs.
94	*/
95	protected function get_social_profiles( $same_as_urls, $user_id ) {
96	/**
97	* Filter: 'wpseo_schema_person_social_profiles' - Allows filtering of social profiles per user.
98	*
99	* @param string[] $social_profiles The array of social profiles to retrieve. Each should be a user meta field
100	* key. As they are retrieved using the WordPress function `get_the_author_meta`.
101	* @param int $user_id The current user we're grabbing social profiles for.
102	*/
103	$social_profiles = \apply_filters( 'wpseo_schema_person_social_profiles', $this->social_profiles, $user_id );
104
105	// We can only handle an array.
106	if ( ! \is_array( $social_profiles ) ) {
107	return $same_as_urls;
108	}
109
110	foreach ( $social_profiles as $profile ) {
111	// Skip non-string values.
112	if ( ! \is_string( $profile ) ) {
113	continue;
114	}
115
116	$social_url = $this->url_social_site( $profile, $user_id );
117	if ( $social_url ) {
118	$same_as_urls[] = $social_url;
119	}
120	}
121
122	return $same_as_urls;
123	}
124
125	/**
126	* Builds our array of Schema Person data for a given user ID.
127	*
128	* @param int $user_id The user ID to use.
129	* @param bool $add_hash Wether or not the person's image url hash should be added to the image id.
130	*
131	* @return array<string\|string[]> An array of Schema Person data.
132	*/
133	protected function build_person_data( $user_id, $add_hash = false ) {
134	$user_data = \get_userdata( $user_id );
135	$data = [
136	'@type' => $this->type,
137	'@id' => $this->helpers->schema->id->get_user_schema_id( $user_id, $this->context ),
138	];
139
140	// Safety check for the `get_userdata` WP function, which could return false.
141	if ( $user_data === false ) {
142	return $data;
143	}
144
145	$data['name'] = $this->helpers->schema->html->smart_strip_tags( $user_data->display_name );
146
147	$pronouns = $this->helpers->schema->html->smart_strip_tags( \get_the_author_meta( 'wpseo_pronouns', $user_id ) );
148	if ( ! empty( $pronouns ) ) {
149	$data['pronouns'] = $pronouns;
150	}
151
152	$data = $this->add_image( $data, $user_data, $add_hash );
153
154	if ( ! empty( $user_data->description ) ) {
155	$data['description'] = $this->helpers->schema->html->smart_strip_tags( $user_data->description );
156	}
157
158	if ( \is_array( $this->context->schema_page_type ) && \in_array( 'ProfilePage', $this->context->schema_page_type, true ) ) {
159	$data['mainEntityOfPage'] = [
160	'@id' => $this->context->main_schema_id,
161	];
162	}
163	$data = $this->add_same_as_urls( $data, $user_data, $user_id );
164
165	/**
166	* Filter: 'wpseo_schema_person_data' - Allows filtering of schema data per user.
167	*
168	* @param array $data The schema data we have for this person.
169	* @param int $user_id The current user we're collecting schema data for.
170	*/
171	$data = \apply_filters( 'wpseo_schema_person_data', $data, $user_id );
172
173	return $data;
174	}
175
176	/**
177	* Returns an ImageObject for the persons avatar.
178	*
179	* @param array<string\|string[]> $data The Person schema.
180	* @param WP_User $user_data User data.
181	* @param bool $add_hash Wether or not the person's image url hash should be added to the image id.
182	*
183	* @return array<string\|string[]> The Person schema.
184	*/
185	protected function add_image( $data, $user_data, $add_hash = false ) {
186	$schema_id = $this->context->site_url . Schema_IDs::PERSON_LOGO_HASH;
187
188	$data = $this->set_image_from_options( $data, $schema_id, $add_hash, $user_data );
189	if ( ! isset( $data['image'] ) ) {
190	$data = $this->set_image_from_avatar( $data, $user_data, $add_hash );
191	}
192
193	if ( \is_array( $this->type ) && \in_array( 'Organization', $this->type, true ) ) {
194	$data_logo = ( $data['image']['@id'] ?? $schema_id );
195	$data['logo'] = [ '@id' => $data_logo ];
196	}
197
198	return $data;
199	}
200
201	/**
202	* Generate the person image from our settings.
203	*
204	* @param array<string\|string[]> $data The Person schema.
205	* @param string $schema_id The string used in the `@id` for the schema.
206	* @param bool $add_hash Whether or not the person's image url hash should be added to the image id.
207	* @param WP_User\|null $user_data User data.
208	*
209	* @return array<string\|string[]> The Person schema.
210	*/
211	protected function set_image_from_options( $data, $schema_id, $add_hash = false, $user_data = null ) {
212	if ( $this->context->site_represents !== 'person' ) {
213	return $data;
214	}
215	if ( \is_array( $this->context->person_logo_meta ) ) {
216	$data['image'] = $this->helpers->schema->image->generate_from_attachment_meta( $this->context->person_logo_meta['url'], $this->context->person_logo_meta, $data['name'], $add_hash );
217	}
218
219	return $data;
220	}
221
222	/**
223	* Generate the person logo from gravatar.
224	*
225	* @param array<string\|string[]> $data The Person schema.
226	* @param WP_User $user_data User data.
227	* @param bool $add_hash Wether or not the person's image url hash should be added to the image id.
228	*
229	* @return array<string\|string[]> The Person schema.
230	*/
231	protected function set_image_from_avatar( $data, $user_data, $add_hash = false ) {
232	// If we don't have an image in our settings, fall back to an avatar, if we're allowed to.
233	$show_avatars = \get_option( 'show_avatars' );
234	if ( ! $show_avatars ) {
235	return $data;
236	}
237
238	$url = \get_avatar_url( $user_data->user_email );
239	if ( empty( $url ) ) {
240	return $data;
241	}
242
243	$data['image'] = $this->helpers->schema->image->simple_image_object( $url, $url, $user_data->display_name, $add_hash );
244
245	return $data;
246	}
247
248	/**
249	* Returns an author's social site URL.
250	*
251	* @param string $social_site The social site to retrieve the URL for.
252	* @param int\|false $user_id The user ID to use function outside of the loop.
253	*
254	* @return string
255	*/
256	protected function url_social_site( $social_site, $user_id = false ) {
257	$url = \get_the_author_meta( $social_site, $user_id );
258
259	if ( ! empty( $url ) && $social_site === 'twitter' ) {
260	$url = 'https://x.com/' . $url;
261	}
262
263	return $url;
264	}
265
266	/**
267	* Checks the site is represented by the same person as this indexable.
268	*
269	* @param WP_User\|null $user_data User data.
270	*
271	* @return bool True when the site is represented by the same person as this indexable.
272	*/
273	protected function site_represents_current_author( $user_data = null ) {
274	// Can only be the case when the site represents a user.
275	if ( $this->context->site_represents !== 'person' ) {
276	return false;
277	}
278
279	// Article post from the same user as the site represents.
280	if (
281	$this->context->indexable->object_type === 'post'
282	&& $this->helpers->schema->article->is_author_supported( $this->context->indexable->object_sub_type )
283	&& $this->context->schema_article_type !== 'None'
284	) {
285	$user_id = ( $user_data instanceof WP_User && isset( $user_data->ID ) ) ? $user_data->ID : $this->context->indexable->author_id;
286
287	return $this->context->site_user_id === $user_id;
288	}
289
290	// Author archive from the same user as the site represents.
291	return $this->context->indexable->object_type === 'user' && $this->context->site_user_id === $this->context->indexable->object_id;
292	}
293
294	/**
295	* Builds our SameAs array.
296	*
297	* @param array<string\|string[]> $data The Person schema data.
298	* @param WP_User $user_data The user data object.
299	* @param int $user_id The user ID to use.
300	*
301	* @return array<string\|string[]> The Person schema data.
302	*/
303	protected function add_same_as_urls( $data, $user_data, $user_id ) {
304	$same_as_urls = [];
305
306	// Add the "Website" field from WordPress' contact info.
307	if ( ! empty( $user_data->user_url ) ) {
308	$same_as_urls[] = $user_data->user_url;
309	}
310
311	// Add the social profiles.
312	$same_as_urls = $this->get_social_profiles( $same_as_urls, $user_id );
313
314	if ( ! empty( $same_as_urls ) ) {
315	$same_as_urls = \array_values( \array_unique( $same_as_urls ) );
316	$data['sameAs'] = $same_as_urls;
317	}
318
319	return $data;
320	}
321	}
322