wp/wp-content/plugins/wordpress-importer/readme.txt
author ymh <ymh.work@gmail.com>
Wed, 06 Nov 2013 03:21:17 +0000
changeset 0 d970ebf37754
child 7 cf61fcea0001
permissions -rw-r--r--
first import
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
=== WordPress Importer ===
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
Contributors: wordpressdotorg
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
Donate link: 
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
Tags: importer, wordpress
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
Requires at least: 3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
Tested up to: 3.6
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
Stable tag: 0.6
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
License: GPLv2 or later
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
License URI: http://www.gnu.org/licenses/gpl-2.0.html
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
Import posts, pages, comments, custom fields, categories, tags and more from a WordPress export file.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
== Description ==
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
The WordPress Importer will import the following content from a WordPress export file:
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
* Posts, pages and other custom post types
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
* Comments
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
* Custom fields and post meta
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
* Categories, tags and terms from custom taxonomies
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
* Authors
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
For further information and instructions please see the [Codex page on Importing Content](http://codex.wordpress.org/Importing_Content#WordPress)
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
== Installation ==
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
The quickest method for installing the importer is:
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
1. Visit Tools -> Import in the WordPress dashboard
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
1. Click on the WordPress link in the list of importers
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
1. Click "Install Now"
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
1. Finally click "Activate Plugin & Run Importer"
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
If you would prefer to do things manually then follow these instructions:
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
1. Upload the `wordpress-importer` folder to the `/wp-content/plugins/` directory
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
1. Activate the plugin through the 'Plugins' menu in WordPress
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
1. Go to the Tools -> Import screen, click on WordPress
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
== Changelog ==
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
= 0.6 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
* Support for WXR 1.2 and multiple CDATA sections
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
* Post aren't duplicates if their post_type's are different
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
= 0.5.2 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
* Double check that the uploaded export file exists before processing it. This prevents incorrect error messages when
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
an export file is uploaded to a server with bad permissions and WordPress 3.3 or 3.3.1 is being used.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
= 0.5 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
* Import comment meta (requires export from WordPress 3.2)
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
* Minor bugfixes and enhancements
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
= 0.4 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
* Map comment user_id where possible
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
* Import attachments from `wp:attachment_url`
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
* Upload attachments to correct directory
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
* Remap resized image URLs correctly
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
= 0.3 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
* Use an XML Parser if possible
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
* Proper import support for nav menus
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
* ... and much more, see [Trac ticket #15197](http://core.trac.wordpress.org/ticket/15197)
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
= 0.1 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
* Initial release
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
== Upgrade Notice ==
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
= 0.6 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
Support for exports from WordPress 3.4.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
= 0.5.2 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
Fix incorrect error message when the export file could not be uploaded.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
= 0.5 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
Import comment meta and other minor bugfixes and enhancements.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
= 0.4 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
Bug fixes for attachment importing and other small enhancements.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
= 0.3 =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
Upgrade for a more robust and reliable experience when importing WordPress export files, and for compatibility with WordPress 3.1.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
== Frequently Asked Questions ==
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
= Help! I'm getting out of memory errors or a blank screen. =
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
If your exported file is very large, the import script may run into your host's configured memory limit for PHP.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
A message like "Fatal error: Allowed memory size of 8388608 bytes exhausted" indicates that the script can't successfully import your XML file under the current PHP memory limit. If you have access to the php.ini file, you can manually increase the limit; if you do not (your WordPress installation is hosted on a shared server, for instance), you might have to break your exported XML file into several smaller pieces and run the import script one at a time.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
For those with shared hosting, the best alternative may be to consult hosting support to determine the safest approach for running the import. A host may be willing to temporarily lift the memory limit and/or run the process directly from their end.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
-- [WordPress Codex: Importing Content](http://codex.wordpress.org/Importing_Content#Before_Importing)
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
== Filters ==
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
The importer has a couple of filters to allow you to completely enable/block certain features:
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
* `import_allow_create_users`: return false if you only want to allow mapping to existing users
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
* `import_allow_fetch_attachments`: return false if you do not wish to allow importing and downloading of attachments
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
* `import_attachment_size_limit`: return an integer value for the maximum file size in bytes to save (default is 0, which is unlimited)
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
There are also a few actions available to hook into:
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
* `import_start`: occurs after the export file has been uploaded and author import settings have been chosen
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
* `import_end`: called after the last output from the importer