drop_index() WordPress Function

The drop_index() function is used to remove an index from a WordPress database table. It takes two arguments: the name of the table and the name of the index.

drop_index( string $table, string $index ) #

Drops a specified index from a table.


Parameters

$table

(string)(Required)Database table name.

$index

(string)(Required)Index name to drop.


Top ↑

Return

(true) True, when finished.


Top ↑

Source

File: wp-admin/includes/upgrade.php

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

	$wpdb->hide_errors();

	$wpdb->query( "ALTER TABLE `$table` DROP INDEX `$index`" );

	// Now we need to take out all the extra ones we may have created.
	for ( $i = 0; $i < 25; $i++ ) {
		$wpdb->query( "ALTER TABLE `$table` DROP INDEX `{$index}_$i`" );
	}

	$wpdb->show_errors();

	return true;
}


Top ↑

Changelog

Changelog
VersionDescription
1.0.1Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.