README
¶
WordPress XML Parser
Overview
The go-wordpressxml package provides a WordPress WXR (WordPress eXtended RSS) XML parser.
Features
- Parse WordPress XML export files
- Extract post metadata (authors, dates, categories, comments)
- Convert WordPress exports to Hugo static site format
- Export article metadata to CSV
- Export articles to HTML
Documentation
Documentation is available on pkg.go.dev.
Installation
Installing any of the packages will install the entire library. For example:
$ go get github.com/grokify/go-wordpressxml
Usage
Parse WordPress XML and Export to CSV
import (
"github.com/grokify/go-wordpressxml"
)
func main() {
wp := wordpressxml.NewWordPressXML()
err := wp.ReadFile("myblog.wordpress.xml")
if err != nil {
panic(err)
}
err = wp.WriteMetaCSV("articles.csv")
if err != nil {
panic(err)
}
}
Convert to Hugo Format
import (
"github.com/grokify/go-wordpressxml"
"github.com/grokify/go-wordpressxml/hugo"
)
func main() {
wp := wordpressxml.NewWordPressXML()
err := wp.ReadFile("myblog.wordpress.xml")
if err != nil {
panic(err)
}
converter := hugo.WxrConverter{}
posts := converter.ConvertPosts(wp.Channel.Items)
// Use posts to generate Hugo content files
}
Notes
Since WordPress uses content:encoded and excerpt:encoded, Go's XML built-in parser treats both of these as the field encoded in different namespaces. This parser retrieves these fields as an array of encoded and then moves the data into the Content property.
Contributing
Features, Issues, and Pull Requests are always welcome.
To contribute:
- Fork it ( http://github.com/grokify/go-wordpressxml/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Please report issues and feature requests on GitHub.
Documentation
¶
Overview ¶
wordpressxml provides WordPress XML parser with metadata
wordpressxml provides WordPress XML parser with metadata
Index ¶
- func ReadFileWXR(filename string) (wxr.Wxr, error)
- type Author
- type Category
- type Channel
- type Comment
- type Item
- type ItemThin
- type RSS
- type WordPressXML
- func (wpxml *WordPressXML) ArticlesMetaTable() table.Table
- func (wpxml *WordPressXML) AuthorForLogin(authorLogin string) (Author, error)
- func (wpxml *WordPressXML) AuthorsToIndex() map[string]int
- func (wpxml *WordPressXML) ItemsToHTML(filepath, title string) error
- func (wpxml *WordPressXML) ReadFile(filepath string) error
- func (wpxml *WordPressXML) WriteMetaCSV(filepath string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Author ¶
type Author struct {
AuthorID int `xml:"author_id"`
AuthorLogin string `xml:"author_login"`
AuthorEmail string `xml:"author_email"`
AuthorDisplayName string `xml:"author_display_name"`
AuthorFirstName string `xml:"author_first_name"`
AuthorLastName string `xml:"author_last_name"`
AuthorArticles []ItemThin `xml:"-"`
}
Author is the WordPress XML author object.
type Comment ¶
type Comment struct {
ID int `xml:"comment_id"`
Parent int `xml:"comment_parent"`
Author string `xml:"comment_author"`
AuthorEmail string `xml:"comment_author_email"`
AuthorURL string `xml:"comment_author_url"`
DateGmt string `xml:"comment_date_gmt"`
Content string `xml:"comment_content"`
IndentLevel int `xml:"-"`
}
type Item ¶
type Item struct {
ID int `xml:"post_id"`
Title string `xml:"title"`
Creator string `xml:"creator"`
Encoded []string `xml:"encoded"`
IsSticky int `xml:"is_sticky"`
Link string `xml:"link"`
PubDate string `xml:"pubDate"`
Description string `xml:"description"`
PostDate string `xml:"post_date"`
PostDateGMT string `xml:"post_date_gmt"`
PostName string `xml:"post_name"`
PostType string `xml:"post_type"`
Status string `xml:"status"`
Categories []Category `xml:"category"`
Comments []Comment `xml:"comment"`
Content string
PostDatetime time.Time
PostDatetimeGMT time.Time
PubDatetime time.Time
}
Item is a WordPress XML item which can be a post, page or other object.
type ItemThin ¶
ItemThin is a WordPress XML item that is used as additional metadata in the Author object.
type WordPressXML ¶ added in v0.2.0
type WordPressXML struct {
Channel Channel `xml:"channel"`
CreatorCounts map[string]int
CreatorToIndex map[string]int
}
func NewWordPressXML ¶ added in v0.2.0
func NewWordPressXML() WordPressXML
func (*WordPressXML) ArticlesMetaTable ¶ added in v0.2.0
func (wpxml *WordPressXML) ArticlesMetaTable() table.Table
ArticlesMetaTable generates the data to be written out as a CSV.
func (*WordPressXML) AuthorForLogin ¶ added in v0.2.0
func (wpxml *WordPressXML) AuthorForLogin(authorLogin string) (Author, error)
AuthorForLogin returns the Author object for a given AuthorLogin or username.
func (*WordPressXML) AuthorsToIndex ¶ added in v0.2.0
func (wpxml *WordPressXML) AuthorsToIndex() map[string]int
func (*WordPressXML) ItemsToHTML ¶ added in v0.3.0
func (wpxml *WordPressXML) ItemsToHTML(filepath, title string) error
ItemsToHTML generates a simple HTML file from the items in a WordPress blog.
func (*WordPressXML) ReadFile ¶ added in v0.2.0
func (wpxml *WordPressXML) ReadFile(filepath string) error
ReadXml reads a WordPress XML file from the provided path.
func (*WordPressXML) WriteMetaCSV ¶ added in v0.2.0
func (wpxml *WordPressXML) WriteMetaCSV(filepath string) error
WriteMetaCsv writes articles metadata as a CSV file.
Source Files
Directories