Changeset 16484

Timestamp:

11/19/2010 01:57:05 PM (13 years ago)

Author:

josephscott

Message:

Expose post format details in XML-RPC:

• New method: wp.getPostFormats
• New field in methods dealing with posts: wp_post_format

props ericmann, fixes #15405

File:

• trunk/wp-includes/class-wp-xmlrpc-server.php (modified) (10 diffs)

trunk/wp-includes/class-wp-xmlrpc-server.php

@@ -64 +64 @@
             'wp.getMediaItem'       => 'this:wp_getMediaItem',
             'wp.getMediaLibrary'    => 'this:wp_getMediaLibrary',
+            'wp.getPostFormats'     => 'this:wp_getPostFormats',
 
             // Blogger API
@@ -1602 +1603 @@
         return $attachments_struct;
     }
+    
+    /** 
+      * Retrives a list of post formats used by the site 
+      * 
+      * @since 3.1
+      * 
+      * @param array $args Method parameters. Contains: 
+      *  - blog_id 
+      *  - username 
+      *  - password 
+      * @return array 
+      */ 
+    function wp_getPostFormats( $args ) {
+        $this->escape( $args );
+
+        $blog_id = (int) $args[0];
+        $username = $args[1];
+        $password = $args[2];
+
+        if ( !$user = $this->login( $username, $password ) )
+            return $this->error;
+            
+        do_action( 'xmlrpc_call', 'wp.getPostFormats' );
+        return get_post_format_strings();
+    } 
 
     /* Blogger API functions.
@@ -2083 +2109 @@
         if ( !current_user_can( $cap ) )
             return new IXR_Error( 401, $error_message );
+
+        // Check for a valid post format if one was given
+        if ( isset( $content_struct['wp_post_format'] ) ) { 
+            $content_struct['wp_post_format'] = sanitize_key( $content_struct['wp_post_format'] ); 
+            if ( !array_key_exists( $content_struct['wp_post_format'], get_post_format_strings() ) ) {
+                return new IXR_Error( 404, __( 'Invalid post format' ) );
+            }
+        }
 
         // Let WordPress generate the post_name (slug) unless
@@ -2267 +2301 @@
 
         $this->attach_uploads( $post_ID, $post_content );
+        
+        // Handle post formats if assigned, value is validated earlier
+        // in this function
+        if ( isset( $content_struct['wp_post_format'] ) )
+            wp_set_post_terms( $post_ID, array( 'post-format-' . $content_struct['wp_post_format'] ), 'post_format' ); 
 
         logIO('O', "Posted ! ID: $post_ID");
@@ -2358 +2397 @@
         if ( !current_user_can( $cap ) )
             return new IXR_Error( 401, $error_message );
+
+        // Check for a valid post format if one was given
+        if ( isset( $content_struct['wp_post_format'] ) ) { 
+            $content_struct['wp_post_format'] = sanitize_key( $content_struct['wp_post_format'] ); 
+            if ( !array_key_exists( $content_struct['wp_post_format'], get_post_format_strings() ) ) {
+                return new IXR_Error( 404, __( 'Invalid post format' ) );
+            }
+        }
 
         $postdata = wp_get_single_post($post_ID, ARRAY_A);
@@ -2553 +2600 @@
 
         $this->attach_uploads( $ID, $post_content );
+        
+        // Handle post formats if assigned, validation is handled
+        // earlier in this function
+        if ( isset( $content_struct['wp_post_format'] ) )
+            wp_set_post_terms( $post_ID, array( 'post-format-' . $content_struct['wp_post_format'] ), 'post_format' ); 
 
         logIO('O',"(MW) Edited ! ID: $post_ID");
@@ -2620 +2672 @@
             if ( $postdata['post_status'] === 'future' )
                 $postdata['post_status'] = 'publish';
+                
+            // Get post format 
+            $post_format = get_post_format( $post_ID );
+            if ( empty( $post_format ) )
+                $post_format = 'default';
 
             $sticky = false;
@@ -2661 +2718 @@
                 'post_status' => $postdata['post_status'],
                 'custom_fields' => $this->get_custom_fields($post_ID),
+                'wp_post_format' => $post_format,
                 'sticky' => $sticky
             );
@@ -2741 +2799 @@
             if ( $entry['post_status'] === 'future' )
                 $entry['post_status'] = 'publish';
+                
+            // Get post format 
+            $post_format = get_post_format( $entry['ID'] );
+            if ( empty( $post_format ) )
+                $post_format = 'default';
 
             $struct[] = array(
@@ -2764 +2827 @@
                 'date_created_gmt' => new IXR_Date($post_date_gmt),
                 'post_status' => $entry['post_status'],
-                'custom_fields' => $this->get_custom_fields($entry['ID'])
+                'custom_fields' => $this->get_custom_fields($entry['ID']),
+                'wp_post_format' => $post_format
             );