WordPress: Remote Controller

WordPress: Remote Controller
Jonathan Davis, Ingenesis Limited
@jonathandavis
Friday, November 2, 12

View Slide

Jonathan Davis
Twitter: @jonathandavis
Email: [email protected]
shopplugin.net

View Slide


View Slide

highest overhead
fsockopen()

View Slide

sexy… but requires
allow_url_fopen set
Streams

View Slide

requires cURL extension
cURL

View Slide

WP_Http
one interface to rule them all
image by VincentXyooj

View Slide

Request
(educational use only.)

View Slide

The Response
$response = array(
'headers' => array(),
'response' => array(
'code' => int,
'message' => string
),
'body' => string
);

View Slide

new WP_Http;
doing_it_wrong()!

View Slide

Use the Wrappers
wp-includes/http.php
wp_remote_request()
Retrieve the raw response from the HTTP request.
wp_remote_get()
Retrieve the raw response from the HTTP request using the GET method.
wp_remote_post()
Retrieve the raw response from the HTTP request using the POST method.
wp_remote_head()
Retrieve the raw response from the HTTP request using the HEAD method.

View Slide

Helpful Functions
wp_remote_retrieve_headers()
Retrieve only the headers from the raw response.
wp_remote_retrieve_response_code()
Retrieve the HTTP stats response code from the raw response.
wp_remote_retrieve_response_messsage()
Retrieve the HTTP status response message from the raw response.
wp_remote_retrieve_body()
Retrieve only the body from the raw response.

View Slide

Simple Twitter Search
(yeah, it really works.)

View Slide

Request
(educational use only.)

View Slide

Simple Twitter Search
(yeah, it really works.)

View Slide

Basic Authentication
Use WP_Http to authenticate for protected web services

View Slide

Basic Authentication
$credentials = base64_encode( "$username:$password" );
$headers = array( 'Authorization' => "Basic $credentials" );
$response = wp_remote_get( $url, array( 'headers' => $headers ) );
base64_encode FTW
wp_remote_post() works too

View Slide

Web Services
The Usual Suspects
XML-RPC
SOAP
REST
NVP

View Slide

From Here to There
Copying a post from one WordPress site to another

View Slide

Turn on XML-RPC
Under Settings -> Writing

View Slide

Create an authorized user
Be sure to set a role with proper access (Author)

View Slide


View Slide

The Interface
function post_remote_copy ( $post_id, $options = array() ) {
A post ID and some options

View Slide

Setup the options
$options = wp_parse_args( $options, array(
'url' => 'http://website.com/xmlrpc.php',
'blogid' => 0,
'user' => 'username',
'password' => 'passsword',
'errorlog' => __('Error posting remotely: %s')
) );
extract($options,EXTR_SKIP);
The endpoint URL, blog id, remote user name, password
Then extract the options to local variables ($url, $user, etc.)

View Slide

Get the post from WordPress
$post = get_post($post_id);
Pass the $post_id from our function argument
Get the post stdClass back in $post

View Slide

Make sure the post exists
if ( is_null($post) ) {
error_log( sprintf($errorlog,__("$post_id was not
found.")) );
return false;
}
Log an error, and bail with a boolean result of false

View Slide

Copy the post data
$content = array(
'post_type' => $post->post_type,
'post_title' => "{$post->post_title} Copy",
'post_content' => $post->post_content,
'post_status' => 'draft',
'comment_status' => $post->comment_status,
'ping_status' => $post->ping_status,
);
Duplicate the data for the $content argument of the request

View Slide

Format the request
$request = xmlrpc_encode_request(
'wp.newPost',
array( $blogid, $user, $pwd, $content )
);
Pack the request using xmlrpc_encode_request
method, blog id, user name, password, the post content

View Slide

Hailing frequencies open...
$result = wp_remote_post(
$url,
array('body' => $request)
);
Send the xml encoded request in the body parameter
Get the result back

View Slide

Parse the response
$body = wp_remote_retrieve_body($result);
$XML = simplexml_load_string($body);
Grab the body from the result
Parse the XML data into a structured object

View Slide

Real programmers handle errors.
if ( '200' != wp_remote_retrieve_response_code($result) ) {
$message = wp_remote_retrieve_response_message($result);
error_log( sprintf($errorlog,$message) );
return false;
} elseif ( isset($XML->fault) ) {
$message = $XML->fault->value->struct->member[1]->value->string;
error_log( sprintf($errorlog,$message) );
return false;
}
Check for HTTP communication errors
Log any errors and bail out by returning false

View Slide

Woot! No errors!
error_log( __('Woohoo! Transport complete!') );
return true;
Log how awesome we are.
Send back boolean true

View Slide

Ready to go.
If it works, we’ll see a new entry:
Code is Poetry Copy - Draft

View Slide

Let’s do this!
post_remote_copy( 870, array(
'user' => 'remotr',
'password' => 'c0ntro!!r'
) );

View Slide

Oh noes!
Error handling works though :)

View Slide


View Slide

hrm...
'user' => 'remotr',
) );

View Slide

Here we go again...
'user' => 'remote',
) );

View Slide

Awesome sauce.
That’s what I’m talking about.

View Slide

Magical.
A new post out of nowhere!

View Slide

References
HTTP API
http://codex.wordpress.org/HTTP_API
How to Make HTTP Requests with WordPress
http://planetozh.com/blog/2009/08/how-to-make-http-requests-with-wordpress/
A Note on WP_Http and HTTP Requests in WordPress
http://kovshenin.com/2011/a-note-on-wp_http-and-http-requests-in-wordpress/
WP_Http class
wp-includes/class-http.php
WP_Http functions

View Slide

Jonathan Davis
Twitter: @jonathandavis
Email: [email protected]
shopplugin.net
Thank You!

View Slide

WordPress: Remote Controller

WordPress: Remote Controller

Jonathan Davis

More Decks by Jonathan Davis

Other Decks in Programming

Featured

Transcript