wordpress-seo / src / bulk-editor / application / posts / posts-collector-interface.php

posts-collector-interface.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 28.2, at src/bulk-editor/application/posts/posts-collector-interface.php

30 lines 836 B

Raw Download Zip

1	<?php
2
3	// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure.
4	namespace Yoast\WP\SEO\Bulk_Editor\Application\Posts;
5
6	use Yoast\WP\SEO\Bulk_Editor\Domain\Posts\Posts_Page;
7	use Yoast\WP\SEO\Bulk_Editor\Domain\Posts\Posts_Query;
8
9	/**
10	* Describes a collector that gathers a page of posts for the bulk editor.
11	*/
12	interface Posts_Collector_Interface {
13
14	/**
15	* The post statuses shown in the bulk editor.
16	*
17	* @var array<string>
18	*/
19	public const STATUSES = [ 'publish', 'draft', 'pending', 'future' ];
20
21	/**
22	* Collects a page of posts for the given query.
23	*
24	* @param Posts_Query $query The query describing the page to collect.
25	*
26	* @return Posts_Page The collected posts together with the totals for pagination.
27	*/
28	public function get_posts( Posts_Query $query ): Posts_Page;
29	}
30