wpdb::insert( string $table, array $data, string[]|string $format = null ): int|false

Inserts a row into the table.

Contents

Description
- See also
Parameters
Return
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes
- Feedback

Description

Examples:

$wpdb->insert(
    'table',
    array(
        'column1' => 'foo',
        'column2' => 'bar',
    )
);
$wpdb->insert(
    'table',
    array(
        'column1' => 'foo',
        'column2' => 1337,
    ),
    array(
        '%s',
        '%d',
    )
);

See also

wpdb::prepare()
wpdb::$field_types
wp_set_wpdb_vars()

Parameters

$table string Required: Table name.
$data array Required: Data to insert (in column => value pairs).
Both $data columns and $data values should be "raw" (neither should be SQL escaped).
Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
$format string[]|string Optional: An array of formats to be mapped to each of the value in $data.
If string, that format will be used for all of the values in $data.
A format is one of '%d', '%f', '%s' (integer, float, string).
If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.

Default: null

Return

int|false The number of rows inserted, or false on error.

Source

File: wp-includes/class-wpdb.php. View all references

public function insert( $table, $data, $format = null ) {
	return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' );
}

View on Trac View on GitHub

Uses

Uses
Uses	Description
wpdb::_insert_replace_helper() wp-includes/class-wpdb.php	Helper function for insert and replace.

Used By

Used By
Used By	Description
wp_insert_site() wp-includes/ms-site.php	Inserts a new site into the database.
add_network_option() wp-includes/option.php	Adds a new network option.
populate_network() wp-admin/includes/schema.php	Populate network settings.
wp_install_defaults() wp-admin/includes/upgrade.php	Creates the initial content for a newly-installed site.
wp_insert_link() wp-admin/includes/bookmark.php	Inserts a link into the database, or updates an existing link.
update_usermeta() wp-includes/deprecated.php	Update metadata of user.
wp_insert_term() wp-includes/taxonomy.php	Adds a new term to the database.
wp_set_object_terms() wp-includes/taxonomy.php	Creates term and taxonomy relationships.
wp_insert_user() wp-includes/user.php	Inserts a user into the database.
wp_insert_post() wp-includes/post.php	Inserts or update a post.
wpmu_log_new_registrations() wp-includes/ms-functions.php	Logs the user email, IP, and registration date of a new site.
wpmu_signup_blog() wp-includes/ms-functions.php	Records site signup information for future activation.
wpmu_signup_user() wp-includes/ms-functions.php	Records user signup information for future activation.
wp_insert_comment() wp-includes/comment.php	Inserts a comment into the database.
add_metadata() wp-includes/meta.php	Adds metadata for the specified object.

Show 10 more used by Hide more used by

Changelog

Changelog
Version	Description
2.5.0	Introduced.

User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 22You must log in to vote on the helpfulness of this note

Contributed by alordiel — 6 years ago
To get the id of the inserted object use $wpdb->insert_id;
```
global $wpdb;
$table = $wpdb->prefix.'you_table_name';
$data = array('column1' => 'data one', 'column2' => 123);
$format = array('%s','%d');
$wpdb->insert($table,$data,$format);
$my_id = $wpdb->insert_id;
```
Log in to add feedback
Skip to note 2 content

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

Contributed by geraltoftrivia — 12 months ago

Worth mentioning that wpdb::insert sanitizes your data for you, unlike $wpdb->query which requires you to sanitize your query with $wpdb->prepare.

Log in to add feedback

1

Contributed by shewa12 — 1 year ago

Insert multiple rows at once

function insert_multiple_rows( $table, $request ) {
    global $wpdb;
    $column_keys   = '';
    $column_values = '';
    $sql           = '';
    $last_key      = array_key_last( $request );
    $first_key     = array_key_first( $request );
    foreach ( $request as $k => $value ) {
        $keys = array_keys( $value );

        // Prepare column keys & values.
        foreach ( $keys as $v ) {
            $column_keys   .= sanitize_key( $v ) . ',';
            $sanitize_value = sanitize_text_field( $value[ $v ] );
            $column_values .= is_numeric( $sanitize_value ) ? $sanitize_value . ',' : "'$sanitize_value'" . ',';
        }
        // Trim trailing comma.
        $column_keys   = rtrim( $column_keys, ',' );
        $column_values = rtrim( $column_values, ',' );
        if ( $first_key === $k ) {
            $sql .= "INSERT INTO {$table} ($column_keys) VALUES ($column_values),";
        } elseif ( $last_key == $k ) {
            $sql .= "($column_values)";
        } else {
            $sql .= "($column_values),";
        }

        // Reset keys & values to avoid duplication.
        $column_keys   = '';
        $column_values = '';
    }
    return $wpdb->query( $sql );
}

// Usage
$table = 'table_name';
$data = array(
    array( 'id' => 1, 'name' => 'John' ),
    array( 'id' => 2, 'name' => 'Doe' ),
);

insert_multiple_rows( $table, $data );

-1

Contributed by MostafaNk — 5 months ago

global $wpdb;

//get my table
$tableUsers = $wpdb->prefix . 'wpdocs_users';

$name = 'mostafa';
$family = 'niakan';
$phone = '+9812345678';

$data = array( 
    'name'   => $name,
    'family' => $family,
    'phone'  => $phone,
);
$format = array( '%s', '%s', '%s', '%d' );
$stmt = $wpdb->insert( $tableUsers, $data, $format );

//get insert id
var_dump( $wpdb->insert_id );

Feedback

This will fail, as the length of $format is four, while the length of $data is three; they must match. — By crstauf — 5 months ago

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