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

98.4

/src/presentations/indexable-post-type-presentation.php

<?php

namespace Yoast\WP\SEO\Presentations;

use Yoast\WP\SEO\Helpers\Date_Helper;
use Yoast\WP\SEO\Helpers\Pagination_Helper;
use Yoast\WP\SEO\Helpers\Post_Helper;
use Yoast\WP\SEO\Helpers\Post_Type_Helper;

/**
 * Class Indexable_Post_Type_Presentation.
 *
 * Presentation object for indexables.
 */
class Indexable_Post_Type_Presentation extends Indexable_Presentation {

        /**
         * Holds the Post_Type_Helper instance.
         *
         * @var Post_Type_Helper
         */
        protected $post_type;

        /**
         * Holds the Date_Helper instance.
         *
         * @var Date_Helper
         */
        protected $date;

        /**
         * Holds the Pagination_Helper instance.
         *
         * @var Pagination_Helper
         */
        protected $pagination;

        /**
         * Holds the Post_Helper instance.
         *
         * @var Post_Helper
         */
        protected $post;

        /**
         * Indexable_Post_Type_Presentation constructor.
         *
         * @codeCoverageIgnore
         *
         * @param Post_Type_Helper  $post_type  The post type helper.
         * @param Date_Helper       $date       The date helper.
         * @param Pagination_Helper $pagination The pagination helper.
         * @param Post_Helper       $post       The post helper.
         */
        public function __construct(
                Post_Type_Helper $post_type,
                Date_Helper $date,
                Pagination_Helper $pagination,
                Post_Helper $post
        ) {
                $this->post_type  = $post_type;
                $this->date       = $date;
                $this->pagination = $pagination;
                $this->post       = $post;
        }

        /**
         * Generates the canonical.
         *
         * @return string The canonical.
         */
        public function generate_canonical() {
                if ( $this->model->canonical ) {
                        return $this->model->canonical;
                }

                $permalink = $this->permalink;

                // Fix paginated pages canonical, but only if the page is truly paginated.
                $current_page = $this->pagination->get_current_post_page_number();
                if ( $current_page > 1 ) {
                        $number_of_pages = $this->model->number_of_pages;
                        if ( $number_of_pages && $current_page <= $number_of_pages ) {
                                $permalink = $this->get_paginated_url( $permalink, $current_page );
                        }
                }

                return $this->url->ensure_absolute_url( $permalink );
        }

        /**
         * Generates the rel prev.
         *
         * @return string The rel prev value.
         */
        public function generate_rel_prev() {
                if ( $this->model->number_of_pages === null ) {
                        return '';
                }

                if ( $this->pagination->is_rel_adjacent_disabled() ) {
                        return '';
                }

                $current_page = \max( 1, $this->pagination->get_current_post_page_number() );

                // Check if there is a previous page.
                if ( $current_page < 2 ) {
                        return '';
                }

                // Check if the previous page is the first page.
                if ( $current_page === 2 ) {
                        return $this->model->permalink;
                }

                return $this->get_paginated_url( $this->model->permalink, ( $current_page - 1 ) );
        }

        /**
         * Generates the rel next.
         *
         * @return string The rel prev next.
         */
        public function generate_rel_next() {
                if ( $this->model->number_of_pages === null ) {
                        return '';
                }

                if ( $this->pagination->is_rel_adjacent_disabled() ) {
                        return '';
                }

                $current_page = \max( 1, $this->pagination->get_current_post_page_number() );
                if ( $this->model->number_of_pages <= $current_page ) {
                        return '';
                }

                return $this->get_paginated_url( $this->model->permalink, ( $current_page + 1 ) );
        }

        /**
         * Generates the open graph title.
         *
         * @return string The open graph title.
         */
        public function generate_title() {
                if ( $this->model->title ) {
                        return $this->model->title;
                }

                // Get SEO title as entered in Search appearance.
                $post_type = $this->model->object_sub_type;
                $title     = $this->options->get( 'title-' . $this->model->object_sub_type );
                if ( $title ) {
                        return $title;
                }

                // Get installation default title.
                return $this->options->get_title_default( 'title-' . $post_type );
        }

        /**
         * Generates the meta description.
         *
         * @return string The meta description.
         */
        public function generate_meta_description() {
                if ( $this->model->description ) {
                        return $this->model->description;
                }

                return $this->options->get( 'metadesc-' . $this->model->object_sub_type );
        }

        /**
         * Generates the open graph description.
         *
         * @return string The open graph description.
         */
        public function generate_open_graph_description() {
                if ( $this->model->open_graph_description ) {
                        $open_graph_description = $this->model->open_graph_description;
                }

                if ( empty( $open_graph_description ) ) {
                        // The helper applies a filter, but we don't have a default value at this stage so we pass an empty string.
                        $open_graph_description = $this->values_helper->get_open_graph_description( '', $this->model->object_type, $this->model->object_sub_type );
                }

                if ( empty( $open_graph_description ) ) {
                        $open_graph_description = $this->meta_description;
                }

                if ( empty( $open_graph_description ) ) {
                        $open_graph_description = $this->post->get_the_excerpt( $this->model->object_id );
                        $open_graph_description = $this->post->strip_shortcodes( $open_graph_description );
                }

                return $open_graph_description;
        }

        /**
         * Generates the open graph images.
         *
         * @return array The open graph images.
         */
        public function generate_open_graph_images() {
                if ( \post_password_required() ) {
                        return [];
                }

                return parent::generate_open_graph_images();
        }

        /**
         * Generates the Open Graph type.
         *
         * @return string The Open Graph type.
         */
        public function generate_open_graph_type() {
                return 'article';
        }

        /**
         * Generates the open graph article author.
         *
         * @return string The open graph article author.
         */
        public function generate_open_graph_article_author() {
                if ( $this->model->object_sub_type !== 'post' ) {
                        return '';
                }

                $post = $this->source;

                $open_graph_article_author = $this->user->get_the_author_meta( 'facebook', $post->post_author );

                if ( $open_graph_article_author ) {
                        return $open_graph_article_author;
                }

                return '';
        }

        /**
         * Generates the open graph article publisher.
         *
         * @return string The open graph article publisher.
         */
        public function generate_open_graph_article_publisher() {
                $open_graph_article_publisher = $this->context->open_graph_publisher;

                if ( $open_graph_article_publisher ) {
                        return $open_graph_article_publisher;
                }

                return '';
        }

        /**
         * Generates the open graph article published time.
         *
         * @return string The open graph article published time.
         */
        public function generate_open_graph_article_published_time() {
                if ( $this->model->object_sub_type !== 'post' ) {
                        /**
                         * Filter: 'wpseo_opengraph_show_publish_date' - Allow showing publication date for other post types.
                         *
                         * @param bool   $show      Whether or not to show publish date.
                         * @param string $post_type The current URL's post type.
                         */
                        if ( ! \apply_filters( 'wpseo_opengraph_show_publish_date', false, $this->post->get_post_type( $this->source ) ) ) {
                                return '';
                        }
                }

                return $this->date->format( $this->source->post_date_gmt );
        }

        /**
         * Generates the open graph article modified time.
         *
         * @return string The open graph article modified time.
         */
        public function generate_open_graph_article_modified_time() {
                if ( $this->source->post_modified_gmt !== $this->source->post_date_gmt ) {
                        return $this->date->format( $this->source->post_modified_gmt );
                }

                return '';
        }

        /**
         * Generates the source.
         *
         * @return array The source.
         */
        public function generate_source() {
                return \get_post( $this->model->object_id );
        }

        /**
         * Generates the robots value.
         *
         * @return array The robots value.
         */
        public function generate_robots() {
                $robots = $this->get_base_robots();
                $robots = \array_merge(
                        $robots,
                        [
                                'imageindex' => ( $this->model->is_robots_noimageindex === true ) ? 'noimageindex' : null,
                                'archive'    => ( $this->model->is_robots_noarchive === true ) ? 'noarchive' : null,
                                'snippet'    => ( $this->model->is_robots_nosnippet === true ) ? 'nosnippet' : null,
                        ]
                );

                // No snippet means max snippet can be omitted.
                if ( $this->model->is_robots_nosnippet === true ) {
                        $robots['max-snippet'] = null;
                }

                // No image index means max image preview can be omitted.
                if ( $this->model->is_robots_noimageindex === true ) {
                        $robots['max-image-preview'] = null;
                }

                // When the post specific index is not set, look to the post status and default of the post type.
                if ( $this->model->is_robots_noindex === null ) {
                        $post_status_private = \get_post_status( $this->model->object_id ) === 'private';
                        $post_type_noindex   = ! $this->post_type->is_indexable( $this->model->object_sub_type );

                        if ( $post_status_private || $post_type_noindex ) {
                                $robots['index'] = 'noindex';
                        }
                }

                return $this->filter_robots( $robots );
        }

        /**
         * Generates the Twitter description.
         *
         * @return string The Twitter description.
         */
        public function generate_twitter_description() {
                $twitter_description = parent::generate_twitter_description();

                if ( $twitter_description ) {
                        return $twitter_description;
                }

                if ( $this->open_graph_description && $this->context->open_graph_enabled === true ) {
                        return '';
                }

                return $this->post->get_the_excerpt( $this->model->object_id );
        }

        /**
         * Generates the Twitter image.
         *
         * @return string The Twitter image.
         */
        public function generate_twitter_image() {
                if ( \post_password_required() ) {
                        return '';
                }

                return parent::generate_twitter_image();
        }

        /**
         * Generates the Twitter creator.
         *
         * @return string The Twitter creator.
         */
        public function generate_twitter_creator() {
                if ( $this->model->object_sub_type !== 'post' ) {
                        return '';
                }

                $twitter_creator = \ltrim( \trim( \get_the_author_meta( 'twitter', $this->source->post_author ) ), '@' );

                /**
                 * Filter: 'wpseo_twitter_creator_account' - Allow changing the Twitter account as output in the Twitter card by Yoast SEO.
                 *
                 * @param string $twitter The twitter account name string.
                 */
                $twitter_creator = \apply_filters( 'wpseo_twitter_creator_account', $twitter_creator );

                if ( \is_string( $twitter_creator ) && $twitter_creator !== '' ) {
                        return '@' . $twitter_creator;
                }

                $site_twitter = $this->options->get( 'twitter_site', '' );
                if ( \is_string( $site_twitter ) && $site_twitter !== '' ) {
                        return '@' . $site_twitter;
                }

                return '';
        }

        /**
         * Wraps the get_paginated_url pagination helper method.
         *
         * @codeCoverageIgnore A wrapper method.
         *
         * @param string $url  The un-paginated URL of the current archive.
         * @param string $page The page number to add on to $url for the $link tag.
         *
         * @return string The paginated URL.
         */
        protected function get_paginated_url( $url, $page ) {
                return $this->pagination->get_paginated_url( $url, $page, false );
        }
}

1	<?php
2
3	namespace Yoast\WP\SEO\Presentations;
4
5	use Yoast\WP\SEO\Helpers\Date_Helper;
6	use Yoast\WP\SEO\Helpers\Pagination_Helper;
7	use Yoast\WP\SEO\Helpers\Post_Helper;
8	use Yoast\WP\SEO\Helpers\Post_Type_Helper;
9
10	/**
11	* Class Indexable_Post_Type_Presentation.
12	*
13	* Presentation object for indexables.
14	*/
15	class Indexable_Post_Type_Presentation extends Indexable_Presentation {
16
17	/**
18	* Holds the Post_Type_Helper instance.
19	*
20	* @var Post_Type_Helper
21	*/
22	protected $post_type;
23
24	/**
25	* Holds the Date_Helper instance.
26	*
27	* @var Date_Helper
28	*/
29	protected $date;
30
31	/**
32	* Holds the Pagination_Helper instance.
33	*
34	* @var Pagination_Helper
35	*/
36	protected $pagination;
37
38	/**
39	* Holds the Post_Helper instance.
40	*
41	* @var Post_Helper
42	*/
43	protected $post;
44
45	/**
46	* Indexable_Post_Type_Presentation constructor.
47	*
48	* @codeCoverageIgnore
49	*
50	* @param Post_Type_Helper $post_type The post type helper.
51	* @param Date_Helper $date The date helper.
52	* @param Pagination_Helper $pagination The pagination helper.
53	* @param Post_Helper $post The post helper.
54	*/
55	public function __construct(
56	Post_Type_Helper $post_type,
57	Date_Helper $date,
58	Pagination_Helper $pagination,
59	Post_Helper $post
60	) {
61	$this->post_type = $post_type;
62	$this->date = $date;
63	$this->pagination = $pagination;
64	$this->post = $post;
65	}
66
67	/**
68	* Generates the canonical.
69	*
70	* @return string The canonical.
71	*/
72	public function generate_canonical() {	20✔
73	if ( $this->model->canonical ) {	20✔
74	return $this->model->canonical;	4✔
75	}
76
77	$permalink = $this->permalink;	16✔
78
79	// Fix paginated pages canonical, but only if the page is truly paginated.
80	$current_page = $this->pagination->get_current_post_page_number();	16✔
81	if ( $current_page > 1 ) {	16✔
82	$number_of_pages = $this->model->number_of_pages;	8✔
83	if ( $number_of_pages && $current_page <= $number_of_pages ) {	8✔
84	$permalink = $this->get_paginated_url( $permalink, $current_page );	8✔
85	}
86	}
87
88	return $this->url->ensure_absolute_url( $permalink );	16✔
89	}
90
91	/**
92	* Generates the rel prev.
93	*
94	* @return string The rel prev value.
95	*/
96	public function generate_rel_prev() {	10✔
97	if ( $this->model->number_of_pages === null ) {	10✔
98	return '';	2✔
99	}
100
101	if ( $this->pagination->is_rel_adjacent_disabled() ) {	8✔
102	return '';	2✔
103	}
104
105	$current_page = \max( 1, $this->pagination->get_current_post_page_number() );	6✔
106
107	// Check if there is a previous page.
108	if ( $current_page < 2 ) {	6✔
109	return '';	2✔
110	}
111
112	// Check if the previous page is the first page.
113	if ( $current_page === 2 ) {	4✔
114	return $this->model->permalink;	2✔
115	}
116
117	return $this->get_paginated_url( $this->model->permalink, ( $current_page - 1 ) );	2✔
118	}
119
120	/**
121	* Generates the rel next.
122	*
123	* @return string The rel prev next.
124	*/
125	public function generate_rel_next() {	8✔
126	if ( $this->model->number_of_pages === null ) {	8✔
127	return '';	2✔
128	}
129
130	if ( $this->pagination->is_rel_adjacent_disabled() ) {	6✔
131	return '';	2✔
132	}
133
134	$current_page = \max( 1, $this->pagination->get_current_post_page_number() );	4✔
135	if ( $this->model->number_of_pages <= $current_page ) {	4✔
136	return '';	2✔
137	}
138
139	return $this->get_paginated_url( $this->model->permalink, ( $current_page + 1 ) );	2✔
140	}
141
142	/**
143	* Generates the open graph title.
144	*
145	* @return string The open graph title.
146	*/
147	public function generate_title() {	6✔
148	if ( $this->model->title ) {	6✔
149	return $this->model->title;	2✔
150	}
151
152	// Get SEO title as entered in Search appearance.
153	$post_type = $this->model->object_sub_type;	4✔
154	$title = $this->options->get( 'title-' . $this->model->object_sub_type );	4✔
155	if ( $title ) {	4✔
156	return $title;	2✔
157	}
158
159	// Get installation default title.
160	return $this->options->get_title_default( 'title-' . $post_type );	2✔
161	}
162
163	/**
164	* Generates the meta description.
165	*
166	* @return string The meta description.
167	*/
168	public function generate_meta_description() {	4✔
169	if ( $this->model->description ) {	4✔
170	return $this->model->description;	2✔
171	}
172
173	return $this->options->get( 'metadesc-' . $this->model->object_sub_type );	2✔
174	}
175
176	/**
177	* Generates the open graph description.
178	*
179	* @return string The open graph description.
180	*/
181	public function generate_open_graph_description() {	8✔
182	if ( $this->model->open_graph_description ) {	8✔
183	$open_graph_description = $this->model->open_graph_description;	2✔
184	}
185
186	if ( empty( $open_graph_description ) ) {	8✔
187	// The helper applies a filter, but we don't have a default value at this stage so we pass an empty string.
188	$open_graph_description = $this->values_helper->get_open_graph_description( '', $this->model->object_type, $this->model->object_sub_type );	6✔
189	}
190
191	if ( empty( $open_graph_description ) ) {	8✔
192	$open_graph_description = $this->meta_description;	4✔
193	}
194
195	if ( empty( $open_graph_description ) ) {	8✔
196	$open_graph_description = $this->post->get_the_excerpt( $this->model->object_id );	2✔
197	$open_graph_description = $this->post->strip_shortcodes( $open_graph_description );	2✔
198	}
199
200	return $open_graph_description;	8✔
201	}
202
203	/**
204	* Generates the open graph images.
205	*
206	* @return array The open graph images.
207	*/
208	public function generate_open_graph_images() {	4✔
209	if ( \post_password_required() ) {	4✔
210	return [];	2✔
211	}
212
213	return parent::generate_open_graph_images();	2✔
214	}
215
216	/**
217	* Generates the Open Graph type.
218	*
219	* @return string The Open Graph type.
220	*/
221	public function generate_open_graph_type() {	2✔
222	return 'article';	2✔
223	}
224
225	/**
226	* Generates the open graph article author.
227	*
228	* @return string The open graph article author.
229	*/
230	public function generate_open_graph_article_author() {	4✔
231	if ( $this->model->object_sub_type !== 'post' ) {	4✔
232	return '';	×
233	}
234
235	$post = $this->source;	4✔
236
237	$open_graph_article_author = $this->user->get_the_author_meta( 'facebook', $post->post_author );	4✔
238
239	if ( $open_graph_article_author ) {	4✔
240	return $open_graph_article_author;	2✔
241	}
242
243	return '';	2✔
244	}
245
246	/**
247	* Generates the open graph article publisher.
248	*
249	* @return string The open graph article publisher.
250	*/
251	public function generate_open_graph_article_publisher() {	4✔
252	$open_graph_article_publisher = $this->context->open_graph_publisher;	4✔
253
254	if ( $open_graph_article_publisher ) {	4✔
255	return $open_graph_article_publisher;	2✔
256	}
257
258	return '';	2✔
259	}
260
261	/**
262	* Generates the open graph article published time.
263	*
264	* @return string The open graph article published time.
265	*/
266	public function generate_open_graph_article_published_time() {	6✔
267	if ( $this->model->object_sub_type !== 'post' ) {	6✔
268	/**
269	* Filter: 'wpseo_opengraph_show_publish_date' - Allow showing publication date for other post types.
270	*
271	* @param bool $show Whether or not to show publish date.
272	* @param string $post_type The current URL's post type.
273	*/
274	if ( ! \apply_filters( 'wpseo_opengraph_show_publish_date', false, $this->post->get_post_type( $this->source ) ) ) {	4✔
275	return '';	2✔
276	}
277	}
278
279	return $this->date->format( $this->source->post_date_gmt );	4✔
280	}
281
282	/**
283	* Generates the open graph article modified time.
284	*
285	* @return string The open graph article modified time.
286	*/
287	public function generate_open_graph_article_modified_time() {	4✔
288	if ( $this->source->post_modified_gmt !== $this->source->post_date_gmt ) {	4✔
289	return $this->date->format( $this->source->post_modified_gmt );	2✔
290	}
291
292	return '';	2✔
293	}
294
295	/**
296	* Generates the source.
297	*
298	* @return array The source.
299	*/
300	public function generate_source() {	2✔
301	return \get_post( $this->model->object_id );	2✔
302	}
303
304	/**
305	* Generates the robots value.
306	*
307	* @return array The robots value.
308	*/
309	public function generate_robots() {	6✔
310	$robots = $this->get_base_robots();	6✔
311	$robots = \array_merge(	6✔
312	$robots,	6✔
313	[	3✔
314	'imageindex' => ( $this->model->is_robots_noimageindex === true ) ? 'noimageindex' : null,	6✔
315	'archive' => ( $this->model->is_robots_noarchive === true ) ? 'noarchive' : null,	6✔
316	'snippet' => ( $this->model->is_robots_nosnippet === true ) ? 'nosnippet' : null,	6✔
317	]	3✔
318	);	3✔
319
320	// No snippet means max snippet can be omitted.
321	if ( $this->model->is_robots_nosnippet === true ) {	6✔
322	$robots['max-snippet'] = null;	2✔
323	}
324
325	// No image index means max image preview can be omitted.
326	if ( $this->model->is_robots_noimageindex === true ) {	6✔
327	$robots['max-image-preview'] = null;	2✔
328	}
329
330	// When the post specific index is not set, look to the post status and default of the post type.
331	if ( $this->model->is_robots_noindex === null ) {	6✔
332	$post_status_private = \get_post_status( $this->model->object_id ) === 'private';	6✔
333	$post_type_noindex = ! $this->post_type->is_indexable( $this->model->object_sub_type );	6✔
334
335	if ( $post_status_private \|\| $post_type_noindex ) {	6✔
336	$robots['index'] = 'noindex';	4✔
337	}
338	}
339
340	return $this->filter_robots( $robots );	6✔
341	}
342
343	/**
344	* Generates the Twitter description.
345	*
346	* @return string The Twitter description.
347	*/
348	public function generate_twitter_description() {	10✔
349	$twitter_description = parent::generate_twitter_description();	10✔
350
351	if ( $twitter_description ) {	10✔
352	return $twitter_description;	2✔
353	}
354
355	if ( $this->open_graph_description && $this->context->open_graph_enabled === true ) {	8✔
356	return '';	2✔
357	}
358
359	return $this->post->get_the_excerpt( $this->model->object_id );	6✔
360	}
361
362	/**
363	* Generates the Twitter image.
364	*
365	* @return string The Twitter image.
366	*/
367	public function generate_twitter_image() {	4✔
368	if ( \post_password_required() ) {	4✔
369	return '';	2✔
370	}
371
372	return parent::generate_twitter_image();	2✔
373	}
374
375	/**
376	* Generates the Twitter creator.
377	*
378	* @return string The Twitter creator.
379	*/
380	public function generate_twitter_creator() {	8✔
381	if ( $this->model->object_sub_type !== 'post' ) {	8✔
382	return '';	×
383	}
384
385	$twitter_creator = \ltrim( \trim( \get_the_author_meta( 'twitter', $this->source->post_author ) ), '@' );	8✔
386
387	/**
388	* Filter: 'wpseo_twitter_creator_account' - Allow changing the Twitter account as output in the Twitter card by Yoast SEO.
389	*
390	* @param string $twitter The twitter account name string.
391	*/
392	$twitter_creator = \apply_filters( 'wpseo_twitter_creator_account', $twitter_creator );	8✔
393
394	if ( \is_string( $twitter_creator ) && $twitter_creator !== '' ) {	8✔
395	return '@' . $twitter_creator;	4✔
396	}
397
398	$site_twitter = $this->options->get( 'twitter_site', '' );	4✔
399	if ( \is_string( $site_twitter ) && $site_twitter !== '' ) {	4✔
400	return '@' . $site_twitter;	2✔
401	}
402
403	return '';	2✔
404	}
405
406	/**
407	* Wraps the get_paginated_url pagination helper method.
408	*
409	* @codeCoverageIgnore A wrapper method.
410	*
411	* @param string $url The un-paginated URL of the current archive.
412	* @param string $page The page number to add on to $url for the $link tag.
413	*
414	* @return string The paginated URL.
415	*/
416	protected function get_paginated_url( $url, $page ) {
417	return $this->pagination->get_paginated_url( $url, $page, false );
418	}
419	}

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