Really Simple CSV Importer (WordPress-Plugin) - Polylang, Custom Post Type and Custom Taxonomy support and more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
André b10389381e „README.md“ ändern 8 months ago
languages allow fallback to post if no post_type set 3 years ago
sample Fix #35 6 years ago
LICENSE Update LICENSE 8 years ago
README.md „README.md“ ändern 8 months ago
class-rs_csv_helper.php why not use php functions directly? 1 year ago
class-rscsv_import_post_helper.php allow supplying the thumbnail id 1 year ago
index.php Create index.php 8 years ago
rs-csv-importer.php update authors and version 8 months ago

README.md

Really Simple CSV Importer (for WordPress)

With basic multilang support via Polylang

Description

Alternative CSV Importer plugin for WordPress. Simple and powerful, best for geeks.

You can get example CSV files in /wp-content/plugins/really-simple-csv-importer/sample directory.

Available column names and values:

  • ID or post_id: (int) post id. This value is not required. The post ID is already exists in your blog, importer will update that post data. If the ID is not exists, importer will trying to create a new post with suggested ID.
  • post_author: (login or ID) The user name or user ID number of the author.
  • post_author_login: The user name of the author.
  • post_date: (string) The time of publish date.
  • post_content: (string) The full text of the post.
  • post_title: (string) The title of the post.
  • post_excerpt: (string) For all your post excerpt needs.
  • post_status: ('draft' or 'publish' or 'pending' or 'future' or 'private' or custom registered status) The status of the post. 'draft' is default.
  • post_password: (string) The password to protect the post. The password is limited to 20 characters.
  • post_name: (string) The slug of the post.
  • post_parent: (int) The post parent id. Used for page or hierarchical post type.
  • menu_order: (int)
  • post_type: ('post' or 'page' or any other post type name) (required) The post type slug, not labels.
  • post_thumbnail: (string) The uri or path of the post thumbnail. E.g. http://example.com/example.jpg or /path/to/example.jpg
  • post_category: (string, comma separated) slug of post categories
  • post_tags: (string, comma separated) name of post tags
  • tax_{taxonomy}: (string, comma separated) Any field prefixed with tax_ will be used as a custom taxonomy. Taxonomy must already exist. Entries are names or slugs of terms.
  • {custom_field_key}: (string) Any other column labels used as custom field
  • cfs_{field_name}: (string) If you would like to import data to custom fields set by Custom Field Suite, please add prefix cfs_ to column header name.
  • scf_{field_name}: (string) If you would like to import data to custom fields set by Smart Custom Fields, please add prefix scf_ to column header name.
  • comment_status: ('closed' or 'open') Default is the option 'default_comment_status', or 'closed'.
  • pll_id: (int) Unique ID of a post and all its translations, so that they can be mapped together during the import.
  • pll_language: (string) Language slug of the current importet post, for example en or de.

Note: Empty cells in the csv file means "keep it", not "delete it". Note: To set the page template of a page, use custom field key of _wp_page_template. Note: If providing a post_status of 'future' you must specify the post_date in order for WordPress to know when to publish your post. Note: If the post_type value is attachment, you can use post_thumbnail field to define media URL or path.

Advanced Custom Fields plugin integrate

If advanced custom field key is exists, importer will trying to use update_field function instead of built-in add_post_meta function. How to find advanced custom field key: Finding the field key

Forked from

Add star and read future issues about rs-csv-importer on GitHub!

Thanks

Cover banner designed by @luchino__

Installation

  1. Upload All files to the /wp-content/plugins/ directory.
  2. Activate the plugin through the 'Plugins' menu in WordPress.
  3. Go to the Import page under Tools menu.
  4. Click CSV link, read the notification, then just upload and import.

Frequently Asked Questions

Should I fill all columns of post data?

No. Only columns which you want to update.

Can I update existing post data?

Yes. Please use ID field to specify the existing post.

Can I insert post with specific post id?

Yes. Please use ID field to specify the new post ID.

Can I import custom field/custom taxonomy of the post?

Yes. You can use column names same as wp_post table, but if the column name does not match, it creates a custom field (post meta) data. Importing custom taxonomy is a bit more complicated, "tax_{taxonomy}" means, "tax_" is prefix, and {taxonomy} is name of custom taxonomy (not labels).

Here is an example.

csv file "post_title","released","tax_actors" "Captain Phillips","2013","Tom Hanks, Barkhad Abdi, Barkhad Abdirahman"

imported post data Post Title: Captain Phillips Custom field "released": 2013 Custom taxonomy "Actors": Tom Hanks, Barkhad Abdi, Barkhad Abdirahman

Why should I quote text cells when I save csv file?

Because PHP cannot read multibyte text cells in some cases.

Locale setting is taken into account by this function. If LANG is e.g. en_US.UTF-8, files in one-byte encoding are read wrong by this function.

Can I insert multiple values to CFS or ACF fields like Select or Checkbox?

Yes. Please create additional plugin and use really_simple_csv_importer_save_meta filter to make array data.

Add-on development example

Can I import multiple files as attachments into a post?

Here is an example, assuming you have a field called cf47rs_images, format the csv cell data as,

http://localhost/websitename/photos/photo12345-1.jpg|http://localhost/websitename/photos/photo12345-2.jpg|http://localhost/websitename/photos/photo12345-3.jpg

or some other urls of files you want to import, and then use the really_simple_csv_importer_save_meta filter to hook into the import process,

`add_filter( 'really_simple_csv_importer_save_meta', 'rsc_import_images',10,3); function rsc_import_images( $meta, $post, $is_update ) { //convert to an array $images = explode("|",$meta['cf47rs_images']); $meta['cf47rs_images']=array();//reset the meta field

//directory to import images to $artDir = 'wp-content/uploads/imported_cf47rs_images/';

//if the directory doesn't exist, create it if(!file_exists(ABSPATH.$artDir)) { mkdir(ABSPATH.$artDir); }

require_once(ABSPATH . 'wp-load.php'); require_once(ABSPATH . 'wp-admin/includes/image.php'); global $wpdb;

//loop through each photos that need to be imported foreach($images as $file_url){ //let's get the image file name $new_filename = array_pop(explode("/", $file_url));

//move the file to our custom import folder
if (@fclose(@fopen($file_url, "r"))) { //make sure the file actually exists
  $siteurl = get_option('siteurl');
  $skip_attachment_insert=false;
  //check if this image has already been imported,
  if(file_exists(ABSPATH.$artDir.$new_filename) ){ //file already imported
    //either change the name of the file  UNCOMMENT the following line
    //$new_filename = date("Y-m-d H:i:s").$new_filename;

    //.... or overwrite it, COMMENT OUT the next 3 lines of code if you choose to uncomment the renaming of file name.
    //in which case we want to find the attachment ID and store it in our meta field
    $attach_id = attachment_url_to_postid($siteurl.'/'.$artDir.$new_filename);
    $meta['cf47rs_images'][$attach_id] = $siteurl.'/'.$artDir.$new_filename;
    //no need to insert a new attachment, we reuse the same
    $skip_attachment_insert=true;
  }
  //(over)write the new file
  copy($file_url, ABSPATH.$artDir.$new_filename);

  if($skip_attachment_insert) continue;

  $file_info = getimagesize(ABSPATH.$artDir.$new_filename);

  //create an array of attachment data to insert into wp_posts table
  $artdata = array(
    'post_author' => 1,
    'post_date' => current_time('mysql'),
    'post_date_gmt' => current_time('mysql'),
    'post_title' => $new_filename,
    'post_status' => 'inherit',
    'comment_status' => 'closed',
    'ping_status' => 'closed',
    'post_name' => sanitize_title_with_dashes(str_replace("_", "-", $new_filename)),
    'post_modified' => current_time('mysql'),
    'post_modified_gmt' => current_time('mysql'),
    'post_type' => 'attachment',
    'guid' => $siteurl.'/'.$artDir.$new_filename,
    'post_mime_type' => $file_info['mime']
  );

  $uploads = wp_upload_dir();
  $save_path = $uploads['basedir'].'/imported_cf47rs_images/'.$new_filename;

  //insert the database record
  $attach_id = wp_insert_attachment( $artdata, $save_path );

  $meta['cf47rs_images'][$attach_id] = $siteurl.'/'.$artDir.$new_filename;
  //generate metadata and thumbnails, comment this out if you don't want thumbnails
  if ($attach_data = wp_generate_attachment_metadata( $attach_id, $save_path)) {
    wp_update_attachment_metadata($attach_id, $attach_data);
  }
}

}

return $meta; } `

How to debug import data

Really Simple CSV Importer Debugger add-on enables you to dry-run-testing and show more detailed post, meta, taxonomy data of each csv row. Download from gist.

How to customize import post data

There are three filters available in the importer.

really_simple_csv_importer_save_post

This filter is applied to post data.

Parameters:

  • $post - (array)(required) post data
  • $is_update - (bool) update existing post data, or insert new post data

Example:

` function really_simple_csv_importer_save_post_filter( $post, $is_update ) {

// remove specific tag from import data
if (isset($post['post_tags'])) {
	$_tags = array();
	foreach ($post['post_tags'] as $tag) {
        if ($tag != 'Apple') {
            $_tags[] = $tag;
        }
	}
	$post['post_tags'] = $_tags;
}

return $post;

} add_filter( 'really_simple_csv_importer_save_post', 'really_simple_csv_importer_save_post_filter', 10, 2 ); `

really_simple_csv_importer_save_meta

This filter is applied to post meta data.

Parameters:

  • $meta - (array)(required) post meta data
  • $post - (array) post data
  • $is_update - (bool)

Example:

` function really_simple_csv_importer_save_meta_filter( $meta, $post, $is_update ) {

// serialize metadata
$meta_array = array();
if (isset($meta['meta_key_1'])) $meta_array[] = $meta['meta_key_1'];
if (isset($meta['meta_key_2'])) $meta_array[] = $meta['meta_key_2'];
$meta = array( 'meta_key' => $meta_array );

return $meta;

} add_filter( 'really_simple_csv_importer_save_meta', 'really_simple_csv_importer_save_meta_filter', 10, 3 ); `

really_simple_csv_importer_save_tax

This filter is applied to post taxonomy data (categories and tags are not included, these are post data).

Parameters:

  • $tax - (array)(required) post taxonomy data
  • $post - (array) post data
  • $is_update - (bool)

Example:

` function really_simple_csv_importer_save_tax_filter( $tax, $post, $is_update ) {

// Fix misspelled taxonomy
if (isset($tax['actors'])) {
	$_actors = array();
	foreach ($tax['actors'] as $actor) {
        if ($actor == 'Johnny Dep') {
            $actor = 'Johnny Depp';
        }
        $_actors[] = $actor;
	}
	$tax['actors'] = $_actors;
}

return $tax;

} add_filter( 'really_simple_csv_importer_save_tax', 'really_simple_csv_importer_save_tax_filter', 10, 3 ); `

really_simple_csv_importer_save_thumbnail

This filter is applied to thumbnail data.

Parameters:

  • $post_thumbnail - (string)(required) the thumbnail file path or distant URL
  • $post - (array) post data
  • $is_update - (bool)

Example:

` function really_simple_csv_importer_save_thumbnail_filter( $post_thumbnail, $post, $is_update ) {

// Import a local file from an FTP directory
if (!empty($post_thumbnail) && file_exists($post_thumbnail)) {
	$upload_dir   = wp_upload_dir();
	$target_path  = $upload_dir['path'] . DIRECTORY_SEPARATOR . basename($post_thumbnail);
	if (copy($post_thumbnail, $target_path)) {
        $post_thumbnail = $target_path;
	}
}

return $post_thumbnail;

} add_filter( 'really_simple_csv_importer_save_thumbnail', 'really_simple_csv_importer_save_thumbnail_filter', 10, 3 ); `

How to customize the post data after importing to database

really_simple_csv_importer_post_saved

This action provides availability to run some tasks after importing.

Example: Download image from remote url to custom field (Download from gist)

How to customize the importing process entirely

really_simple_csv_importer_class

This filter provides availability to completely replace the RS_CSV_Importer#save_post method.

Example: Update row based on a custom field ID/key match (Download from gist)

Changelog

1.7

  • Add support for multilang imports (Polylang)

1.3

  • Some Enhancements (Thanks @piwi!)
    • Attachment support
    • Add "really_simple_csv_importer_save_thumbnail" Filter
    • French translations
  • Support post date GMT
  • Support post password

1.2

  • Enhancement: Smart Custom Fields support
  • Check if the provided post status is already registered

1.1

  • Enhancement: Support localization
  • Bug fixes

1.0

  • Enhancement: Replace a helper class to more better one
  • Enhancement: Add action hook
  • Bug fixes

0.6.3

  • Enhancement: Remove Byte Order Mark automatically (Thanks lucianosantana!)

0.6.2

  • Fix error on PHP 5.2

0.6.1

  • Bug fix: enables to import "0" value

0.6

  • Enhancement: Custom Field Suite support
  • Enhancement: Add ability to override save_post method
  • Performance Improvements

0.5.7 =

  • Enhancement: Add dry run filter

0.5.6 =

  • Bug fix: Fails to update empty custom field value.

0.5.5 =

  • Bug fix: Fix to enable to update post meta values.

0.5.4 =

  • Enhancement: Check the post type is already exists.
  • Update readme

0.5.2

  • New feature: Add Post Thumbnail support
  • Bug fixes

0.5.1

  • Enhancement: Check whether both posts has same post type when updating.

0.5

  • New feature: Added filter hooks to customize import data

0.4.2

  • Post title bug fix

0.4.1

  • Version fix

0.4

  • New feature: Added custom taxonomy support. (Thanks chuckhendo!)

0.3

  • New feature: Advanced Custom Fields integrate.
  • Enhancement: Use post_id if not already present when inserting post.

0.2

  • New feature: Add post_id column. It enables to update post data.
  • Some bug fixes

0.1.1

  • Bug fix

0.1

  • First Release (beta)