JetEngine: Import CSV Data into Custom Content Types (CCTs)

<?php
/**
 * BoostMyCroco: import a CSV file into a JetEngine Custom Content Type (CCT).
 *
 * Usage: place [bmc_cct_csv_import] on a private page.
 * Only logged-in users with the capability below see and can use the form.
 */

function bmc_cct_import_config() {
    return array(
        'slug'       => 'cliente_cct',    // CCT slug.
        'capability' => 'manage_options', // Who may import.
        'max_bytes'  => 2 * MB_IN_BYTES,  // Max upload size.
        'max_rows'   => 2000,             // Max data rows per upload.
        'delimiter'  => ',',              // Use ';' for semicolon-separated files.
    );
}

add_shortcode( 'bmc_cct_csv_import', 'bmc_cct_csv_import_shortcode' );

function bmc_cct_csv_import_shortcode() {
    $config = bmc_cct_import_config();

    if ( ! is_user_logged_in() || ! current_user_can( $config['capability'] ) ) {
        return '';
    }

    $report = '';
    if ( isset( $_POST['bmc_cct_import_submit'] ) ) {
        $report = bmc_cct_csv_handle_upload( $config );
    }

    ob_start();
    echo $report; // Already escaped in bmc_cct_notice().
    ?>
    <form method="post" enctype="multipart/form-data">
        <?php wp_nonce_field( 'bmc_cct_csv_import', 'bmc_cct_import_nonce' ); ?>
        <p>
            <label for="bmc_cct_csv">CSV file (columns: name, email)</label><br>
            <input type="file" id="bmc_cct_csv" name="bmc_cct_csv" accept=".csv,text/csv" required>
        </p>
        <p><button type="submit" name="bmc_cct_import_submit" value="1">Import CSV</button></p>
    </form>
    <?php
    return ob_get_clean();
}

function bmc_cct_notice( $message, $details = array() ) {
    $html = '<div class="bmc-cct-import-report"><p>' . esc_html( $message ) . '</p>';
    if ( ! empty( $details ) ) {
        $html .= '<ul>';
        foreach ( $details as $detail ) {
            $html .= '<li>' . esc_html( $detail ) . '</li>';
        }
        $html .= '</ul>';
    }
    return $html . '</div>';
}

function bmc_cct_clean_header( $value ) {
    $value = str_replace( "\xEF\xBB\xBF", '', (string) $value ); // Remove UTF-8 BOM added by Excel.
    return strtolower( trim( $value ) );
}

function bmc_cct_csv_handle_upload( $config ) {
    // 1. Nonce check.
    $nonce = isset( $_POST['bmc_cct_import_nonce'] ) ? sanitize_text_field( wp_unslash( $_POST['bmc_cct_import_nonce'] ) ) : '';
    if ( ! wp_verify_nonce( $nonce, 'bmc_cct_csv_import' ) ) {
        return bmc_cct_notice( 'Security check failed. Reload the page and try again.' );
    }

    // 2. JetEngine and the CCT module must be active.
    if ( ! function_exists( 'jet_engine' ) || ! jet_engine()->modules->is_module_active( 'custom-content-types' ) ) {
        return bmc_cct_notice( 'JetEngine or its Custom Content Types module is not active.' );
    }

    // CCTs are registered on init (priority 12). A shortcode renders much later, so this is safe.
    $type = \Jet_Engine\Modules\Custom_Content_Types\Module::instance()->manager->get_content_types( $config['slug'] );
    if ( ! $type ) {
        return bmc_cct_notice( 'CCT not found. Check the slug in bmc_cct_import_config().' );
    }

    // 3. File checks.
    if ( empty( $_FILES['bmc_cct_csv'] ) || UPLOAD_ERR_OK !== (int) $_FILES['bmc_cct_csv']['error'] ) {
        return bmc_cct_notice( 'No file uploaded, or the upload failed.' );
    }

    $file = $_FILES['bmc_cct_csv'];

    if ( (int) $file['size'] > $config['max_bytes'] ) {
        return bmc_cct_notice( 'The file is too large.' );
    }

    $filetype = wp_check_filetype( $file['name'], array( 'csv' => 'text/csv' ) );
    if ( 'csv' !== $filetype['ext'] || ! is_uploaded_file( $file['tmp_name'] ) ) {
        return bmc_cct_notice( 'Please upload a .csv file.' );
    }

    $handle = fopen( $file['tmp_name'], 'r' );
    if ( ! $handle ) {
        return bmc_cct_notice( 'Could not read the file.' );
    }

    // 4. Read the header row and find the columns by name.
    $delimiter = $config['delimiter'];
    $header    = fgetcsv( $handle, 0, $delimiter, '"', '\\' );
    $header    = is_array( $header ) ? array_map( 'bmc_cct_clean_header', $header ) : array();
    $name_col  = array_search( 'name', $header, true );
    $email_col = array_search( 'email', $header, true );

    if ( false === $name_col || false === $email_col ) {
        fclose( $handle );
        return bmc_cct_notice( 'The first row must contain the column names: name, email.' );
    }

    // Stop if the CCT is missing a field. An unknown field is silently dropped from the
    // lookup query, which would then match (and overwrite) the newest item.
    $fields = $type->get_formatted_fields();
    if ( ! isset( $fields['name'], $fields['email'] ) ) {
        fclose( $handle );
        return bmc_cct_notice( 'The CCT needs fields with the Name/IDs "name" and "email".' );
    }

    $handler = $type->get_item_handler();
    $type->db->set_format_flag( ARRAY_A ); // Query results as associative arrays.

    $created = 0;
    $updated = 0;
    $skipped = 0;
    $rows    = 0;
    $line    = 1;
    $notes   = array();

    // 5. Validate and save each row.
    while ( false !== ( $row = fgetcsv( $handle, 0, $delimiter, '"', '\\' ) ) ) {
        $line++;

        if ( array( null ) === $row ) {
            continue; // Blank line.
        }

        if ( ++$rows > $config['max_rows'] ) {
            $notes[] = sprintf( 'Stopped at line %d: limit of %d rows reached.', $line, $config['max_rows'] );
            break;
        }

        $name  = sanitize_text_field( isset( $row[ $name_col ] ) ? $row[ $name_col ] : '' );
        $email = sanitize_email( isset( $row[ $email_col ] ) ? $row[ $email_col ] : '' );

        if ( '' === $name ) {
            $skipped++;
            $notes[] = sprintf( 'Line %d skipped: name is empty.', $line );
            continue;
        }

        if ( ! is_email( $email ) ) {
            $skipped++;
            $notes[] = sprintf( 'Line %d skipped: invalid email.', $line );
            continue;
        }

        // Keys must match the CCT field Name/IDs.
        $item = array(
            'name'  => $name,
            'email' => $email,
        );

        // Upsert: update the existing item with this email instead of creating a duplicate.
        $args = $type->prepare_query_args(
            array(
                array(
                    'field'    => 'email',
                    'operator' => '=',
                    'value'    => $email,
                ),
            )
        );
        $existing = $type->db->query( $args, 1, 0, array(), 'AND' );

        if ( ! empty( $existing ) ) {
            $first = reset( $existing );
            if ( ! empty( $first['_ID'] ) ) {
                $item['_ID'] = absint( $first['_ID'] );
            }
        }

        // No _ID = create a new item. With _ID = update that item.
        $result = $handler->update_item( $item );

        if ( ! $result || is_wp_error( $result ) ) {
            $skipped++;
            $notes[] = sprintf(
                'Line %d skipped: could not be saved%s.',
                $line,
                is_wp_error( $result ) ? ' (' . $result->get_error_message() . ')' : ''
            );
        } elseif ( isset( $item['_ID'] ) ) {
            $updated++;
        } else {
            $created++;
        }
    }

    fclose( $handle );

    return bmc_cct_notice(
        sprintf( 'Import finished: %d created, %d updated, %d skipped.', $created, $updated, $skipped ),
        $notes
    );
}