Changeset 62288 for trunk

Timestamp:

04/30/2026 12:16:22 PM (8 weeks ago)

Author:

jorgefilipecosta

Message:

Connectors: Add is_active callback support to plugin registration.

Adds an optional is_active callable to the plugin definition accepted by
WP_Connector_Registry::register(). The callback receives no arguments, must
return a boolean, and is used by the Connectors screen to decide whether a
connector's backing plugin is currently active. When omitted, it defaults to
__return_true; when provided but not callable, registration fails with a
_doing_it_wrong() notice.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/11565

Props iamadisingh, jorgefilipecosta, mukesh27, gziolo.
Fixes #65020.

Location:

trunk

Files:

• src/wp-includes/class-wp-connector-registry.php (modified) (3 diffs)
• src/wp-includes/connectors.php (modified) (3 diffs)
• tests/phpunit/tests/connectors/wpConnectorRegistry.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-connector-registry.php

@@ -41 +41 @@
  *     },
  *     plugin?: array{
- *         file: non-empty-string
+ *         file: non-empty-string,
+ *         is_active?: callable(): bool
  *     }
  * }
@@ -110 +111 @@
      *         Optional. Plugin data for install/activate UI.
      *
-     *         @type string $file The plugin's main file path relative to the plugins
-     *                            directory (e.g. 'my-plugin/my-plugin.php' or 'hello.php').
+     *         @type string   $file      Optional. The plugin's main file path relative to the
+     *                                   plugins directory (e.g. 'my-plugin/my-plugin.php' or
+     *                                   'hello.php').
+     *         @type callable $is_active Optional callback to determine whether the plugin
+     *                                   is active. Receives no arguments and must return bool.
+     *                                   Defaults to `__return_true`.
      *     }
      * }
@@ -244 +249 @@
         }
 
-        if ( ! empty( $args['plugin'] ) && is_array( $args['plugin'] ) && ! empty( $args['plugin']['file'] ) ) {
-            $connector['plugin'] = array( 'file' => $args['plugin']['file'] );
+        $connector['plugin'] = array();
+
+        if ( ! empty( $args['plugin'] ) && is_array( $args['plugin'] ) ) {
+            if ( ! empty( $args['plugin']['file'] ) ) {
+                $connector['plugin']['file'] = $args['plugin']['file'];
+            }
+
+            if ( isset( $args['plugin']['is_active'] ) ) {
+                if ( ! is_callable( $args['plugin']['is_active'] ) ) {
+                    _doing_it_wrong(
+                        __METHOD__,
+                        /* translators: %s: Connector ID. */
+                        sprintf( __( 'Connector "%s" plugin is_active must be callable.' ), esc_html( $id ) ),
+                        '7.0.0'
+                    );
+                    return null;
+                }
+
+                $connector['plugin']['is_active'] = $args['plugin']['is_active'];
+            }
+        }
+
+        if ( ! isset( $connector['plugin']['is_active'] ) ) {
+            $connector['plugin']['is_active'] = '__return_true';
         }
 

trunk/src/wp-includes/connectors.php

@@ -368 +368 @@
             }
         }
+
+        if ( ! isset( $args['plugin']['is_active'] ) ) {
+            $args['plugin']['is_active'] = static function () use ( $ai_registry, $id ): bool {
+                try {
+                    return $ai_registry->hasProvider( $id );
+                } catch ( Exception $e ) {
+                    return false;
+                }
+            };
+        }
+
         $registry->register( $id, $args );
     }
@@ -639 +650 @@
     $registry = AiClient::defaultRegistry();
 
-    if ( ! function_exists( 'is_plugin_active' ) ) {
-        require_once ABSPATH . 'wp-admin/includes/plugin.php';
-    }
-
     $connectors = array();
     foreach ( wp_get_connectors() as $connector_id => $connector_data ) {
@@ -675 +682 @@
         if ( ! empty( $connector_data['plugin']['file'] ) ) {
             $file         = $connector_data['plugin']['file'];
-            $is_installed = file_exists( wp_normalize_path( WP_PLUGIN_DIR . '/' . $file ) );
-            $is_activated = $is_installed && is_plugin_active( $file );
+            $is_activated = (bool) call_user_func( $connector_data['plugin']['is_active'] );
+            $is_installed = $is_activated || file_exists( wp_normalize_path( WP_PLUGIN_DIR . '/' . $file ) );
 
             $connector_out['plugin'] = array(

trunk/tests/phpunit/tests/connectors/wpConnectorRegistry.php

@@ -300 +300 @@
 
         $this->assertArrayHasKey( 'plugin', $result );
-        $this->assertSame( array( 'file' => 'my-plugin/my-plugin.php' ), $result['plugin'] );
-    }
-
-    /**
-     * @ticket 64791
-     */
-    public function test_register_omits_plugin_when_not_provided() {
+        $this->assertSame( 'my-plugin/my-plugin.php', $result['plugin']['file'] );
+    }
+
+    /**
+     * @ticket 65020
+     */
+    public function test_register_stores_plugin_is_active_callback() {
+        $args           = self::$default_args;
+        $args['plugin'] = array(
+            'file'      => 'my-plugin/my-plugin.php',
+            'is_active' => '__return_true',
+        );
+
+        $result = $this->registry->register( 'with-callback', $args );
+
+        $this->assertIsArray( $result );
+        $this->assertArrayHasKey( 'is_active', $result['plugin'] );
+        $this->assertIsCallable( $result['plugin']['is_active'] );
+    }
+
+    /**
+     * @ticket 65020
+     */
+    public function test_register_rejects_non_callable_plugin_is_active() {
+        $this->setExpectedIncorrectUsage( 'WP_Connector_Registry::register' );
+
+        $args           = self::$default_args;
+        $args['plugin'] = array(
+            'file'      => 'my-plugin/my-plugin.php',
+            'is_active' => 'not_a_real_function_name',
+        );
+
+        $result = $this->registry->register( 'bad-callback', $args );
+
+        $this->assertNull( $result );
+    }
+
+    /**
+     * @ticket 65020
+     */
+    public function test_register_defaults_plugin_is_active_to_return_true() {
+        $args           = self::$default_args;
+        $args['plugin'] = array( 'file' => 'my-plugin/my-plugin.php' );
+
+        $result = $this->registry->register( 'default-callback', $args );
+
+        $this->assertIsArray( $result );
+        $this->assertArrayHasKey( 'is_active', $result['plugin'] );
+        $this->assertSame( '__return_true', $result['plugin']['is_active'] );
+    }
+
+    /**
+     * @ticket 64791
+     */
+    public function test_register_defaults_plugin_when_not_provided() {
         $result = $this->registry->register( 'no-plugin', self::$default_args );
 
-        $this->assertArrayNotHasKey( 'plugin', $result );
+        $this->assertArrayHasKey( 'plugin', $result );
+        $this->assertArrayNotHasKey( 'file', $result['plugin'] );
+        $this->assertSame( '__return_true', $result['plugin']['is_active'] );
     }