wordpressxml

README

WordPress XML Parser

Overview

The wordpress-xml-go package provides WordPress 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/wordpress-xml-go

Usage

import (
	"github.com/grokify/wordpress-xml-go"
)

func main() {
	wp := wordpressxml.NewWordpressXml()
	err := wp.ReadXml("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/wordpress-xml-go/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.

License

WordPress XML Parser is available under the MIT license. See LICENSE for details.

WordPress XML Parser © 2016 by John Wang

Documentation

Overview

wordpressxml provides WordPress XML parser with metadata

Index

• type Author
• type Category
• type Channel
• type Item
• type ItemThin
• type Rss
• type WpXml
  • func NewWordpressXml() WpXml
  • func (wpxml *WpXml) ArticlesMetaTable() [][]string
  • func (wpxml *WpXml) AuthorForLogin(authorLogin string) (Author, error)
  • func (wpxml *WpXml) AuthorsToIndex() map[string]int
  • func (wpxml *WpXml) ReadXml(filepath string) error
  • func (wpxml *WpXml) WriteMetaCsv(filepath string) 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 Item

type Item struct {
	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"`
	Content        string
	PubDateRfc3339 string
}

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 WpXml

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

func NewWordpressXml

func NewWordpressXml() WpXml

func (*WpXml) ArticlesMetaTable

func (wpxml *WpXml) ArticlesMetaTable() [][]string

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

func (*WpXml) AuthorForLogin

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

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

func (*WpXml) AuthorsToIndex

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

func (*WpXml) ReadXml

func (wpxml *WpXml) ReadXml(filepath string) error

ReadXml reads a WordPress XML file from the provided path.

func (*WpXml) WriteMetaCsv

func (wpxml *WpXml) WriteMetaCsv(filepath string) error

Writes articles metadata as a CSV file.