Changeset 61983 for trunk/src/wp-includes/class-wp-connector-registry.php

Timestamp:

03/12/2026 07:54:50 AM (7 months ago)

Author:

gziolo

Message:

Connectors: Remove redundant helper and improve PHPDoc

Remove _wp_connectors_get_connector_settings() and inline ksort()
into _wp_connectors_get_connector_script_module_data(). Expand
@return and @phpstan-return array shapes for wp_get_connector()
and wp_get_connectors(). Make logo_url and credentials_url truly
optional. Rename test class to wpGetConnectors.

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

Follow-up to [61943].

Props gziolo, westonruter.
Fixes #64791.

File:

• trunk/src/wp-includes/class-wp-connector-registry.php (modified) (4 diffs)

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

@@ -17 +17 @@
  *
  * @phpstan-type Connector array{
- *     name: string,
- *     description: string,
- *     logo_url?: string|null,
- *     type: string,
+ *     name: non-empty-string,
+ *     description: non-empty-string,
+ *     logo_url?: non-empty-string,
+ *     type: 'ai_provider',
  *     authentication: array{
- *         method: string,
- *         credentials_url?: string|null,
- *         setting_name?: string
+ *         method: 'api_key'|'none',
+ *         credentials_url?: non-empty-string,
+ *         setting_name?: non-empty-string
  *     },
  *     plugin?: array{
- *         slug: string
+ *         slug: non-empty-string
  *     }
  * }
@@ -63 +63 @@
          *     @type string $name           Required. The connector's display name.
          *     @type string $description    Optional. The connector's description. Default empty string.
-         *     @type string|null $logo_url  Optional. URL to the connector's logo image. Default null.
+         *     @type string $logo_url       Optional. URL to the connector's logo image.
          *     @type string $type           Required. The connector type. Currently, only 'ai_provider' is supported.
          *     @type array  $authentication {
          *         Required. Authentication configuration.
          *
-         *         @type string      $method          Required. The authentication method: 'api_key' or 'none'.
-         *         @type string|null $credentials_url Optional. URL where users can obtain API credentials.
+         *         @type string $method          Required. The authentication method: 'api_key' or 'none'.
+         *         @type string $credentials_url Optional. URL where users can obtain API credentials.
          *     }
-         *     @type array  $plugin {
+         *     @type array  $plugin         {
          *         Optional. Plugin data for install/activate UI.
          *
@@ -159 +159 @@
 
                 if ( 'api_key' === $args['authentication']['method'] ) {
-                        $connector['authentication']['credentials_url'] = $args['authentication']['credentials_url'] ?? null;
-                        $connector['authentication']['setting_name']    = "connectors_ai_{$id}_api_key";
+                        if ( ! empty( $args['authentication']['credentials_url'] ) && is_string( $args['authentication']['credentials_url'] ) ) {
+                                $connector['authentication']['credentials_url'] = $args['authentication']['credentials_url'];
+                        }
+                        $connector['authentication']['setting_name'] = "connectors_ai_{$id}_api_key";
                 }
 
@@ -207 +209 @@
          * @see wp_get_connectors()
          *
-         * @return array<string, array> The array of registered connectors keyed by connector ID.
+         * @return array Connector settings keyed by connector ID.
+         *
          * @phpstan-return array<string, Connector>
          */