wordpress-seo / src / actions / indexing / indexation-action-interface.php

indexation-action-interface.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 28.2, at src/actions/indexing/indexation-action-interface.php

35 lines 794 B

Raw Download Zip

1	<?php
2
3	namespace Yoast\WP\SEO\Actions\Indexing;
4
5	/**
6	* Interface definition of reindexing action for indexables.
7	*/
8	interface Indexation_Action_Interface {
9
10	/**
11	* Returns the total number of unindexed objects.
12	*
13	* @return int The total number of unindexed objects.
14	*/
15	public function get_total_unindexed();
16
17	/**
18	* Indexes a number of objects.
19	*
20	* NOTE: ALWAYS use limits, this method is intended to be called multiple times over several requests.
21	*
22	* For indexing that requires JavaScript simply return the objects that should be indexed.
23	*
24	* @return array The reindexed objects.
25	*/
26	public function index();
27
28	/**
29	* Returns the number of objects that will be indexed in a single indexing pass.
30	*
31	* @return int The limit.
32	*/
33	public function get_limit();
34	}
35