wordpressxml

README

WordPress XML Parser

Overview

The go-wordpressxml package provides a WordPress WXR (WordPress eXtended RSS) XML parser.

Documentation

Documentation is provided using godoc and available on GoDoc.org.

Installation

Installing any of the packages will install the entire library. For example:

$ go get github.com/grokify/go-wordpressxml

Usage

import (
	"github.com/grokify/go-wordpressxml"
)

func main() {
	wp := wordpressxml.NewWordPressXML()
	err := wp.ReadFile("myblog.wordpress.2016-08-13.xml")
	if err != nil {
		panic(err)
	}
	wp.WriteMetaCSV("articles.csv")
}

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:

1. Fork it ( http://github.com/grokify/go-wordpressxml/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. 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 NewWordPressXML() 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

Functions

func ReadFileWXR

func ReadFileWXR(filename string) (wxr.Wxr, error)

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 Category

type Category struct {
	Domain      string `xml:"domain,attr"`
	DisplayName string `xml:",chardata"`
	URLSlug     string `xml:"nicename,attr"`
}

type Channel

type Channel struct {
	Title   string   `xml:"title"`
	Link    string   `xml:"link"`
	Authors []Author `xml:"author"`
	Items   []Item   `xml:"item"`
}

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

type ItemThin struct {
	Title string
	Index int
}

ItemThin is a WordPress XML item that is used as additional metadata in the Author object.

type RSS

type RSS struct {
	Channel Channel `xml:"channel"`
}

type WordPressXML

type WordPressXML struct {
	Channel        Channel `xml:"channel"`
	CreatorCounts  map[string]int
	CreatorToIndex map[string]int
}

func NewWordPressXML

func NewWordPressXML() WordPressXML

func (*WordPressXML) ArticlesMetaTable

func (wpxml *WordPressXML) ArticlesMetaTable() table.Table

ArticlesMetaTable generates the data to be written out as a CSV.

func (*WordPressXML) AuthorForLogin

func (wpxml *WordPressXML) AuthorForLogin(authorLogin string) (Author, error)

AuthorForLogin returns the Author object for a given AuthorLogin or username.

func (*WordPressXML) AuthorsToIndex

func (wpxml *WordPressXML) AuthorsToIndex() map[string]int

func (*WordPressXML) ItemsToHTML

func (wpxml *WordPressXML) ItemsToHTML(filepath, title string) error

ItemsToHTML generates a simple HTML file from the items in a WordPress blog.

func (*WordPressXML) ReadFile

func (wpxml *WordPressXML) ReadFile(filepath string) error

ReadXml reads a WordPress XML file from the provided path.

func (*WordPressXML) WriteMetaCSV

func (wpxml *WordPressXML) WriteMetaCSV(filepath string) error

WriteMetaCsv writes articles metadata as a CSV file.