Changeset 14705

Timestamp:

03/13/2026 06:09:29 AM (14 hours ago)

Author:

dd32

Message:

Plugin Directory: Rest API: Expose the raw metadata behind public data on the plugin post type.

This allows for local development environment to import plugins without parsing APIs that generate content from it.
This results in a more complete import, and less parsing issues.

See ​https://github.com/WordPress/wordpress.org/pull/555

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• api/class-base.php (modified) (3 diffs)
• api/class-plugin-fields.php (added)
• api/fields (deleted)
• class-plugin-directory.php (modified) (5 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.php

@@ -3 +3 @@
 
 use WordPressdotorg\Plugin_Directory\Plugin_Directory;
-use WordPressdotorg\Plugin_Directory\Plugin_I18n;
-use WordPressdotorg\Plugin_Directory\Template;
 
 /**
@@ -15 +13 @@
     public static function init() {
         self::load_routes();
-        self::load_fields();
     }
 
@@ -40 +37 @@
         new Routes\Plugin_Blueprint();
         new Routes\Plugin_Review();
-    }
-
-    /**
-     * Loads all API field for existing WordPress object types we offer.
-     */
-    public static function load_fields() {
-        new Fields\Plugin\Banners();
-        new Fields\Plugin\Icons();
-        new Fields\Plugin\Rating();
-        new Fields\Plugin\Ratings();
-        new Fields\Plugin\Screenshots();
     }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php

@@ -220 +220 @@
             'public'            => true,
             'show_ui'           => true,
+            'show_in_rest'      => true,
             'show_admin_column' => false,
             'capabilities'      => array(
@@ -253 +254 @@
             'public'            => true,
             'show_ui'           => true,
+            'show_in_rest'      => true,
             'show_admin_column' => true,
             'meta_box_cb'       => false,
@@ -280 +282 @@
             'public'            => true,
             'show_ui'           => true,
+            'show_in_rest'      => true,
             'show_admin_column' => false,
             'capabilities'      => array(
@@ -298 +301 @@
             'public'            => true,
             'show_ui'           => true,
+            'show_in_rest'      => true,
             'show_admin_column' => true,
             'capabilities'      => array(
@@ -405 +409 @@
         ) );
 
-        /**
-         * TODO
-         * Use register_rest_field() to add array and object meta data to the API:
-         * ratings, upgrade_notice, contributors, screenshots, sections, assets_screenshots,
-         * assets_icons, assets_banners,
-         */
-
-        register_meta( 'post', 'rating', array(
-            'type'         => 'number',
-            'description'  => __( 'Overall rating of the plugin.', 'wporg-plugins' ),
-            'single'       => true,
-            // todo 'sanitize_callback' => 'absint',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'active_installs', array(
-            'type'              => 'integer',
-            'description'       => __( 'Number of installations.', 'wporg-plugins' ),
-            'single'            => true,
-            'sanitize_callback' => 'absint',
-            'show_in_rest'      => true,
-        ) );
-
-        register_meta( 'post', 'downloads', array(
-            'type'              => 'integer',
-            'description'       => __( 'Number of downloads.', 'wporg-plugins' ),
-            'single'            => true,
-            'sanitize_callback' => 'absint',
-            'show_in_rest'      => true,
-        ) );
-
-        register_meta( 'post', 'tested', array(
-            'description'  => __( 'The version of WordPress the plugin was tested with.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'absint',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'requires', array(
-            'description'  => __( 'The minimum version of WordPress the plugin needs to run.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'absint',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'requires_php', array(
-            'description'  => __( 'The minimum version of PHP the plugin needs to run.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'absint',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'stable_tag', array(
-            'description'  => __( 'Stable version of the plugin.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'absint',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'donate_link', array(
-            'description'       => __( 'Link to donate to the plugin.', 'wporg-plugins' ),
-            'single'            => true,
-            'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest'      => true,
-        ) );
-
-        register_meta( 'post', 'version', array(
-            'description'  => __( 'Current stable version.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'header_name', array(
-            'description'  => __( 'Name of the plugin.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'header_plugin_uri', array(
-            'description'       => __( 'URL to the homepage of the plugin.', 'wporg-plugins' ),
-            'single'            => true,
-            'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest'      => true,
-        ) );
-
-        register_meta( 'post', 'header_name', array(
-            'description'  => __( 'Name of the plugin.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'header_author', array(
-            'description'  => __( 'Name of the plugin author.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'header_author_uri', array(
-            'description'       => __( 'URL to the homepage of the author.', 'wporg-plugins' ),
-            'single'            => true,
-            'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest'      => true,
-        ) );
-
-        register_meta( 'post', 'header_description', array(
-            'description'  => __( 'Description of the plugin.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'assets_icons', array(
-            'type'         => 'UserDefinedarray',
-            'description'  => __( 'Icon images of the plugin.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'assets_banners_color', array(
-            'description'  => __( 'Fallback color for the plugin.', 'wporg-plugins' ),
-            'single'       => true,
-            // TODO 'sanitize_callback' => 'esc_url_raw',
-            'show_in_rest' => true,
-        ) );
-
-        register_meta( 'post', 'support_threads', array(
-            'type'              => 'integer',
-            'description'       => __( 'Amount of support threads for the plugin.', 'wporg-plugins' ),
-            'single'            => true,
-            'sanitize_callback' => 'absint',
-            'show_in_rest'      => true,
-        ) );
-
-        register_meta( 'post', 'support_threads_resolved', array(
-            'type'              => 'integer',
-            'description'       => __( 'Amount of resolved support threads for the plugin.', 'wporg-plugins' ),
-            'single'            => true,
-            'sanitize_callback' => 'absint',
-            'show_in_rest'      => true,
-        ) );
+        API\Plugin_Fields::register();
 
         // Add the browse/* views.