wp-xmlrpc - A thin layer of CLI over WordPress XML-RPC API
This document describes version 0.003 of wp-xmlrpc (from Perl distribution App-wp-xmlrpc), released on 2017-04-24.
In ~/wp-xmlrpc.conf, put your API credentials:
~/wp-xmlrpc.conf
proxy=https://YOURBLOGNAME.wordpress.com/xmlrpc.php username=YOURUSERNAME password=YOURPASSWORD
Then:
% wp-xmlrpc wp.getPost 13
You can also put multiple credentials in the config file via profiles:
[profile=blog1] proxy=https://BLOG1NAME.wordpress.com/xmlrpc.php username=YOURUSERNAME password=YOURPASSWORD [profile=blog2] proxy=https://BLOG2NAME.wordpress.com/xmlrpc.php username=YOURUSERNAME password=YOURPASSWORD
then:
% wp-xmlrpc --config-profile blog1 wp.getPost 13
Some of the functions:
% wp-xmlrpc wp.getPosts ;# list all posts % wp-xmlrpc wp.newPost '{"post_content":"This is a test blog post"}' ;# by default will create an untitled blog post with status=draft % wp-xmlrpc wp.newPost '{"post_content":"This is a test blog post", "post_status":"publish", "post_title":"Some title"}' ;# set title & status % wp-xmlrpc wp.editPost 13 '{"status":"draft"}' % wp-xmlrpc wp.deletePost 13 % wp-xmlrpc wp.getTaxonomies % wp-xmlrpc wp.getTaxonomy category % wp-xmlrpc wp.getTaxonomy post_tag % wp-xmlrpc wp.getTaxonomy post_format % wp-xmlrpc wp.getTaxonomy mentions % wp-xmlrpc wp.getTerms category ;# get terms (i.e. in this case list of categories) % wp-xmlrpc wp.getTerm category 2342 ;# get a specific category by ID % wp-xmlrpc wp.getTerm tag 423 ;# get a specific tag by ID % wp-xmlrpc wp.newTerm '{"taxonomy":"tag", "name":"tag3"}' ;# create a new tag % wp-xmlrpc wp.newTerm '{"taxonomy":"category", "name":"cat2", "description":"Second category", "parent":2342}' ;# create a new category, with description and parent ID % wp-xmlrpc wp.editTerm 2345 '{"description":"New description"}' ;# create a category's description % wp-xmlrpc wp.deleteTerm 2345 % wp-xmlrpc wp.getComments ;# list comments % wp-xmlrpc wp.getCommentCount 13 ;# get number of comments for a post % wp-xmlrpc wp.getComment 9983 ;# get a comment by ID % wp-xmlrpc wp.getOptions ;# get all options % wp-xmlrpc wp.getOptions '["blog_title","blog_tagline"]' ;# get specified options only % wp-xmlrpc wp.setOptions '{"blog_title":"New title", "blog_tagline":"New tagline"}' % wp-xmlrpc wp.getProfile % wp-xmlrpc wp.editProfile '{"bio":"Blah blah blah"}'
This script is a thin layer of CLI over WordPress XML-RPC API, mainly for testing/debugging. Each CLI subcommand is for calling API method of the same name. If an argument starts with { it will be assumed as a JSON-encoded hash and will be decoded. If an argument starts with [ it will be assumed as a JSON-encoded array and will be decoded.
{
[
* marks required options.
*
Default value:
1
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Choose output format, e.g. json, text.
undef
Display help message and exit.
Set output format to json.
When outputing as JSON, strip result envelope.
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Do not use any configuration file.
Do not read environment for default options.
List available subcommands.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C wp-xmlrpc wp-xmlrpc
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immediately have tab completion.
To activate tcsh completion for this script, put:
complete wp-xmlrpc 'p/*/`wp-xmlrpc`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/wp-xmlrpc.conf, ~/wp-xmlrpc.conf, or /etc/wp-xmlrpc.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--no-config
To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].
[subcommand=NAME]
[SOMESECTION subcommand=NAME]
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
[subcommand=SUBCOMMAND_NAME profile=SOMENAME]
[SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]
--config-profile SOMENAME
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
List of available configuration parameters:
blog_id (see --blog-id) format (see --format) naked_res (see --naked-res) password (see --password) proxy (see --proxy) username (see --username)
comment_id (see --comment-id)
post_id (see --post-id)
term_id (see --term-id)
comment (see --comment) comment_id (see --comment-id)
content (see --content)
content (see --content) term_id (see --term-id)
filter (see --filter)
attachment_id (see --attachment-id)
options (see --options)
fields (see --fields) post_id (see --post-id)
fields (see --fields) post_type_name (see --post-type-name)
fields (see --fields) filter (see --filter)
fields (see --fields)
taxonomy (see --taxonomy)
taxonomy (see --taxonomy) term_id (see --term-id)
fields (see --fields) user_id (see --user-id)
isAdmin (see --isAdmin) xmlrpc (see --xmlrpc)
comment (see --comment) post_id (see --post-id)
Specify additional command-line options.
~/.config/wp-xmlrpc.conf
/etc/wp-xmlrpc.conf
Please visit the project's homepage at https://metacpan.org/release/App-wp-xmlrpc.
Source repository is at https://github.com/perlancar/perl-App-wp-xmlrpc.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-wp-xmlrpc
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
API reference: https://codex.wordpress.org/XML-RPC_WordPress_API
wordpress-info, wordpress-upload-media, wordpress-upload-post from the WordPress::CLI distribution.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017, 2016 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::wp::xmlrpc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::wp::xmlrpc
CPAN shell
perl -MCPAN -e shell install App::wp::xmlrpc
For more information on module installation, please visit the detailed CPAN module installation guide.