WordPress Data

Created by David.shanske.com on February 15

• Sun, February 15 david.shanske.com Created page with "In order to ensure interoperability between Indieweb WordPress plugins, as much as possible, the same data structures should be used. = Taxonomies = Currently used for the [Po..."
• Sun, February 15 david.shanske.com
• Sun, February 15 david.shanske.com /* Rel-Syndication */
• Sun, February 15 david.shanske.com /* Metadata */
• Sun, February 15 david.shanske.com /* Rel-Syndication */
• Sun, February 15 david.shanske.com /* Response */
• Sun, February 15 david.shanske.com /* Credit should be given */
• Sun, February 15 david.shanske.com /* Comment */
• Mon, February 16 tantek.com /* Microformats data */ use uf2 instead of mf2 derivative proposal
• Mon, February 16 david.shanske.com /* Taxonomies */
• Mon, February 16 david.shanske.com /* Response */
• Mon, February 16 tantek.com /* Microformats data */ why mf2 is better than uf2

In order to ensure interoperability between Indieweb WordPress plugins, as much as possible, the same data structures should be used.

Taxonomies

A taxonomy called 'kind' is currently used for the Post Kinds Plugin. This is meant to indicate the post kind

Current post kinds are all lowercase. List appears below:

• article
• note
• reply
• repost
• like
• favorite
• bookmark
• photo
• tag
• rsvp
• listen
• watch
• play
• checkin
• wish

Many can be disabled by sites not using them

Considering the following additions:

• weather
• exercise

Metadata

WordPress allows for for metadata to be attached to various objects.

By default, WordPress includes a metadata table for post types(posts, pages, etc), comments, and users.

WordPress contains a Metadata API that it uses to handle metadata. Metadata can also be created for other object types, but is not part of a default installation.

Microformats data

Proposal by Ryan Barrett: store a post's top-level microformats2 string properties in post metadata with the property names as the keys, prefixed by mf2_. wordpress-micropub does this now.

For example, this RSVP snippet:

<data class="p-rsvp" value="yes">I'm in!</data>

would be stored in post meta with the key mf2_rsvp and value yes.

For mf2 properties with multiple values, just store multiple values for the post meta key. WordPress supports this with e.g. add_post_meta.

Use code like this to get multiple post meta values in a single database query:

$query = new WP_Query(array('meta_query' => array(array(
  'key' => 'meta_key',
  'value' => array('mf2_name', 'mf2_content', ...),
  'compare' => 'IN'))));

use uf2 instead of mf2

Tantek Çelik minor revision of Ryan Barrett's proposal - same but use "uf2" instead of "mf2" because the "u" looks closer to a µ for "micro":

Store a post's top-level microformats2 string properties in post metadata with the property names as the keys, prefixed by uf2_. For example, this RSVP snippet:

<data class="p-rsvp" value="yes">I'm in!</data>

would be stored in post meta with the key uf2_rsvp and value yes.

For uf2 properties with multiple values, just store multiple values for the post meta key. WordPress supports this with e.g. add_post_meta.

Use code like this to get multiple post meta values in a single database query:

$query = new WP_Query(array('meta_query' => array(array(
  'key' => 'meta_key',
  'value' => array('uf2_name', 'uf2_content', ...),
  'compare' => 'IN'))));

why mf2 is better than uf2

Per Ryan Barrett's follow-up in IRC:

• mf2 is seen in existing code much more often than uf2
  • e.g. php-mf2, mf2py, mf2util, etc
• mf2 is more obvious (and maybe less clever)

Geodata

WordPress currently provides a Geodata data structure.

• geo_latitude REQUIRED

   (float) decimal degrees -90 to 90 (negative values are in the southern hemisphere). 

• geo_longitude REQUIRED

  (float) decimal degrees -180 to 180 (negative values are in the western hemisphere). 

• geo_public OPTIONAL

  (int) is the geodata public (1) or private (0)? If value is missing, assume public. 

• geo_address OPTIONAL

    (string) freeform textual description of coordinates. 
   "221B Baker St, Westminster, London NW1 6XE, UK", 
   "Pasadena, CA", "Soho, NYC", "Idaho", etc. 
   Accuracy level and language is arbitrary. 

• geo_venue OPTIONAL

  (string) freeform textual name of location
   Not part of WordPress standard - proposed by David Shanske for compatibility with microformats

Comment

Webmention Plugin adds an additional comment type of 'webmention' to comments.

Semantic Linkbacks stores extra information in the comment metadata.

• semantic_linkbacks_canonical - the canonical source url
• semantic_linkbacks_avatar - the author avatar URL
• semantic_linkbacks_type - the comment type. The plugin currently supports the following types:
  • mention(default)
  • reply
  • repost
  • like
  • favorite
  • tag
  • rsvp:yes, rsvp:no, rsvp:maybe, rsvp:invited, rsvp:tracking.

Response

The Post Kinds Plugin uses the following array of metadata using the key 'response' to store details on what a post is responding to. All fields are optional.

• response['url'] - The URL the post is responding to.
• response['title'] - The title of same
• response['author'] - The author name
• response['icon'] - The author icon/image/avatar
• response['published'] - URL publish date in ISO8601 with timezone offset
• response['content'] - Content or a Citation...to allow for an excerpt for context.

Syndication

David Shanske's Syndication Links plugin uses a single data field with the key 'syndication_urls' with URLs separated by newlines for syndication URLs to be marked up for syndication. Entry is a textbox with one URL per line. This means there is no requirement that WordPress know about a service to add a link to it.

The plugin formerly stored an array of URLs of various syndication services under the metadata key 'synlinks'. This is now deprecated.