Changeset 39620

Timestamp:

12/20/2016 12:55:04 AM (8 years ago)

Author:

jnylen0

Message:

REST API: Fix PHP warnings when get_theme_support( 'post-formats' ) is not an array.

If add_theme_support( 'post-formats' ) is called with no additional
arguments, then get_theme_support( 'post-formats' ) returns true rather
than an array of supported formats. Avoid generating PHP warnings in this
situation.

Props dreamon11, ChopinBach.
Fixes #39293.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -1924 +1924 @@
                 case 'post-formats':
                     $supports_formats = get_theme_support( 'post-formats' );
+
+                    // Force to an array. Supports formats can return true even if empty in some cases.
+                    $supports_formats = is_array( $supports_formats ) ? array_values( $supports_formats[0] ) : array();
+
+                    $supported_formats = array_merge( array( 'standard' ), $supports_formats );
+
                     $schema['properties']['format'] = array(
                         'description' => __( 'The format for the object.' ),
                         'type'        => 'string',
-                        'enum'        => array_merge( array( 'standard' ), $supports_formats ? array_values( $supports_formats[0] ) : array() ),
+                        'enum'        => $supported_formats,
                         'context'     => array( 'view', 'edit' ),
                     );

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -857 +857 @@
         $this->assertCount( 1, $data );
         $this->assertEquals( $post2, $data[0]['id'] );
+    }
+
+    public function test_get_items_no_supported_post_formats() {
+        // This causes get_theme_support( 'post-formats' ) to return `true` (not an array)
+        add_theme_support( 'post-formats' );
+
+        $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts' );
+        $response = $this->server->dispatch( $request );
+        $data = $response->get_data();
+
+        // Set the expected state back for the rest of the tests.
+        global $_wp_theme_features;
+        unset( $_wp_theme_features['post-formats'] );
+        add_theme_support( 'post-formats', array( 'post', 'gallery' ) );
+
+        $formats = array( 'standard' );
+
+        $this->assertEquals( $formats, $data['schema']['properties']['format']['enum'] );
     }