Changeset 38292

Timestamp:

08/20/2016 05:34:13 PM (10 years ago)

Author:

boonebgorges

Message:

Allow attachment taxonomies to be fetched as objects.

By adding the $output parameter to get_attachment_taxonomies(), the
function signature matches that of get_object_taxonomies(). The change
also allows for more consistent behavior when passing output=objects
to get_object_taxonomies() for the 'attachment' object type, since
the $output parameter is now passed through the function stack.

Props codemovement.pk.
See #37368.

Location:

trunk

Files:

• src/wp-includes/media.php (modified) (2 diffs)
• src/wp-includes/taxonomy.php (modified) (1 diff)
• tests/phpunit/tests/media/getAttachmentTaxonomies.php (modified) (1 diff)
• tests/phpunit/tests/taxonomy/getObjectTaxonomies.php (modified) (1 diff)

trunk/src/wp-includes/media.php

@@ -2695 +2695 @@
  *
  * @since 2.5.0
+ * @since 4.7.0 Introduced the `$output` parameter.
  *
  * @param int|array|object $attachment Attachment ID, data array, or data object.
+ * @param string           $output     Output type. 'names' to return an array of taxonomy names,
+ *                                     or 'objects' to return an array of taxonomy objects.
+ *                                     Default is 'names'.
  * @return array Empty array on failure. List of taxonomies on success.
  */
-function get_attachment_taxonomies( $attachment ) {
+function get_attachment_taxonomies( $attachment, $output = 'names' ) {
         if ( is_int( $attachment ) ) {
                 $attachment = get_post( $attachment );
@@ -2724 +2728 @@
 
         $taxonomies = array();
-        foreach ( $objects as $object )
-                if ( $taxes = get_object_taxonomies($object) )
-                        $taxonomies = array_merge($taxonomies, $taxes);
+        foreach ( $objects as $object ) {
+                if ( $taxes = get_object_taxonomies( $object, $output ) ) {
+                        $taxonomies = array_merge( $taxonomies, $taxes );
+                }
+        }
 
         return array_unique($taxonomies);

trunk/src/wp-includes/taxonomy.php

@@ -182 +182 @@
         if ( is_object($object) ) {
                 if ( $object->post_type == 'attachment' )
-                        return get_attachment_taxonomies($object);
+                        return get_attachment_taxonomies( $object, $output );
                 $object = $object->post_type;
         }

trunk/tests/phpunit/tests/media/getAttachmentTaxonomies.php

@@ -80 +80 @@
                 $this->assertSame( $expected, $found );
         }
+
+        /**
+         * @ticket 37368
+         */
+        public function test_should_respect_output_objects() {
+                register_taxonomy( 'wptests_tax2', 'attachment:image' );
+
+                $a = self::factory()->attachment->create_object( 'image.jpg', 0, array(
+                        'post_mime_type' => 'image/jpeg',
+                        'post_type' => 'attachment'
+                ) );
+                $attachment = get_post( $a );
+
+                $found = get_attachment_taxonomies( $attachment, 'objects' );
+
+                $this->assertSame( array( 'wptests_tax2' ), array_keys( $found ) );
+                $this->assertInternalType( 'object', $found['wptests_tax2'] );
+                $this->assertSame( 'wptests_tax2', $found['wptests_tax2']->name );
+        }
 }

trunk/tests/phpunit/tests/taxonomy/getObjectTaxonomies.php

@@ -46 +46 @@
                 $this->assertSame( $expected, $found );
         }
+
+        /**
+         * @ticket 37368
+         */
+        public function test_should_return_all_attachment_taxonomies_for_attachment_object_type() {
+                register_taxonomy( 'wptests_tax2', 'attachment:image' );
+
+                $a = self::factory()->attachment->create_object( 'image.jpg', 0, array(
+                        'post_mime_type' => 'image/jpeg',
+                        'post_type' => 'attachment'
+                ) );
+                $attachment = get_post( $a );
+
+                $found = get_object_taxonomies( $attachment, 'names' );
+
+                $this->assertSame( array( 'wptests_tax2' ), $found );
+        }
+
+        /**
+         * @ticket 37368
+         */
+        public function test_should_respect_output_objects_when_object_is_attachment() {
+                register_taxonomy( 'wptests_tax2', 'attachment:image' );
+
+                $a = self::factory()->attachment->create_object( 'image.jpg', 0, array(
+                        'post_mime_type' => 'image/jpeg',
+                        'post_type' => 'attachment'
+                ) );
+                $attachment = get_post( $a );
+
+                $found = get_object_taxonomies( $attachment, 'objects' );
+
+                $this->assertSame( array( 'wptests_tax2' ), array_keys( $found ) );
+                $this->assertInternalType( 'object', $found['wptests_tax2'] );
+                $this->assertSame( 'wptests_tax2', $found['wptests_tax2']->name );
+        }
 }