Micropub

Description

Micropub is an open API standard that is used to create posts on one’s own domain using third-party clients. Web apps and native apps (e.g. iPhone, Android) can use Micropub to post short notes, photos, events or other posts to your own site, similar to a Twitter client posting to Twitter.com.

Once you’ve installed and activated the plugin, try using Quill to create a new post on your site. It walks you through the steps and helps you troubleshoot if you run into any problems. After that, try other clients like OwnYourGram, OwnYourCheckin, MobilePub, and Teacup.

Supports the full W3C Micropub CR spec as of 2016-10-18, except for the optional media endpoint. Media may be uploaded directly to the wordpress-micropub endpoint as multipart/form-data, or sideloaded from URLs.

License

This project is placed in the public domain. You may also use it under the CC0 license.

Scope

Supports the following scope parameters requested by Micropub clients.
* post (legacy) – Grants all user delegated access
* create – Allows the client to create posts on behalf of the user
* update – Allows the client to update posts on behalf of the user
* delete – Allows the client to delete posts on behalf of the user
* indelete – Allows the client to undelete posts on behalf of the user

Does not currently support the ‘media’ scope due lack of adoption by clients. At this time, create or update grants permission for file uploads.

WordPress details

Filters and hooks

Adds four filters:

before_micropub( $input )

Called before handling a Micropub request. Returns $input, possibly modified.

micropub_post_content( $post_content, $input ) 

Called during the handling of a Micropub request. The content generation function is attached to this filter by default. Returns $post_content, possibly modified.

micropub_syndicate-to( $synd_urls, $user_id )

Called to generate the list of syndicate-to targets to return in response to a query. Returns $synd_urls, an array, possibly modified.

micropub_query( $resp, $input )

$resp defaults to null. If the return value is non-null, it should be an associative array that is encoded as JSON and will be returned in place of the normal micropub response.

…and two hooks:

after_micropub( $input, $wp_args = null)

Called after handling a Micropub request. Not called if the request fails (ie doesn’t return HTTP 2xx).

micropub_syndication( $ID, $syndicate_to )

Called only if there are syndication targets $syndicate_to for post $ID. $syndicate_to will be an array of UIDs that are verified as one or more of the UIDs added using the micropub_syndicate-to filter.

Arguments:

  • $input: associative array, the Micropub request in JSON format. If the request was form-encoded or a multipart file upload, it’s converted to JSON format.
  • $wp_args: optional associative array. For creates and updates, this is the arguments passed to wp_insert_post or wp_update_post. For deletes and undeletes, args['ID'] contains the post id to be (un)deleted. Null for queries.

Other

Stores microformats2 properties in post metadata with keys prefixed by mf2_. Details here. All values are arrays; use unserialize() to deserialize them.

Does not support multithreading. PHP doesn’t really either, so it generally won’t matter, but just for the record.

Supports Experimental Properties for Post Status and Visibility. Visibility can be either
public or private. Setting it to private will set the post status to private. Post Status may be set to either published or draft. If visibility or post status are not set to one of these
options, the plugin will return HTTP 400 with body:

{
  "error": "invalid_request",
  "error_description": "Invalid Post Status"
}

WordPress has a whitelist of file extensions that it allows in uploads. If you upload a file in a Micropub extension that doesn’t have an allowed extension, the plugin will return HTTP 400 with body:

{
  "error": "invalid request",
  "error_description": "Sorry, this file is not permitted for security reasons."
}<h3>Authentication and authorization</h3>

Supports the full OAuth2/IndieAuth authentication and authorization flow. Defaults to IndieAuth. Custom auth and token endpoints can be used by overriding the MICROPUB_AUTHENTICATION_ENDPOINT and MICROPUB_TOKEN_ENDPOINT endpoints or by setting the options indieauth_authorization_endpoint and indieauth_token_endpoint which are also set by the IndieAuth Plugin.

If the token’s me value matches a WordPress user’s URL, that user will be used. Otherwise, the token must match the site’s URL, and no user will be used.

Alternatively, you can set MICROPUB_LOCAL_AUTH to 1 to disable the plugin’s authorization function, for example if you want authorization to be done by WordPress or another plugin. It will also
be disabled if the IndieAuth plugin is installed.

Finally, for ease of development, if the WordPress site is running on localhost, it logs a warning if the access token is missing or invalid and still allows the request.

Configuration Options

These configuration options can be enabled by adding them to your wp-config.php

  • define('MICROPUB_LOCAL_AUTH', '1') – Disable this plugins built-in authentication.
  • define('MICROPUB_AUTHENTICATION_ENDPOINT', 'https://indieauth.com/auth') – Define a custom authentication endpoint.
  • define('MICROPUB_TOKEN_ENDPOINT', 'https://tokens.indieauth.com/token') – Define a custom token endpoint

These configuration options can be enabled by setting them in the WordPress options table or will appear under General if you install the IndieAuth plugin.
* indieauth_authorization_endpoint – if set will override MICROPUB_AUTHENTICATION_ENDPOINT for setting a custom endpoint
* indieauth_token_endpoint – if set will override MICROPUB_TOKEN_ENDPOINT for setting a custom endpoint
* micropub_default_post_status – if set, Micropub posts will be set to this status by default( publish, draft, or private ). Can also be set in the Writing settings.

Development

The canonical repo is http://github.com/snarfed/wordpress-micropub . Feedback and pull requests are welcome!

To add a new release to the WordPress plugin directory, run push.sh.

To set up your local environment to run the unit tests:

  1. Install PHPUnit, e.g. brew install homebrew/php/wp-cli phpunit with Homebrew on Mac OS X.
  2. Install and start MySQL. (You may already have it.)
  3. Run ./bin/install-wp-tests.sh wordpress_micropub_test root '' localhost to download WordPress and its unit test library, into /tmp and ./temp by default, and create a MySQL db to test against. Background here. Feel free to use a MySQL user other than root. You can set the WP_CORE_DIR and WP_TESTS_DIR environment variables to change where WordPress and its test library are installed. For example, I put them both in the repo dir.
  4. Open wordpress-tests-lib/wp-tests-config.php and add a slash to the end of the ABSPATH value. No clue why it leaves off the slash; it doesn’t work without it.
  5. Run phpunit in the repo root dir. If you set WP_CORE_DIR and WP_TESTS_DIR above, you’ll need to set them for this too. You should see output like this:

    `
    

    Installing…

    1 / 1 (100%)
    Time: 703 ms, Memory: 33.75Mb
    OK (1 test, 3 assertions)
    `

To set up PHPCodesniffer to test adherence to WordPress Coding Standards and PHP 5.3 Compatibility:

  1. Install Composer.
  2. Run composer install which will install all dependencies for PHP Codesniffer and the standards required
  3. To list coding standard issues in a file, run phpcs --standard=phpcs.xml
  4. If you want to try to automatically fix issues, run phpcbf with the same arguments as phpcs.

To automatically convert the readme.txt file to readme.md, you may, if you have installed composer as noted in the previous section, enter composer update-readme to have the .txt file converted
into markdown and saved to readme.md.

Installation

Install from the WordPress plugin directory or put micropub.php in your plugin directory. No setup needed.

FAQ

If your Micropub client includes an Authorization HTTP request header but you still get an HTTP 401 response with body missing access token, your server may be stripping the Authorization header. If you’re on Apache, try adding this line to your .htaccess file:

SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1

If that doesn’t work, try this line:

RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

If that doesn’t work either, you may need to ask your hosting provider to whitelist the Authorization header for your account. If they refuse, you can pass it through Apache with an alternate name, but you’ll need to edit this plugin’s code to read from that alternate name.

Installation Instructions

Install from the WordPress plugin directory or put micropub.php in your plugin directory. No setup needed.

Contributors & Developers

“Micropub” is open source software. The following people have contributed to this plugin.

Contributors

Translate “Micropub” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.4.3 (2018-05-27)

  • Change scopes to filter
  • Get token response when IndieAuth plugin is installed

1.4.2 (2018-04-19)

  • Enforce scopes

1.4.1 (2018-04-15)

  • Version bump due some individuals not getting template file

1.4 (2018-04-08)

  • Separate functions that generate headers into micropub and IndieAuth
  • Add support for an option now used by the IndieAuth plugin to set alternate token and authorization endpoints
  • MICROPUB_LOCAL_AUTH configuration option adjusted to reflect that this disables the plugin built in authentication. This can hand it back to WordPress or allow another plugin to take over
  • MICROPUB_LOCAL_AUTH now disables adding auth headers to the page.
  • Fix post status issue by checking for valid defaults
  • Add configuration option under writing settings to set default post status
  • Add micropub_syndication hook that only fires on a request to syndicate to make it easier for third-party plugins to hook in

1.3 (2017-12-31)

  • Saves access token response in a post meta field micropub_auth_response.
  • Bug fix for post_date_gmt
  • Store timezone from published in arguments passed to micropub filter
  • Correctly handle published times that are in a different timezone than the site.
  • Set minimum version to PHP 5.3
  • Adhere to WordPress Coding Standards
  • Add micropub_query filter
  • Support Nested Properties in Content Generation
  • Deprecate MICROPUB_DRAFT_MODE configuration option in favor of setting option
  • Remove post content generation override in case of microformats2 capable theme or Post Kinds plugin installed
  • Introduce micropub_post_content filter to which post content generation is attached so that a theme or plugin can modify/remove the post generation as needed

1.2 (2017-06-25)

1.1 (2017-03-30)

  • Support h-adr, h-geo, and plain text values for p-location.
  • Bug fix for create/update with content[html].

1.0.1

  • Remove accidental dependence on PHP 5.3 (#46).

1.0

Substantial update. Supports full W3C Micropub spec, except for optional
media endpoint.

  • Change mf2_* post meta format from multiple separate values to single array value that can be deserialized with unserialize.
  • Change the before_micropub filter’s signature from ( $wp_args ) to ( $input ) (microformats2 associative array).
  • Change the after_micropub hook’s signature changed from ( $post_id ) to ( $input, $wp_args ) (microformats2 associative array, WordPress post args).
  • Post content will not be automatically marked up if theme supports microformats2 or Post Kinds plugin is enabled.
  • Add PHP Codesniffer File.

0.4

  • Store all properties in post meta except those in a blacklist.
  • Support setting authentication and token endpoint in wp-config by setting MICROPUB_AUTHENTICATION_ENDPOINT and MICROPUB_TOKEN_ENDPOINT.
  • Support setting all micropub posts to draft in wp-config for testing by setting MICROPUB_DRAFT_MODE in wp-config.
  • Support using local auth to authenticate as opposed to IndieAuth as by setting MICROPUB_LOCAL_AUTH in wp-config.
  • Set content to summary if no content provided.
  • Support querying for syndicate-to and future query options.

0.3

  • Use the specific WordPress user whose URL matches the access token, if possible.
  • Set post_date_gmt as well as post_date.

0.2

  • Support more Micropub properties: photo, like-of, repost-of, in-reply-to, rsvp, location, category, h=event.
  • Check but don’t require access tokens on localhost.
  • Better error handling.

0.1

Initial release.