: str_replace(): Passing null to parameter #2 ($replace) of type array|string is deprecated in
namespace Yoast\WP\SEO\Repositories;
use Yoast\WP\SEO\Helpers\Author_Archive_Helper;
use Yoast\WP\SEO\Helpers\Post_Type_Helper;
use Yoast\WP\SEO\Helpers\Taxonomy_Helper;
* Repository containing all cleanup queries.
class Indexable_Cleanup_Repository {
* A helper for taxonomies.
* A helper for post types.
* A helper for author archives.
* @var Author_Archive_Helper
* @param Taxonomy_Helper $taxonomy A helper for taxonomies.
* @param Post_Type_Helper $post_type A helper for post types.
* @param Author_Archive_Helper $author_archive A helper for author archives.
public function __construct( Taxonomy_Helper $taxonomy, Post_Type_Helper $post_type, Author_Archive_Helper $author_archive ) {
$this->taxonomy = $taxonomy;
$this->post_type = $post_type;
$this->author_archive = $author_archive;
* Starts a query for this repository.
public function query() {
return Model::of_type( 'Indexable' );
* Deletes rows from the indexable table depending on the object_type and object_sub_type.
* @param string $object_type The object type to query.
* @param string $object_sub_type The object subtype to query.
* @param int $limit The limit we'll apply to the delete query.
* @return int|bool The number of rows that was deleted or false if the query failed.
public function clean_indexables_with_object_type_and_object_sub_type( string $object_type, string $object_sub_type, int $limit ) {
$indexable_table = Model::get_table_name( 'Indexable' );
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
$sql = $wpdb->prepare( "DELETE FROM $indexable_table WHERE object_type = %s AND object_sub_type = %s ORDER BY id LIMIT %d", $object_type, $object_sub_type, $limit );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->query( $sql );
* Counts amount of indexables by object type and object sub type.
* @param string $object_type The object type to check.
* @param string $object_sub_type The object sub type to check.
public function count_indexables_with_object_type_and_object_sub_type( string $object_type, string $object_sub_type ) {
->where( 'object_type', $object_type )
->where( 'object_sub_type', $object_sub_type )
* Deletes rows from the indexable table depending on the post_status.
* @param string $post_status The post status to query.
* @param int $limit The limit we'll apply to the delete query.
* @return int|bool The number of rows that was deleted or false if the query failed.
public function clean_indexables_with_post_status( $post_status, $limit ) {
$indexable_table = Model::get_table_name( 'Indexable' );
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
$sql = $wpdb->prepare( "DELETE FROM $indexable_table WHERE object_type = 'post' AND post_status = %s ORDER BY id LIMIT %d", $post_status, $limit );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->query( $sql );
* Counts indexables with a certain post status.
* @param string $post_status The post status to count.
public function count_indexables_with_post_status( string $post_status ) {
->where( 'object_type', 'post' )
->where( 'post_status', $post_status )
* Cleans up any indexables that belong to post types that are not/no longer publicly viewable.
* @param int $limit The limit we'll apply to the queries.
* @return bool|int The number of deleted rows, false if the query fails.
public function clean_indexables_for_non_publicly_viewable_post( $limit ) {
$indexable_table = Model::get_table_name( 'Indexable' );
$included_post_types = $this->post_type->get_indexable_post_types();
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
if ( empty( $included_post_types ) ) {
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'post'
AND object_sub_type IS NOT NULL
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'post'
AND object_sub_type IS NOT NULL
AND object_sub_type NOT IN ( " . \implode( ', ', \array_fill( 0, \count( $included_post_types ), '%s' ) ) . ' )
\array_merge( $included_post_types, [ $limit ] )
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
* Counts all indexables for non public post types.
public function count_indexables_for_non_publicly_viewable_post() {
$included_post_types = $this->post_type->get_indexable_post_types();
if ( empty( $included_post_types ) ) {
->where( 'object_type', 'post' )
->where_not_equal( 'object_sub_type', 'null' )
->where( 'object_type', 'post' )
->where_not_equal( 'object_sub_type', 'null' )
->where_not_in( 'object_sub_type', $included_post_types )
* Cleans up any indexables that belong to taxonomies that are not/no longer publicly viewable.
* @param int $limit The limit we'll apply to the queries.
* @return bool|int The number of deleted rows, false if the query fails.
public function clean_indexables_for_non_publicly_viewable_taxonomies( $limit ) {
$indexable_table = Model::get_table_name( 'Indexable' );
$included_taxonomies = $this->taxonomy->get_indexable_taxonomies();
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
if ( empty( $included_taxonomies ) ) {
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'term'
AND object_sub_type IS NOT NULL
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'term'
AND object_sub_type IS NOT NULL
AND object_sub_type NOT IN ( " . \implode( ', ', \array_fill( 0, \count( $included_taxonomies ), '%s' ) ) . ' )
\array_merge( $included_taxonomies, [ $limit ] )
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
* Cleans up any indexables that belong to post type archive page that are not/no longer publicly viewable.
* @param int $limit The limit we'll apply to the queries.
* @return bool|int The number of deleted rows, false if the query fails.
public function clean_indexables_for_non_publicly_viewable_post_type_archive_pages( $limit ) {
$indexable_table = Model::get_table_name( 'Indexable' );
$included_post_types = $this->post_type->get_indexable_post_archives();
foreach ( $included_post_types as $post_type ) {
$post_archives[] = $post_type->name;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
if ( empty( $post_archives ) ) {
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'post-type-archive'
AND object_sub_type IS NOT NULL
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'post-type-archive'
AND object_sub_type IS NOT NULL
AND object_sub_type NOT IN ( " . \implode( ', ', \array_fill( 0, \count( $post_archives ), '%s' ) ) . ' )
\array_merge( $post_archives, [ $limit ] )
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
* Counts indexables for non publicly viewable taxonomies.
public function count_indexables_for_non_publicly_viewable_taxonomies() {
$included_taxonomies = $this->taxonomy->get_indexable_taxonomies();
if ( empty( $included_taxonomies ) ) {
->where( 'object_type', 'term' )
->where_not_equal( 'object_sub_type', 'null' )
->where( 'object_type', 'term' )
->where_not_equal( 'object_sub_type', 'null' )
->where_not_in( 'object_sub_type', $included_taxonomies )
* Counts indexables for non publicly viewable taxonomies.
public function count_indexables_for_non_publicly_post_type_archive_pages() {
$included_post_types = $this->post_type->get_indexable_post_archives();
foreach ( $included_post_types as $post_type ) {
$post_archives[] = $post_type->name;
if ( empty( $post_archives ) ) {
->where( 'object_type', 'post-type-archive' )
->where_not_equal( 'object_sub_type', 'null' )
->where( 'object_type', 'post-type-archive' )
->where_not_equal( 'object_sub_type', 'null' )
->where_not_in( 'object_sub_type', $post_archives )
* Cleans up any user indexables when the author archives have been disabled.
* @param int $limit The limit we'll apply to the queries.
* @return bool|int The number of deleted rows, false if the query fails.
public function clean_indexables_for_authors_archive_disabled( $limit ) {
if ( ! $this->author_archive->are_disabled() ) {
$indexable_table = Model::get_table_name( 'Indexable' );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
$delete_query = $wpdb->prepare( "DELETE FROM $indexable_table WHERE object_type = 'user' LIMIT %d", $limit );
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
* Counts the amount of author archive indexables if they are not disabled.
public function count_indexables_for_authors_archive_disabled() {
if ( ! $this->author_archive->are_disabled() ) {
->where( 'object_type', 'user' )
* Cleans up any indexables that belong to users that have their author archives disabled.
* @param int $limit The limit we'll apply to the queries.
* @return bool|int The number of deleted rows, false if the query fails.
public function clean_indexables_for_authors_without_archive( $limit ) {
$indexable_table = Model::get_table_name( 'Indexable' );
$author_archive_post_types = $this->author_archive->get_author_archive_post_types();
$viewable_post_stati = \array_filter( \get_post_stati(), 'is_post_status_viewable' );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'user'
SELECT DISTINCT post_author
WHERE post_type IN ( " . \implode( ', ', \array_fill( 0, \count( $author_archive_post_types ), '%s' ) ) . ' )
AND post_status IN ( ' . \implode( ', ', \array_fill( 0, \count( $viewable_post_stati ), '%s' ) ) . ' )
\array_merge( $author_archive_post_types, $viewable_post_stati, [ $limit ] )
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
* Counts total amount of indexables for authors without archives.
* @return bool|int|mysqli_result|resource|null
public function count_indexables_for_authors_without_archive() {
$indexable_table = Model::get_table_name( 'Indexable' );
$author_archive_post_types = $this->author_archive->get_author_archive_post_types();
$viewable_post_stati = \array_filter( \get_post_stati(), 'is_post_status_viewable' );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$count_query = $wpdb->prepare(
"SELECT count(*) FROM $indexable_table
WHERE object_type = 'user'
SELECT DISTINCT post_author
WHERE post_type IN ( " . \implode( ', ', \array_fill( 0, \count( $author_archive_post_types ), '%s' ) ) . ' )
AND post_status IN ( ' . \implode( ', ', \array_fill( 0, \count( $viewable_post_stati ), '%s' ) ) . ' )
\array_merge( $author_archive_post_types, $viewable_post_stati )
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->get_col( $count_query )[0];
* Deletes rows from the indexable table where the source is no longer there.
* @param string $source_table The source table which we need to check the indexables against.
* @param string $source_identifier The identifier which the indexables are matched to.
* @param string $object_type The indexable object type.
* @param int $limit The limit we'll apply to the delete query.
* @return int|bool The number of rows that was deleted or false if the query failed.
public function clean_indexables_for_object_type_and_source_table( $source_table, $source_identifier, $object_type, $limit ) {
$indexable_table = Model::get_table_name( 'Indexable' );
$source_table = $wpdb->prefix . $source_table;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
SELECT indexable_table.object_id
FROM {$indexable_table} indexable_table
LEFT JOIN {$source_table} AS source_table
ON indexable_table.object_id = source_table.{$source_identifier}
WHERE source_table.{$source_identifier} IS NULL
AND indexable_table.object_id IS NOT NULL
AND indexable_table.object_type = '{$object_type}'
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
$orphans = $wpdb->get_col( $query );
if ( empty( $orphans ) ) {
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->query( "DELETE FROM $indexable_table WHERE object_type = '{$object_type}' AND object_id IN( " . \implode( ',', $orphans ) . ' )' );
* Deletes rows from the indexable table where the source is no longer there.
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
