Changeset 63603

Timestamp:

09/11/2026 04:50:51 PM (14 hours ago)

Author:

spacedmonkey

Message:

Meta: Support site meta subtype in get_object_subtype().

Add a 'blog' case to get_object_subtype() so register_meta() can resolve
subtypes for site meta, matching the support already in place for posts,
terms, comments, and users.

Introduce register_site_meta() and unregister_site_meta() wrapper
functions for registering and unregistering meta for sites, consistent
with the existing site meta wrapper functions.

Props sainathpoojary, spacedmonkey, flixos90, johnbillion.
Fixes #44387.

Location:

trunk

Files:

• src/wp-includes/meta.php (modified) (2 diffs)
• src/wp-includes/ms-site.php (modified) (1 diff)
• tests/phpunit/tests/meta/registerMeta.php (modified) (5 diffs)

trunk/src/wp-includes/meta.php

@@ -1790 +1790 @@
  *
  * @since 4.9.8
+ * @since 7.2.0 Added support for 'blog' object type in multisite.
  *
  * @param string $object_type Type of object metadata is for. Accepts 'blog', 'post', 'comment', 'term',
@@ -1835 +1836 @@
                         $object_subtype = 'user';
                         break;
+
+                case 'blog':
+                        if ( ! is_multisite() || $object_id <= 0 ) {
+                                break;
+                        }
+
+                        $site = get_site( $object_id );
+                        if ( ! $site ) {
+                                break;
+                        }
+
+                        $object_subtype = 'blog';
+                        break;
         }
 

trunk/src/wp-includes/ms-site.php

@@ -1131 +1131 @@
 
 /**
+ * Registers a meta key for sites.
+ *
+ * @since 7.2.0
+ *
+ * @param string $meta_key The meta key to register.
+ * @param array  $args     Data used to describe the meta key when registered. See
+ *                         {@see register_meta()} for a list of supported arguments.
+ * @return bool True if the meta key was successfully registered, false if not.
+ */
+function register_site_meta( $meta_key, array $args ) {
+        return register_meta( 'blog', $meta_key, $args );
+}
+
+/**
+ * Unregisters a meta key for sites.
+ *
+ * @since 7.2.0
+ *
+ * @param string $meta_key The meta key to unregister.
+ * @return bool True on success, false if the meta key was not previously registered.
+ */
+function unregister_site_meta( $meta_key ) {
+        return unregister_meta_key( 'blog', $meta_key );
+}
+
+/**
  * Updates the count of sites for a network based on a changed site.
  *

trunk/tests/phpunit/tests/meta/registerMeta.php

@@ -9 +9 @@
         protected static $comment_id;
         protected static $user_id;
+        protected static $blog_id;
 
         public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
@@ -15 +16 @@
                 self::$comment_id = $factory->comment->create();
                 self::$user_id    = $factory->user->create();
+
+                if ( is_multisite() ) {
+                        self::$blog_id = $factory->blog->create();
+                }
         }
 
@@ -22 +27 @@
                 wp_delete_comment( self::$comment_id, true );
                 self::delete_user( self::$user_id );
+
+                if ( is_multisite() ) {
+                        wp_delete_site( self::$blog_id );
+                        wp_update_network_site_counts();
+                }
         }
 
@@ -1107 +1117 @@
 
         /**
+         * @ticket 44387
+         * @group ms-required
+         */
+        public function test_get_object_subtype_for_blog_returns_blog_when_site_exists() {
+                $this->assertSame( 'blog', get_object_subtype( 'blog', self::$blog_id ) );
+        }
+
+        /**
+         * @ticket 44387
+         * @group ms-required
+         */
+        public function test_get_object_subtype_for_blog_returns_empty_string_for_invalid_site() {
+                $this->assertSame( '', get_object_subtype( 'blog', 0 ) );
+                $this->assertSame( '', get_object_subtype( 'blog', 999999 ) );
+        }
+
+        /**
+         * @ticket 44387
+         * @group ms-excluded
+         */
+        public function test_get_object_subtype_for_blog_returns_empty_string_no_multisite() {
+                $this->assertSame( '', get_object_subtype( 'blog', 0 ) );
+        }
+
+        /**
+         * @ticket 44387
+         * @group ms-required
+         */
+        public function test_get_object_subtype_for_blog_with_registered_meta() {
+                if ( ! is_site_meta_supported() ) {
+                        $this->markTestSkipped( 'Test only runs with the blogmeta database table installed.' );
+                }
+
+                $this->assertSame( 'blog', get_object_subtype( 'blog', self::$blog_id ) );
+
+                register_meta(
+                        'blog',
+                        'site_rating',
+                        array(
+                                'single'         => true,
+                                'object_subtype' => 'blog',
+                        )
+                );
+                add_site_meta( self::$blog_id, 'site_rating', '5' );
+
+                $meta = get_registered_metadata( 'blog', self::$blog_id, 'site_rating' );
+
+                unregister_meta_key( 'blog', 'site_rating', 'blog' );
+                delete_site_meta( self::$blog_id, 'site_rating' );
+
+                $this->assertSame( '5', $meta );
+        }
+
+        /**
          * Test that attempting to register meta with revisions_enabled set to true on a
          * post type that does not have revisions enabled fails and throws a `doing_it_wrong` notice.
@@ -1136 +1200 @@
                 $this->assertFalse( $register );
         }
+
+        /**
+         * @ticket 44387
+         * @group ms-required
+         */
+        public function test_register_site_meta_returns_true_on_success() {
+                if ( ! is_site_meta_supported() ) {
+                        $this->markTestSkipped( 'Test only runs with the blogmeta database table installed.' );
+                }
+
+                $result = register_site_meta( 'test_site_meta_key', array( 'single' => true ) );
+                unregister_site_meta( 'test_site_meta_key' );
+
+                $this->assertTrue( $result );
+        }
+
+        /**
+         * @ticket 44387
+         * @group ms-required
+         */
+        public function test_unregister_site_meta_returns_true_on_success() {
+                if ( ! is_site_meta_supported() ) {
+                        $this->markTestSkipped( 'Test only runs with the blogmeta database table installed.' );
+                }
+
+                register_site_meta( 'test_site_meta_key', array( 'single' => true ) );
+                $result = unregister_site_meta( 'test_site_meta_key' );
+
+                $this->assertTrue( $result );
+        }
 }