WordPress version

new()

Before we open a connection with xmlrpc, we need to have username, password, and proxy in the object's data. You can provide this in the following ways..

   my $o = WordPress:::XMLRPC->new({
     username => 'author1',
     password => 'superpass',
     proxy => 'http://mysite.com/xmlrpc.php',
   });

Or..

   my $o = WordPress:::XMLRPC->new;  
   
   $o->username('author1');
   $o->password('superpass');
   $o->proxy('http://mysite.com/xmlrpc.php');
   
   $o->server 
      or die( 
         sprintf 'could not connect with %s:%s to %s',
            $self->username,
            $self->password,
            $self->proxy,
         );

Uploading a file..

   my $data = WordPress:::XMLRPC::abs_path_to_media_object_data('./file.jpg');
   my $r = $o->newMediaObject($data);
   print $r->{url};

username()

   my $username = $o->username;
   $o->username('bill');

password()

   my $pw = $o->password;
   $o->password('jim');

proxy()

server()

blog_id()

publish()

   $o->newPost( $content_hashref, 1 );

But you can also call;

   $o->newPost( $content_hashref );

As we said, by default it is set to 1, if you want to set the default to 0,

   $o->publish(0);

errstr()

   $o->newPost(@args) or die($o->errstr);

If the DEBUG flag is on, this warns to STDERR automatically as well.

STANDARD XML RPC METHODS

getAuthors()

Takes no argument. Returns array ref, each element is a hashref.

         $return_value: [
                          {
                            display_name => 'leo',
                            user_id => '2',
                            user_login => 'leo'
                          },
                          {
                            display_name => 'chamon',
                            user_id => '3',
                            user_login => 'chamon'
                          }
                        ]

getComment()

Takes 1 args: comment_id (number). Returns struct (hashref).

   $o->getComment(2603);

Example return value: $r: { author => 'santrex sucks', author_email => 'webmaster@santrexsucks.com', author_ip => '66.165.246.149', author_url => 'http://santrexsucks.com', comment_id => '2603', content => 'santrex is the worst hosting company ive ever used. santrex should be avoided at all costs!', date_created_gmt => '20090617T00:17:54', link => 'http://leocharre.com/articles/its-on-bitch/comment-page-1/#comment-2603', parent => '0', post_id => '372', post_title => 'IT’S ON BITCH', status => 'approve', type => '', user_id => '0' }

getComments()

Takes 1 args: struct (hashref). NOTE: Untested. If you have info on this, send it in.

getCommentCount()

Takes 1 args: post_ID Returns post struct, hashref. $VAR1 = { 'awaiting_moderation' => '0', 'total_comments' => '0', 'spam' => '0', 'approved' => '0' };

deleteComment()

Takes 1 args: comment_id (number). Returns bool true or false.

   $o->deleteComment(2603);

editComment()

Takes 2 args: comment_id (number), content_struct (hashref).

newComment()

Takes 2 args: post id, content_struct (hashref). Returns new comment id (number).

This will be posted under your login name. The post id is the post the comment is in regards to.

   $o->newComment( 15, { status => 'approve', content => "Hi there, this is a note." } );

getCommentStatusList()

Takes no argument. Returns hashref.

Example return value: $r: { approve => 'Approved', hold => 'Unapproved', spam => 'Spam' }

getOptions()

Optional arguments are, a list of option names. If you do not pass a list of options assumes all are chosen. Returns hash ref. Of which each key is the option name. Each value is a hashref itself.

Return hashref format:

   $options => {

      $option_name => {
         desc        => $string,
         readonly    => $boolean,
         value       => $string
      },
   };

Possible option names (as of wordpress 2.8.4): blog_tagline, blog_title, blog_url, date_format, software_name, software_version, time_format, time_zone

Example return value (with no arguments):

   $options: {
               blog_tagline => {
                                 desc => 'Blog Tagline',
                                 readonly => '0',
                                 value => 'pinup art, perl, unix, developer smorgasbord'
                               },
               blog_title => {
                               desc => 'Blog Title',
                               readonly => '0',
                               value => 'leo charre'
                             },
               blog_url => {
                             desc => 'Blog URL',
                             readonly => '1',
                             value => 'http://leocharre.com'
                           },
               date_format => {
                                desc => 'Date Format',
                                readonly => '0',
                                value => 'F j, Y'
                              },
               software_name => {
                                  desc => 'Software Name',
                                  readonly => '1',
                                  value => 'WordPress'
                                },
               software_version => {
                                     desc => 'Software Version',
                                     readonly => '1',
                                     value => '2.8.4'
                                   },
               time_format => {
                                desc => 'Time Format',
                                readonly => '0',
                                value => 'g:i a'
                              },
               time_zone => {
                              desc => 'Time Zone',
                              readonly => '0',
                              value => '-8'
                            }
             }

Example usage:

   my $options = $o->getOptions('software_name', 'time_zone',);
   my $options = $o->getOptions;

setOptions()

Takes 1 args: options hash ref. Returns same as getOptions().

Argument is hashref with keys the name of the option, and values the new values.

NOTE: The structure of the hashref to setOptions() is *not* the same as the structure that getOptions() returns.

NOTE: Also note, some options are set read only, that means they cannot be changed via this method.

Example usage:

   $o->setOptions({ blog_tagline => 'New tagline for this blog, this is the best blog ever' });

This would return:

   $out: {
           blog_tagline => {
                             desc => 'Blog Tagline',
                             readonly => '0',
                             value => 'New tagline for this blog, this is the best blog ever', 
                           }
         }

The value taken by setOptions() should be the same as returned by getOptions(). This is more proof that php "coders" have no discipline. As if proof were needed. Ok, maybe that's too harsh.

newPost()

Takes 2 args: content_struct, publish. Returns id number of new post.

editPost()

Takes 3 args: post_ID, content_struct, publish. Returns boolean, true or false.

deletePost()

Argument is post id(number). Returns boolean.

getPost()

Takes 1 args: post_ID Returns post struct, hashref.

         $example_return_value: {
                                  categories => [
                                                  'Uncategorized'
                                                ],
                                  dateCreated => '20080130T14:19:05',
                                  date_created_gmt => '20080130T22:19:05',
                                  description => 'test description here',
                                  link => 'http://leocharre.com/articles/test_1201731544/',
                                  mt_allow_comments => '1',
                                  mt_allow_pings => '1',
                                  mt_excerpt => '',
                                  mt_keywords => '',
                                  mt_text_more => '',
                                  permaLink => 'http://leocharre.com/articles/test_1201731544/',
                                  postid => '119',
                                  title => 'test_1201731544',
                                  userid => '2',
                                  wp_author_display_name => 'leocharre',
                                  wp_author_id => '2',
                                  wp_password => '',
                                  wp_slug => 'test_1201731544'
                                }

getPostStatusList()

Takes no argument. Returns hashref.

Example return value: { 'draft' => 'Draft', 'publish' => 'Published', 'private' => 'Private', 'pending' => 'Pending Review' };

uploadFile()

Takes 1 args: data (hashref). The hashref keys and values are bits (Mime::Base64), type (mime type), and name (filename). See abs_path_to_media_object_data(). Returns result:

   ### $r: {
   ###       file => 'media.jpg',
   ###       type => 'image/jpeg',
   ###       url => 'http://leocharre.com/wp-content/uploads/media3.jpg'
   ###     }

Would be truly useful if it returned id!

getUsersBlogs()

No argument, returns users blogs. Example return :

         $r: [
               {
                 blogName => 'leo charre',
                 blogid => '1',
                 isAdmin => '1',
                 url => 'http://leocharre.com/'
               }
             ]

getUser()

Get a specific user by ID.

Examples:

        $o->getUser({id => 27});
        $o->getUser({id => 27, fields => ['nickname', 'email']);

Arguments:

• id (mandatory) The ID of the user to retrieve
• fields (optional) An array reference of fields to return. user_id is always returned. See <https://codex.wordpress.org/XML-RPC_WordPress_API/Users#wp.getUser> for a list of fields.

Returns:

        {
          'roles' => [
                     'administrator'
                   ],
          'registered' => '20160211T14:12:31',
          'nickname' => 'administrator',
          'display_name' => 'administrator',
          'last_name' => '',
          'username' => 'administrator',
          'email' => 'hostmaster@company.com',
          'nicename' => 'administrator',
          'url' => '',
          'user_id' => '1',
          'bio' => '',
          'first_name' => ''
        };

unless you specify 'fields', in which case it returns just those fields plus user_id.

getUsers()

Get a list of users.

Examples:

        $o->getUsers();
        $o->getUsers({filter => {roles => 'administrator'}, fields => ['nickname', 'email']);

Arguments:

• filter (optional) A hash reference of filter values to select specific users. Filtering is carried out on the WordPress server. See <https://codex.wordpress.org/XML-RPC_WordPress_API/Users#wp.getUsers> for a list of values.
• fields (optional) An array reference of fields to return. user_id is always returned. See <https://codex.wordpress.org/XML-RPC_WordPress_API/Users#wp.getUser> for a list of fields. Has no efffect unless you also specify filter (because WordPress is weird).

Returns:

        [
         {
            'roles' => [
                       'author'
                     ],
            'registered' => '20160509T13:40:20',
            'nickname' => 'Mariann Ratz',
            'display_name' => 'Mariann Ratz',
            'last_name' => 'Ratz',
            'username' => 'Mariann.ratz',
            'email' => 'Mariann.ratz@company.com',
            'nicename' => 'mariann-ratz',
            'url' => '',
            'user_id' => '42',
            'bio' => '',
            'first_name' => 'Mariann'
          },
          {
            'roles' => [
                       'author'
                     ],
            'registered' => '20160322T12:56:55',
            'nickname' => 'Mark Orkden',
            'display_name' => 'Mark Orkden',
            'last_name' => 'Orkden',
            'username' => 'mark.orkden',
            'email' => 'mark.orkden@company.com',
            'nicename' => 'mark-orkden',
            'url' => '',
            'user_id' => '17',
            'bio' => '',
            'first_name' => 'Mark'
          }
        ];

unless you specify 'fields', in which case it returns just those fields plus user_id.

EXTENDED XML RPC CALLS

createUser()

WP API method: wp_insert_user

Make a new user.

Example:

        # Minimum possible information - no capabilities so can't do much
        $o->createUser({ user_login => 'atest.user2', user_pass => 'klsdfslfhew', user_email => 'test.user@mywordpressite.com'});
        # Minium useful information
        $o->createUser({ user_login => 'atest.user2', user_pass => 'klsdfslfhew', user_nicename => 'test-user', display_name => 'Test User', first_name => 'Test', last_name => 'User', role => 'author', user_email => 'test.user@mywordpressite.com'});

Arguments:

•

(mandatory) A hash reference of arguments to pass to wp_create_user. You must specify at least user_login,user_pass and user_email. See <https://codex.wordpress.org/Function_Reference/wp_insert_user> for the list of arguments.

Returns:

        113

for example, which is the user_id the newly created user.

addUserMeta()

WP API method: add_user_meta

Add a piece of metadata to a user.

Examples:

        $o->addUserMeta({ user_id => 23, meta_key => 'foo', meta_value => 'bar'});
        $o->addUserMeta({ user_id => 23, meta_key => 'foo', meta_value => 'bar', unique => 'true'});
        $o->addUserMeta({ user_id => 23, meta_key => 'foo', meta_value => 'bar', unique => 'false'});

Arguments:

•

(mandatory) A hash reference of arguments to pass to wp_create_user. You must specify at least user_id, meta_key, and meta_value. See <https://codex.wordpress.org/Function_Reference/add_user_meta> for the list of arguments.

Returns:

        2437

for example, which is the unique key for the database row inserted successfully with the piece of meta information, or 0 if it was unsuccessful.

getUserMeta()

WP API method: get_user_meta

Add a piece of metadata to a user.

Examples:

        $o->getUserMeta({ user_id => 23 });
        $o->getUserMeta({ user_id => 23, meta_key => 'foo'});
        $o->getUserMeta({ user_id => 23, meta_key => 'foo', single => 'true'});

Arguments:

•

(mandatory) A hash reference of arguments to pass to wp_create_user. You must specify at least user_id. See <https://codex.wordpress.org/Function_Reference/get_user_meta> for the list of arguments.

Returns:

        {
                'show_admin_bar_front' => [ 'true' ],
                'npn_mailnotify' => [ '1' ],
                'wp_4mv06tbsd5_capabilities' => [ 'a:1:{s:6:"author";b:1;}' ],
                'nickname' => [ 'Abdul Hafaaz' ],
                'session_tokens' => [ 'a:1:{s:64:"6df58d104147ce47eba41dd2f6e86a9c144659d4f4b095385eeeea2e26c7bef0";a:4:{s:10:"expiration";i:1482412957;s:2:"ip";s:13:"108.18.98.132";s:2:"ua";s:134:"Mozilla/5.0 (iPhone; CPU iPhone OS 9_3_5 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13G36 Safari/601.1";s:5:"login";i:1482240157;}}' ],
                'comment_shortcuts' => [ 'false' ],
                'rich_editing' => [ 'true' ],
                'description' => [ '' ],
                'last_name' => [ 'Hafaaz' ],
                'use_ssl' => [ '0' ],
                'wp_4mv06tbsd5_user_level' => [ '2' ],
                'admin_color' => [ 'fresh' ],
                'first_name' => [ 'Abdul' ]
        }

for example, if you don't specify which key you want. Actual fields will depend upon which plugins you have installed and database table names. Note that each value in the hash is an array, even if there is only one value to display. If you specify meta_key, you will just get the value of that key:

        bar

or an empty string if that key doesn't exist.

THANKS

Alan Haggai Alavi