Changeset 42729

Timestamp:

02/22/2018 12:24:00 AM (7 years ago)

Author:

pento

Message:

REST API: Show taxonomy visibility settings.

For Gutenberg and other admin-type interfaces, it's useful to be able to see the visibility settings for taxonomies.

Props joehoyle, pento.
Fixes #42707.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-taxonomies-controller.php (modified) (4 diffs)

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

@@ -192 +192 @@
             'hierarchical' => $taxonomy->hierarchical,
             'rest_base'    => $base,
+            'visibility'   => array(
+                'public'             => (bool) $taxonomy->public,
+                'publicly_queryable' => (bool) $taxonomy->publicly_queryable,
+                'show_admin_column'  => (bool) $taxonomy->show_admin_column,
+                'show_in_nav_menus'  => (bool) $taxonomy->show_in_nav_menus,
+                'show_in_quick_edit' => (bool) $taxonomy->show_in_quick_edit,
+                'show_ui'            => (bool) $taxonomy->show_ui,
+            ),
         );
 
@@ -296 +304 @@
                     'readonly'    => true,
                 ),
+                'visibility'   => array(
+                    'description' => __( 'The visibility settings for the taxomonmy.' ),
+                    'type'        => 'object',
+                    'context'     => array( 'edit' ),
+                    'readonly'    => true,
+                    'properties'  => array(
+                        'public'             => array(
+                            'description' => 'Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users.',
+                            'type'        => 'boolean',
+                        ),
+                        'publicly_queryable' => array(
+                            'description' => 'Whether the taxonomy is publicly queryable.',
+                            'type'        => 'boolean',
+                        ),
+                        'show_ui'            => array(
+                            'description' => 'Whether to generate a default UI for managing this taxonomy.',
+                            'type'        => 'boolean',
+                        ),
+                        'show_admin_column'  => array(
+                            'description' => 'Whether to allow automatic creation of taxonomy columns on associated post-types table.',
+                            'type'        => 'boolean',
+                        ),
+                        'show_in_nav_menus'  => array(
+                            'description' => 'Whether to make the taxonomy available for selection in navigation menus.',
+                            'type'        => 'boolean',
+                        ),
+                        'show_in_quick_edit' => array(
+                            'description' => 'Whether to show the taxonomy in the quick/bulk edit panel.',
+                            'type'        => 'boolean',
+                        ),
+
+                    ),
+                ),
             ),
         );

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

@@ -124 +124 @@
     }
 
-        public function test_get_non_public_taxonomy_no_permission() {
+    public function test_get_non_public_taxonomy_no_permission() {
         wp_set_current_user( self::$contributor_id );
         register_taxonomy( 'api-private', 'post', array( 'public' => false ) );
@@ -168 +168 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertEquals( 9, count( $properties ) );
+        $this->assertEquals( 10, count( $properties ) );
         $this->assertArrayHasKey( 'capabilities', $properties );
         $this->assertArrayHasKey( 'description', $properties );
@@ -177 +177 @@
         $this->assertArrayHasKey( 'show_cloud', $properties );
         $this->assertArrayHasKey( 'types', $properties );
+        $this->assertArrayHasKey( 'visibility', $properties );
         $this->assertArrayHasKey( 'rest_base', $properties );
     }
@@ -210 +211 @@
             $this->assertEquals( $tax_obj->labels, $data['labels'] );
             $this->assertEquals( $tax_obj->show_tagcloud, $data['show_cloud'] );
+
+            $this->assertEquals( $tax_obj->public, $data['visibility']['public'] );
+            $this->assertEquals( $tax_obj->publicly_queryable, $data['visibility']['publicly_queryable'] );
+            $this->assertEquals( $tax_obj->show_admin_column, $data['visibility']['show_admin_column'] );
+            $this->assertEquals( $tax_obj->show_in_nav_menus, $data['visibility']['show_in_nav_menus'] );
+            $this->assertEquals( $tax_obj->show_in_quick_edit, $data['visibility']['show_in_quick_edit'] );
+            $this->assertEquals( $tax_obj->show_ui, $data['visibility']['show_ui'] );
         } else {
             $this->assertFalse( isset( $data['capabilities'] ) );
             $this->assertFalse( isset( $data['labels'] ) );
             $this->assertFalse( isset( $data['show_cloud'] ) );
+            $this->assertFalse( isset( $data['visibility'] ) );
         }
     }