Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Actions\Indexing;

[2] Fix | Delete

[3] Fix | Delete

use wpdb;

[4] Fix | Delete

use Yoast\WP\Lib\Model;

[5] Fix | Delete

use Yoast\WP\SEO\Helpers\Taxonomy_Helper;

[6] Fix | Delete

use Yoast\WP\SEO\Models\Indexable;

[7] Fix | Delete

use Yoast\WP\SEO\Repositories\Indexable_Repository;

[8] Fix | Delete

use Yoast\WP\SEO\Values\Indexables\Indexable_Builder_Versions;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Reindexing action for term indexables.

[12] Fix | Delete

[13] Fix | Delete

class Indexable_Term_Indexation_Action extends Abstract_Indexing_Action {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* The transient cache key.

[17] Fix | Delete

[18] Fix | Delete

public const UNINDEXED_COUNT_TRANSIENT = 'wpseo_total_unindexed_terms';

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* The transient cache key for limited counts.

[22] Fix | Delete

[23] Fix | Delete

* @var string

[24] Fix | Delete

[25] Fix | Delete

public const UNINDEXED_LIMITED_COUNT_TRANSIENT = self::UNINDEXED_COUNT_TRANSIENT . '_limited';

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* The post type helper.

[29] Fix | Delete

[30] Fix | Delete

* @var Taxonomy_Helper

[31] Fix | Delete

[32] Fix | Delete

protected $taxonomy;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* The indexable repository.

[36] Fix | Delete

[37] Fix | Delete

* @var Indexable_Repository

[38] Fix | Delete

[39] Fix | Delete

protected $repository;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* The WordPress database instance.

[43] Fix | Delete

[44] Fix | Delete

* @var wpdb

[45] Fix | Delete

[46] Fix | Delete

protected $wpdb;

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* The latest version of the Indexable term builder

[50] Fix | Delete

[51] Fix | Delete

* @var int

[52] Fix | Delete

[53] Fix | Delete

protected $version;

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Indexable_Term_Indexation_Action constructor

[57] Fix | Delete

[58] Fix | Delete

* @param Taxonomy_Helper $taxonomy The taxonomy helper.

[59] Fix | Delete

* @param Indexable_Repository $repository The indexable repository.

[60] Fix | Delete

* @param wpdb $wpdb The WordPress database instance.

[61] Fix | Delete

* @param Indexable_Builder_Versions $builder_versions The latest versions of all indexable builders.

[62] Fix | Delete

[63] Fix | Delete

public function __construct(

[64] Fix | Delete

Taxonomy_Helper $taxonomy,

[65] Fix | Delete

Indexable_Repository $repository,

[66] Fix | Delete

wpdb $wpdb,

[67] Fix | Delete

Indexable_Builder_Versions $builder_versions

[68] Fix | Delete

) {

[69] Fix | Delete

$this->taxonomy = $taxonomy;

[70] Fix | Delete

$this->repository = $repository;

[71] Fix | Delete

$this->wpdb = $wpdb;

[72] Fix | Delete

$this->version = $builder_versions->get_latest_version_for_type( 'term' );

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Creates indexables for unindexed terms.

[77] Fix | Delete

[78] Fix | Delete

* @return Indexable[] The created indexables.

[79] Fix | Delete

[80] Fix | Delete

public function index() {

[81] Fix | Delete

$query = $this->get_select_query( $this->get_limit() );

[82] Fix | Delete

[83] Fix | Delete

// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Function get_select_query returns a prepared query.

[84] Fix | Delete

$term_ids = $this->wpdb->get_col( $query );

[85] Fix | Delete

[86] Fix | Delete

$indexables = [];

[87] Fix | Delete

foreach ( $term_ids as $term_id ) {

[88] Fix | Delete

$indexables[] = $this->repository->find_by_id_and_type( (int) $term_id, 'term' );

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

if ( \count( $indexables ) > 0 ) {

[92] Fix | Delete

\delete_transient( static::UNINDEXED_COUNT_TRANSIENT );

[93] Fix | Delete

\delete_transient( static::UNINDEXED_LIMITED_COUNT_TRANSIENT );

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

return $indexables;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Returns the number of terms that will be indexed in a single indexing pass.

[101] Fix | Delete

[102] Fix | Delete

* @return int The limit.

[103] Fix | Delete

[104] Fix | Delete

public function get_limit() {

[105] Fix | Delete

/**

[106] Fix | Delete

* Filter 'wpseo_term_indexation_limit' - Allow filtering the number of terms indexed during each indexing pass.

[107] Fix | Delete

[108] Fix | Delete

* @param int $limit The maximum number of terms indexed.

[109] Fix | Delete

[110] Fix | Delete

$limit = \apply_filters( 'wpseo_term_indexation_limit', 25 );

[111] Fix | Delete

[112] Fix | Delete

if ( ! \is_int( $limit ) || $limit < 1 ) {

[113] Fix | Delete

$limit = 25;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

return $limit;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* Builds a query for counting the number of unindexed terms.

[121] Fix | Delete

[122] Fix | Delete

* @return string The prepared query string.

[123] Fix | Delete

[124] Fix | Delete

protected function get_count_query() {

[125] Fix | Delete

$indexable_table = Model::get_table_name( 'Indexable' );

[126] Fix | Delete

$taxonomy_table = $this->wpdb->term_taxonomy;

[127] Fix | Delete

$public_taxonomies = $this->taxonomy->get_indexable_taxonomies();

[128] Fix | Delete

[129] Fix | Delete

$taxonomies_placeholders = \implode( ', ', \array_fill( 0, \count( $public_taxonomies ), '%s' ) );

[130] Fix | Delete

[131] Fix | Delete

$replacements = [ $this->version ];

[132] Fix | Delete

\array_push( $replacements, ...$public_taxonomies );

[133] Fix | Delete

[134] Fix | Delete

// Warning: If this query is changed, makes sure to update the query in get_count_query as well.

[135] Fix | Delete

return $this->wpdb->prepare(

[136] Fix | Delete

[137] Fix | Delete

SELECT COUNT(term_id)

[138] Fix | Delete

FROM {$taxonomy_table} AS T

[139] Fix | Delete

LEFT JOIN $indexable_table AS I

[140] Fix | Delete

ON T.term_id = I.object_id

[141] Fix | Delete

AND I.object_type = 'term'

[142] Fix | Delete

AND I.version = %d

[143] Fix | Delete

WHERE I.object_id IS NULL

[144] Fix | Delete

AND taxonomy IN ($taxonomies_placeholders)",

[145] Fix | Delete

$replacements

[146] Fix | Delete

);

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* Builds a query for selecting the ID's of unindexed terms.

[151] Fix | Delete

[152] Fix | Delete

* @param bool $limit The maximum number of term IDs to return.

[153] Fix | Delete

[154] Fix | Delete

* @return string The prepared query string.

[155] Fix | Delete

[156] Fix | Delete

protected function get_select_query( $limit = false ) {

[157] Fix | Delete

$indexable_table = Model::get_table_name( 'Indexable' );

[158] Fix | Delete

$taxonomy_table = $this->wpdb->term_taxonomy;

[159] Fix | Delete

$public_taxonomies = $this->taxonomy->get_indexable_taxonomies();

[160] Fix | Delete

$placeholders = \implode( ', ', \array_fill( 0, \count( $public_taxonomies ), '%s' ) );

[161] Fix | Delete

[162] Fix | Delete

$replacements = [ $this->version ];

[163] Fix | Delete

\array_push( $replacements, ...$public_taxonomies );

[164] Fix | Delete

[165] Fix | Delete

$limit_query = '';

[166] Fix | Delete

if ( $limit ) {

[167] Fix | Delete

$limit_query = 'LIMIT %d';

[168] Fix | Delete

$replacements[] = $limit;

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

// Warning: If this query is changed, makes sure to update the query in get_count_query as well.

[172] Fix | Delete

return $this->wpdb->prepare(

[173] Fix | Delete

[174] Fix | Delete

SELECT term_id

[175] Fix | Delete

FROM {$taxonomy_table} AS T

[176] Fix | Delete

LEFT JOIN $indexable_table AS I

[177] Fix | Delete

ON T.term_id = I.object_id

[178] Fix | Delete

AND I.object_type = 'term'

[179] Fix | Delete

AND I.version = %d

[180] Fix | Delete

WHERE I.object_id IS NULL

[181] Fix | Delete

AND taxonomy IN ($placeholders)

[182] Fix | Delete

$limit_query",

[183] Fix | Delete

$replacements

[184] Fix | Delete

);

[185] Fix | Delete

}

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete