Changeset 62075

Timestamp:

03/20/2026 03:25:02 PM (2 months ago)

Author:

ellatrix

Message:

Real-time collaboration: Add WP_ALLOW_COLLABORATION constant.

This provides an easy way at config level to disable real-time collaboration.

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

See #64904.
Props alecgeatches, ingeniumed, zieladam, peterwilsoncc, tyxla.

Location:

trunk/src

Files:

• wp-admin/options-writing.php (modified) (1 diff)
• wp-includes/collaboration.php (modified) (2 diffs)
• wp-includes/default-constants.php (modified) (1 diff)
• wp-includes/post.php (modified) (2 diffs)
• wp-includes/rest-api.php (modified) (1 diff)
• wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php (modified) (1 diff)

trunk/src/wp-admin/options-writing.php

@@ -113 +113 @@
 <th scope="row"><?php _e( 'Collaboration' ); ?></th>
 <td>
-    <label for="wp_collaboration_enabled">
-        <input name="wp_collaboration_enabled" type="checkbox" id="wp_collaboration_enabled" value="1" <?php checked( '1', (bool) get_option( 'wp_collaboration_enabled' ) ); ?> />
-        <?php _e( 'Enable real-time collaboration' ); ?>
-    </label>
+    <?php if ( ! defined( 'WP_ALLOW_COLLABORATION' ) || true === WP_ALLOW_COLLABORATION ) : ?>
+        <div class="notice notice-warning inline">
+            <p><?php _e( '<strong>Note:</strong> Real-time collaboration has been disabled.' ); ?></p>
+        </div>
+    <?php else : ?>
+        <label for="wp_collaboration_enabled">
+            <input name="wp_collaboration_enabled" type="checkbox" id="wp_collaboration_enabled" value="1" <?php checked( '1', (bool) get_option( 'wp_collaboration_enabled' ) ); ?> />
+            <?php _e( 'Enable real-time collaboration' ); ?>
+        </label>
+    <?php endif; ?>
 </td>
 </tr>

trunk/src/wp-includes/collaboration.php

@@ -6 +6 @@
  * @since 7.0.0
  */
+
+/**
+ * Determines whether real-time collaboration is enabled.
+ *
+ * If the WP_ALLOW_COLLABORATION constant is false,
+ * collaboration is always disabled regardless of the database option.
+ * Otherwise, falls back to the 'wp_collaboration_enabled' option.
+ *
+ * @since 7.0.0
+ *
+ * @return bool Whether real-time collaboration is enabled.
+ */
+function wp_is_collaboration_enabled() {
+    if ( ! defined( 'WP_ALLOW_COLLABORATION' ) || ! WP_ALLOW_COLLABORATION ) {
+        return false;
+    }
+
+    return (bool) get_option( 'wp_collaboration_enabled' );
+}
 
 /**
@@ -19 +38 @@
     global $pagenow;
 
-    if ( ! (bool) get_option( 'wp_collaboration_enabled' ) ) {
+    if ( ! wp_is_collaboration_enabled() ) {
         return;
     }

trunk/src/wp-includes/default-constants.php

@@ -399 +399 @@
         define( 'WP_CRON_LOCK_TIMEOUT', MINUTE_IN_SECONDS );
     }
+
+    /**
+     * Whether real time collaboration is permitted to be enabled.
+     *
+     * @since 7.0.0
+     */
+    if ( ! defined( 'WP_ALLOW_COLLABORATION' ) ) {
+        $env_value = getenv( 'WP_ALLOW_COLLABORATION' );
+        if ( false === $env_value ) {
+            // Environment variable is not defined, default to allowing collaboration.
+            define( 'WP_ALLOW_COLLABORATION', true );
+        } else {
+            /*
+             * Environment variable is defined, let's confirm it is actually set to
+             * "true" as it may still have a string value "false" – the preceeding
+             * `if` branch only tests for the boolean `false`.
+             */
+            define( 'WP_ALLOW_COLLABORATION', 'true' === $env_value );
+        }
+    }
 }
 

trunk/src/wp-includes/post.php

@@ -658 +658 @@
     );
 
-    if ( (bool) get_option( 'wp_collaboration_enabled' ) ) {
+    if ( wp_is_collaboration_enabled() ) {
         register_post_type(
             'wp_sync_storage',
@@ -8673 +8673 @@
     );
 
-    if ( (bool) get_option( 'wp_collaboration_enabled' ) ) {
+    if ( wp_is_collaboration_enabled() ) {
         register_meta(
             'post',

trunk/src/wp-includes/rest-api.php

@@ -431 +431 @@
 
     // Collaboration.
-    if ( (bool) get_option( 'wp_collaboration_enabled' ) ) {
+    if ( wp_is_collaboration_enabled() ) {
         $sync_storage = new WP_Sync_Post_Meta_Storage();
         $sync_server  = new WP_HTTP_Polling_Sync_Server( $sync_storage );

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php

@@ -255 +255 @@
          *   document, which can lead to duplicate inserts or deletions.
          */
-        $is_collaboration_enabled = (bool) get_option( 'wp_collaboration_enabled' );
+        $is_collaboration_enabled = wp_is_collaboration_enabled();
 
         if ( $is_draft && (int) $post->post_author === $user_id && ! $post_lock && ! $is_collaboration_enabled ) {