Changeset 47122 for trunk/tests/phpunit/tests/taxonomy.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/tests/phpunit/tests/taxonomy.php (modified) (12 diffs)

trunk/tests/phpunit/tests/taxonomy.php

@@ -17 +17 @@
      */
     function test_get_unknown_taxonomies() {
-        // taxonomies for an unknown object type
+        // Taxonomies for an unknown object type.
         $this->assertEquals( array(), get_object_taxonomies( rand_str() ) );
         $this->assertEquals( array(), get_object_taxonomies( '' ) );
@@ -27 +27 @@
         foreach ( get_object_taxonomies( 'post' ) as $taxonomy ) {
             $tax = get_taxonomy( $taxonomy );
-            // should return an object with the correct taxonomy object type
+            // Should return an object with the correct taxonomy object type.
             $this->assertTrue( is_object( $tax ) );
             $this->assertTrue( is_array( $tax->object_type ) );
@@ -109 +109 @@
         foreach ( get_object_taxonomies( 'link' ) as $taxonomy ) {
             $tax = get_taxonomy( $taxonomy );
-            // should return an object with the correct taxonomy object type
+            // Should return an object with the correct taxonomy object type.
             $this->assertTrue( is_object( $tax ) );
             $this->assertTrue( is_array( $tax->object_type ) );
@@ -144 +144 @@
     function test_register_taxonomy() {
 
-        // make up a new taxonomy name, and ensure it's unused
+        // Make up a new taxonomy name, and ensure it's unused.
         $tax = rand_str();
         $this->assertFalse( taxonomy_exists( $tax ) );
@@ -152 +152 @@
         $this->assertFalse( is_taxonomy_hierarchical( $tax ) );
 
-        // clean up
+        // Clean up.
         unset( $GLOBALS['wp_taxonomies'][ $tax ] );
     }
@@ -158 +158 @@
     function test_register_hierarchical_taxonomy() {
 
-        // make up a new taxonomy name, and ensure it's unused
+        // Make up a new taxonomy name, and ensure it's unused.
         $tax = rand_str();
         $this->assertFalse( taxonomy_exists( $tax ) );
@@ -166 +166 @@
         $this->assertTrue( is_taxonomy_hierarchical( $tax ) );
 
-        // clean up
+        // Clean up.
         unset( $GLOBALS['wp_taxonomies'][ $tax ] );
     }
@@ -219 +219 @@
      */
     function test_registering_taxonomies_to_object_types() {
-        // Create a taxonomy to test with
+        // Create a taxonomy to test with.
         $tax = 'test_tax';
         $this->assertFalse( taxonomy_exists( $tax ) );
         register_taxonomy( $tax, 'post', array( 'hierarchical' => true ) );
 
-        // Create a post type to test with
+        // Create a post type to test with.
         $post_type = 'test_cpt';
         $this->assertFalse( get_post_type( $post_type ) );
         $this->assertObjectHasAttribute( 'name', register_post_type( $post_type ) );
 
-        // Core taxonomy, core post type
+        // Core taxonomy, core post type.
         $this->assertTrue( unregister_taxonomy_for_object_type( 'category', 'post' ) );
         $this->assertFalse( unregister_taxonomy_for_object_type( 'category', 'post' ) );
         $this->assertTrue( register_taxonomy_for_object_type( 'category', 'post' ) );
 
-        // Core taxonomy, non-core post type
+        // Core taxonomy, non-core post type.
         $this->assertTrue( register_taxonomy_for_object_type( 'category', $post_type ) );
         $this->assertTrue( unregister_taxonomy_for_object_type( 'category', $post_type ) );
@@ -240 +240 @@
         $this->assertTrue( register_taxonomy_for_object_type( 'category', $post_type ) );
 
-        // Core taxonomies, non-post object types
+        // Core taxonomies, non-post object types.
         $this->assertFalse( register_taxonomy_for_object_type( 'category', 'user' ) );
         $this->assertFalse( unregister_taxonomy_for_object_type( 'category', 'user' ) );
 
-        // Non-core taxonomy, core post type
+        // Non-core taxonomy, core post type.
         $this->assertTrue( unregister_taxonomy_for_object_type( $tax, 'post' ) );
         $this->assertFalse( unregister_taxonomy_for_object_type( $tax, 'post' ) );
         $this->assertTrue( register_taxonomy_for_object_type( $tax, 'post' ) );
 
-        // Non-core taxonomy, non-core post type
+        // Non-core taxonomy, non-core post type.
         $this->assertTrue( register_taxonomy_for_object_type( $tax, $post_type ) );
         $this->assertTrue( unregister_taxonomy_for_object_type( $tax, $post_type ) );
@@ -255 +255 @@
         $this->assertTrue( register_taxonomy_for_object_type( $tax, $post_type ) );
 
-        // Non-core taxonomies, non-post object types
+        // Non-core taxonomies, non-post object types.
         $this->assertFalse( register_taxonomy_for_object_type( $tax, 'user' ) );
         $this->assertFalse( unregister_taxonomy_for_object_type( $tax, 'user' ) );
@@ -397 +397 @@
         $post = self::factory()->post->create_and_get();
 
-        // in_category() returns false when first parameter is empty()
+        // in_category() returns false when first parameter is empty().
         $this->assertFalse( in_category( '', $post ) );
         $this->assertFalse( in_category( false, $post ) );
         $this->assertFalse( in_category( null, $post ) );
 
-        // Test expected behavior of in_category()
+        // Test expected behavior of in_category().
         $term = wp_insert_term( 'Test', 'category' );
         wp_set_object_terms( $post->ID, $term['term_id'], 'category' );
@@ -948 +948 @@
                 'tax_input' => array(
                     $taxonomy_name => array(
-                        (string) $term_id, // Cast term_id as string to match whats sent in WP Admin.
+                        (string) $term_id, // Cast term_id as string to match what's sent in WP Admin.
                     ),
                 ),