WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

add_clean_index()

add_clean_index( string $table, string $index ): true

In this article

Back to top

Adds an index to a specified table.

Parameters

$tablestringrequired
Database table name.
$indexstringrequired
Database table index column.

Return

true True, when done with execution.

Source

function add_clean_index( $table, $index ) {
	global $wpdb;

	drop_index( $table, $index );
	$wpdb->query( "ALTER TABLE `$table` ADD INDEX ( `$index` )" );

	return true;
}

View all references View on Trac View on GitHub

UsesDescription
drop_index()wp-admin/includes/upgrade.php

Drops a specified index from a table.

wpdb::query()wp-includes/class-wpdb.php

Performs a database query, using current database connection.

Changelog

VersionDescription
1.0.1Introduced.

User Contributed Notes

  1. Skip to note 2 content
    MakeWebBetter
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Sometimes after a table has been created in a database, we find that it is advantageous to add an index to that table to speed up queries involving this table.

    function wpdocs_mwb_make_fetch_fast()
{
    global $wpdb;
    // Add some Clean up indices
    add_clean_index( $wpdb->posts, 'post_name' );
    add_clean_index( $wpdb->categories, 'category_nicename' );
    add_clean_index( $wpdb->comments, 'comment_approved' );
    add_clean_index( $wpdb->posts, 'post_status' );
}

You must log in before being able to contribute a note or feedback.