7257244093

Committed 19 Dec 2023 04:09AM UTC coverage: 49.388% (-0.002%) from 49.39%

Build # 7257244093

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #20987 from Yoast/JRF/docs/more-fixes

Docs: more fixes

Run Details

15425 of 31232 relevant lines covered (49.39%)

4.07 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.66

/src/generators/schema/person.php

<?php

namespace Yoast\WP\SEO\Generators\Schema;

use WP_User;
use Yoast\WP\SEO\Config\Schema_IDs;

/**
 * Returns schema Person data.
 */
class Person extends Abstract_Schema_Piece {

        /**
         * Array of the social profiles we display for a Person.
         *
         * @var string[]
         */
        private $social_profiles = [
                'facebook',
                'instagram',
                'linkedin',
                'pinterest',
                'twitter',
                'myspace',
                'youtube',
                'soundcloud',
                'tumblr',
                'wikipedia',
        ];

        /**
         * The Schema type we use for this class.
         *
         * @var string[]
         */
        protected $type = [ 'Person', 'Organization' ];

        /**
         * Determine whether we should return Person schema.
         *
         * @return bool
         */
        public function is_needed() {
                // Using an author piece instead.
                if ( $this->site_represents_current_author() ) {
                        return false;
                }

                return $this->context->site_represents === 'person';
        }

        /**
         * Returns Person Schema data.
         *
         * @return bool|array Person data on success, false on failure.
         */
        public function generate() {
                $user_id = $this->determine_user_id();
                if ( ! $user_id ) {
                        return false;
                }

                return $this->build_person_data( $user_id );
        }

        /**
         * Determines a User ID for the Person data.
         *
         * @return bool|int User ID or false upon return.
         */
        protected function determine_user_id() {
                /**
                 * Filter: 'wpseo_schema_person_user_id' - Allows filtering of user ID used for person output.
                 *
                 * @param int|bool $user_id The user ID currently determined.
                 */
                $user_id = \apply_filters( 'wpseo_schema_person_user_id', $this->context->site_user_id );

                // It should to be an integer higher than 0.
                if ( \is_int( $user_id ) && $user_id > 0 ) {
                        return $user_id;
                }

                return false;
        }

        /**
         * Retrieve a list of social profile URLs for Person.
         *
         * @param array $same_as_urls Array of SameAs URLs.
         * @param int   $user_id      User ID.
         *
         * @return string[] A list of SameAs URLs.
         */
        protected function get_social_profiles( $same_as_urls, $user_id ) {
                /**
                 * Filter: 'wpseo_schema_person_social_profiles' - Allows filtering of social profiles per user.
                 *
                 * @param string[] $social_profiles The array of social profiles to retrieve. Each should be a user meta field
                 *                                  key. As they are retrieved using the WordPress function `get_the_author_meta`.
                 * @param int      $user_id         The current user we're grabbing social profiles for.
                 */
                $social_profiles = \apply_filters( 'wpseo_schema_person_social_profiles', $this->social_profiles, $user_id );

                // We can only handle an array.
                if ( ! \is_array( $social_profiles ) ) {
                        return $same_as_urls;
                }

                foreach ( $social_profiles as $profile ) {
                        // Skip non-string values.
                        if ( ! \is_string( $profile ) ) {
                                continue;
                        }

                        $social_url = $this->url_social_site( $profile, $user_id );
                        if ( $social_url ) {
                                $same_as_urls[] = $social_url;
                        }
                }

                return $same_as_urls;
        }

        /**
         * Builds our array of Schema Person data for a given user ID.
         *
         * @param int  $user_id  The user ID to use.
         * @param bool $add_hash Wether or not the person's image url hash should be added to the image id.
         *
         * @return array An array of Schema Person data.
         */
        protected function build_person_data( $user_id, $add_hash = false ) {
                $user_data = \get_userdata( $user_id );
                $data      = [
                        '@type' => $this->type,
                        '@id'   => $this->helpers->schema->id->get_user_schema_id( $user_id, $this->context ),
                ];

                // Safety check for the `get_userdata` WP function, which could return false.
                if ( $user_data === false ) {
                        return $data;
                }

                $data['name'] = $this->helpers->schema->html->smart_strip_tags( $user_data->display_name );
                $data         = $this->add_image( $data, $user_data, $add_hash );

                if ( ! empty( $user_data->description ) ) {
                        $data['description'] = $this->helpers->schema->html->smart_strip_tags( $user_data->description );
                }

                $data = $this->add_same_as_urls( $data, $user_data, $user_id );

                /**
                 * Filter: 'wpseo_schema_person_data' - Allows filtering of schema data per user.
                 *
                 * @param array $data    The schema data we have for this person.
                 * @param int   $user_id The current user we're collecting schema data for.
                 */
                $data = \apply_filters( 'wpseo_schema_person_data', $data, $user_id );

                return $data;
        }

        /**
         * Returns an ImageObject for the persons avatar.
         *
         * @param array   $data      The Person schema.
         * @param WP_User $user_data User data.
         * @param bool    $add_hash  Wether or not the person's image url hash should be added to the image id.
         *
         * @return array The Person schema.
         */
        protected function add_image( $data, $user_data, $add_hash = false ) {
                $schema_id = $this->context->site_url . Schema_IDs::PERSON_LOGO_HASH;

                $data = $this->set_image_from_options( $data, $schema_id, $add_hash, $user_data );
                if ( ! isset( $data['image'] ) ) {
                        $data = $this->set_image_from_avatar( $data, $user_data, $schema_id, $add_hash );
                }

                if ( \is_array( $this->type ) && \in_array( 'Organization', $this->type, true ) ) {
                        $data_logo    = ( $data['image']['@id'] ?? $schema_id );
                        $data['logo'] = [ '@id' => $data_logo ];
                }

                return $data;
        }

        /**
         * Generate the person image from our settings.
         *
         * @param array   $data      The Person schema.
         * @param string  $schema_id The string used in the `@id` for the schema.
         * @param bool    $add_hash  Whether or not the person's image url hash should be added to the image id.
         * @param WP_User $user_data User data.
         *
         * @return array The Person schema.
         */
        protected function set_image_from_options( $data, $schema_id, $add_hash = false, $user_data = null ) {
                if ( $this->context->site_represents !== 'person' ) {
                        return $data;
                }
                if ( \is_array( $this->context->person_logo_meta ) ) {
                        $data['image'] = $this->helpers->schema->image->generate_from_attachment_meta( $schema_id, $this->context->person_logo_meta, $data['name'], $add_hash );
                }

                return $data;
        }

        /**
         * Generate the person logo from gravatar.
         *
         * @param array   $data      The Person schema.
         * @param WP_User $user_data User data.
         * @param string  $schema_id The string used in the `@id` for the schema.
         * @param bool    $add_hash  Wether or not the person's image url hash should be added to the image id.
         *
         * @return array The Person schema.
         */
        protected function set_image_from_avatar( $data, $user_data, $schema_id, $add_hash = false ) {
                // If we don't have an image in our settings, fall back to an avatar, if we're allowed to.
                $show_avatars = \get_option( 'show_avatars' );
                if ( ! $show_avatars ) {
                        return $data;
                }

                $url = \get_avatar_url( $user_data->user_email );
                if ( empty( $url ) ) {
                        return $data;
                }

                $data['image'] = $this->helpers->schema->image->simple_image_object( $schema_id, $url, $user_data->display_name, $add_hash );

                return $data;
        }

        /**
         * Returns an author's social site URL.
         *
         * @param string $social_site The social site to retrieve the URL for.
         * @param mixed  $user_id     The user ID to use function outside of the loop.
         *
         * @return string
         */
        protected function url_social_site( $social_site, $user_id = false ) {
                $url = \get_the_author_meta( $social_site, $user_id );

                if ( ! empty( $url ) && $social_site === 'twitter' ) {
                        $url = 'https://twitter.com/' . $url;
                }

                return $url;
        }

        /**
         * Checks the site is represented by the same person as this indexable.
         *
         * @param WP_User $user_data User data.
         *
         * @return bool True when the site is represented by the same person as this indexable.
         */
        protected function site_represents_current_author( $user_data = null ) {
                // Can only be the case when the site represents a user.
                if ( $this->context->site_represents !== 'person' ) {
                        return false;
                }

                // Article post from the same user as the site represents.
                if (
                        $this->context->indexable->object_type === 'post'
                        && $this->helpers->schema->article->is_author_supported( $this->context->indexable->object_sub_type )
                        && $this->context->schema_article_type !== 'None'
                ) {
                        $user_id = ( ( ! \is_null( $user_data ) ) && ( isset( $user_data->ID ) ) ) ? $user_data->ID : $this->context->indexable->author_id;

                        return $this->context->site_user_id === $user_id;
                }

                // Author archive from the same user as the site represents.
                return $this->context->indexable->object_type === 'user' && $this->context->site_user_id === $this->context->indexable->object_id;
        }

        /**
         * Builds our SameAs array.
         *
         * @param array   $data      The Person schema data.
         * @param WP_User $user_data The user data object.
         * @param int     $user_id   The user ID to use.
         *
         * @return array The Person schema data.
         */
        protected function add_same_as_urls( $data, $user_data, $user_id ) {
                $same_as_urls = [];

                // Add the "Website" field from WordPress' contact info.
                if ( ! empty( $user_data->user_url ) ) {
                        $same_as_urls[] = $user_data->user_url;
                }

                // Add the social profiles.
                $same_as_urls = $this->get_social_profiles( $same_as_urls, $user_id );

                if ( ! empty( $same_as_urls ) ) {
                        $same_as_urls   = \array_values( \array_unique( $same_as_urls ) );
                        $data['sameAs'] = $same_as_urls;
                }

                return $data;
        }
}

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() {	6✔
44	// Using an author piece instead.
45	if ( $this->site_represents_current_author() ) {	6✔
46	return false;	2✔
47	}
48
49	return $this->context->site_represents === 'person';	4✔
50	}
51
52	/**
53	* Returns Person Schema data.
54	*
55	* @return bool\|array Person data on success, false on failure.
56	*/
57	public function generate() {	20✔
58	$user_id = $this->determine_user_id();	20✔
59	if ( ! $user_id ) {	20✔
60	return false;	4✔
61	}
62
63	return $this->build_person_data( $user_id );	16✔
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() {	20✔
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 );	20✔
78
79	// It should to be an integer higher than 0.
80	if ( \is_int( $user_id ) && $user_id > 0 ) {	20✔
81	return $user_id;	16✔
82	}
83
84	return false;	4✔
85	}
86
87	/**
88	* Retrieve a list of social profile URLs for Person.
89	*
90	* @param array $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 ) {	14✔
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 );	14✔
104
105	// We can only handle an array.
106	if ( ! \is_array( $social_profiles ) ) {	14✔
107	return $same_as_urls;	2✔
108	}
109
110	foreach ( $social_profiles as $profile ) {	12✔
111	// Skip non-string values.
112	if ( ! \is_string( $profile ) ) {	6✔
113	continue;	2✔
114	}
115
116	$social_url = $this->url_social_site( $profile, $user_id );	6✔
117	if ( $social_url ) {	6✔
118	$same_as_urls[] = $social_url;	6✔
119	}
120	}
121
122	return $same_as_urls;	12✔
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 An array of Schema Person data.
132	*/
133	protected function build_person_data( $user_id, $add_hash = false ) {	16✔
134	$user_data = \get_userdata( $user_id );	16✔
135	$data = [	8✔
136	'@type' => $this->type,	16✔
137	'@id' => $this->helpers->schema->id->get_user_schema_id( $user_id, $this->context ),	16✔
138	];	8✔
139
140	// Safety check for the `get_userdata` WP function, which could return false.
141	if ( $user_data === false ) {	16✔
142	return $data;	2✔
143	}
144
145	$data['name'] = $this->helpers->schema->html->smart_strip_tags( $user_data->display_name );	14✔
146	$data = $this->add_image( $data, $user_data, $add_hash );	14✔
147
148	if ( ! empty( $user_data->description ) ) {	14✔
149	$data['description'] = $this->helpers->schema->html->smart_strip_tags( $user_data->description );	4✔
150	}
151
152	$data = $this->add_same_as_urls( $data, $user_data, $user_id );	14✔
153
154	/**
155	* Filter: 'wpseo_schema_person_data' - Allows filtering of schema data per user.
156	*
157	* @param array $data The schema data we have for this person.
158	* @param int $user_id The current user we're collecting schema data for.
159	*/
160	$data = \apply_filters( 'wpseo_schema_person_data', $data, $user_id );	14✔
161
162	return $data;	14✔
163	}
164
165	/**
166	* Returns an ImageObject for the persons avatar.
167	*
168	* @param array $data The Person schema.
169	* @param WP_User $user_data User data.
170	* @param bool $add_hash Wether or not the person's image url hash should be added to the image id.
171	*
172	* @return array The Person schema.
173	*/
174	protected function add_image( $data, $user_data, $add_hash = false ) {	14✔
175	$schema_id = $this->context->site_url . Schema_IDs::PERSON_LOGO_HASH;	14✔
176
177	$data = $this->set_image_from_options( $data, $schema_id, $add_hash, $user_data );	14✔
178	if ( ! isset( $data['image'] ) ) {	14✔
179	$data = $this->set_image_from_avatar( $data, $user_data, $schema_id, $add_hash );	10✔
180	}
181
182	if ( \is_array( $this->type ) && \in_array( 'Organization', $this->type, true ) ) {	14✔
183	$data_logo = ( $data['image']['@id'] ?? $schema_id );	14✔
184	$data['logo'] = [ '@id' => $data_logo ];	14✔
185	}
186
187	return $data;	14✔
188	}
189
190	/**
191	* Generate the person image from our settings.
192	*
193	* @param array $data The Person schema.
194	* @param string $schema_id The string used in the `@id` for the schema.
195	* @param bool $add_hash Whether or not the person's image url hash should be added to the image id.
196	* @param WP_User $user_data User data.
197	*
198	* @return array The Person schema.
199	*/
200	protected function set_image_from_options( $data, $schema_id, $add_hash = false, $user_data = null ) {	10✔
201	if ( $this->context->site_represents !== 'person' ) {	10✔
202	return $data;	6✔
203	}
204	if ( \is_array( $this->context->person_logo_meta ) ) {	4✔
205	$data['image'] = $this->helpers->schema->image->generate_from_attachment_meta( $schema_id, $this->context->person_logo_meta, $data['name'], $add_hash );	4✔
206	}
207
208	return $data;	4✔
209	}
210
211	/**
212	* Generate the person logo from gravatar.
213	*
214	* @param array $data The Person schema.
215	* @param WP_User $user_data User data.
216	* @param string $schema_id The string used in the `@id` for the schema.
217	* @param bool $add_hash Wether or not the person's image url hash should be added to the image id.
218	*
219	* @return array The Person schema.
220	*/
221	protected function set_image_from_avatar( $data, $user_data, $schema_id, $add_hash = false ) {	10✔
222	// If we don't have an image in our settings, fall back to an avatar, if we're allowed to.
223	$show_avatars = \get_option( 'show_avatars' );	10✔
224	if ( ! $show_avatars ) {	10✔
225	return $data;	6✔
226	}
227
228	$url = \get_avatar_url( $user_data->user_email );	4✔
229	if ( empty( $url ) ) {	4✔
230	return $data;	2✔
231	}
232
233	$data['image'] = $this->helpers->schema->image->simple_image_object( $schema_id, $url, $user_data->display_name, $add_hash );	2✔
234
235	return $data;	2✔
236	}
237
238	/**
239	* Returns an author's social site URL.
240	*
241	* @param string $social_site The social site to retrieve the URL for.
242	* @param mixed $user_id The user ID to use function outside of the loop.
243	*
244	* @return string
245	*/
246	protected function url_social_site( $social_site, $user_id = false ) {	6✔
247	$url = \get_the_author_meta( $social_site, $user_id );	6✔
248
249	if ( ! empty( $url ) && $social_site === 'twitter' ) {	6✔
250	$url = 'https://twitter.com/' . $url;	4✔
251	}
252
253	return $url;	6✔
254	}
255
256	/**
257	* Checks the site is represented by the same person as this indexable.
258	*
259	* @param WP_User $user_data User data.
260	*
261	* @return bool True when the site is represented by the same person as this indexable.
262	*/
263	protected function site_represents_current_author( $user_data = null ) {	6✔
264	// Can only be the case when the site represents a user.
265	if ( $this->context->site_represents !== 'person' ) {	6✔
266	return false;	2✔
267	}
268
269	// Article post from the same user as the site represents.
270	if (
271	$this->context->indexable->object_type === 'post'	4✔
272	&& $this->helpers->schema->article->is_author_supported( $this->context->indexable->object_sub_type )	4✔
273	&& $this->context->schema_article_type !== 'None'	4✔
274	) {
275	$user_id = ( ( ! \is_null( $user_data ) ) && ( isset( $user_data->ID ) ) ) ? $user_data->ID : $this->context->indexable->author_id;	2✔
276
277	return $this->context->site_user_id === $user_id;	2✔
278	}
279
280	// Author archive from the same user as the site represents.
281	return $this->context->indexable->object_type === 'user' && $this->context->site_user_id === $this->context->indexable->object_id;	2✔
282	}
283
284	/**
285	* Builds our SameAs array.
286	*
287	* @param array $data The Person schema data.
288	* @param WP_User $user_data The user data object.
289	* @param int $user_id The user ID to use.
290	*
291	* @return array The Person schema data.
292	*/
293	protected function add_same_as_urls( $data, $user_data, $user_id ) {	×
294	$same_as_urls = [];	×
295
296	// Add the "Website" field from WordPress' contact info.
297	if ( ! empty( $user_data->user_url ) ) {	×
298	$same_as_urls[] = $user_data->user_url;	×
299	}
300
301	// Add the social profiles.
302	$same_as_urls = $this->get_social_profiles( $same_as_urls, $user_id );	×
303
304	if ( ! empty( $same_as_urls ) ) {	×
305	$same_as_urls = \array_values( \array_unique( $same_as_urls ) );	×
306	$data['sameAs'] = $same_as_urls;	×
307	}
308
309	return $data;	×
310	}
311	}

Yoast / wordpress-seo / 7257244093

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous