Real-time collaboration: Rename option for positive intent.

This reverts the real time collaboration option name back to `wp_enable_real_time_collaboration` to avoid the need to turn on a checkbox in order to turn off the feature. This is to reduce the cognitive load on both users and developers of an on is off paradigm.

To ensure Real Time Collaboration is enabled prior to the upgrade routine running on multi-site installs, the option default is filtered on the `default_option_wp_enable_real_time_collaboration` hook to enable the option by default.

Developed in: #11161
Follow up to r61828.

Props peterwilsoncc, czarate, sergeybiryukov.
Fixes #64622.


git-svn-id: https://develop.svn.wordpress.org/trunk@61833 602fd350-edb4-49c9-b593-d223f7449a82

Author: peterwilsoncc

src/wp-admin/includes/schema.php

@@ -563,6 +563,9 @@ function populate_options( array $options = array() ) {
 
 		// 6.9.0
 		'wp_notes_notify'                   => 1,
+
+		// 7.0.0
+		'wp_enable_real_time_collaboration' => 1,
 	);
 
 	// 3.3.0

src/wp-admin/options-writing.php

@@ -110,10 +110,10 @@
 </td>
 </tr>
 <tr>
-<th scope="row"><label for="wp_disable_real_time_collaboration"><?php _e( 'Collaboration' ); ?></label></th>
+<th scope="row"><label for="wp_enable_real_time_collaboration"><?php _e( 'Collaboration' ); ?></label></th>
 <td>
-	<input name="wp_disable_real_time_collaboration" type="checkbox" id="wp_disable_real_time_collaboration" value="1" <?php checked( '1', get_option( 'wp_disable_real_time_collaboration' ) ); ?> />
-	<label for="wp_disable_real_time_collaboration"><?php _e( 'Disable real-time collaboration' ); ?></label>
+	<input name="wp_enable_real_time_collaboration" type="checkbox" id="wp_enable_real_time_collaboration" value="1" <?php checked( '1', get_option( 'wp_enable_real_time_collaboration' ) ); ?> />
+	<label for="wp_enable_real_time_collaboration"><?php _e( 'Enable real-time collaboration' ); ?></label>
 </td>
 </tr>
 <?php

src/wp-admin/options.php

@@ -153,7 +153,7 @@
 		'default_email_category',
 		'default_link_category',
 		'default_post_format',
-		'wp_disable_real_time_collaboration',
+		'wp_enable_real_time_collaboration',
 	),
 );
 $allowed_options['misc']    = array();

src/wp-includes/collaboration.php

@@ -14,7 +14,7 @@
  * @access private
  */
 function wp_collaboration_inject_setting() {
-	if ( ! boolval( get_option( 'wp_disable_real_time_collaboration' ) ) ) {
+	if ( get_option( 'wp_enable_real_time_collaboration' ) ) {
 		wp_add_inline_script(
 			'wp-core-data',
 			'window._wpCollaborationEnabled = true;',

src/wp-includes/default-filters.php

@@ -485,8 +485,9 @@
 // Timezone.
 add_filter( 'pre_option_gmt_offset', 'wp_timezone_override_offset' );
 
-// If the upgrade hasn't run yet, assume link manager is used.
-add_filter( 'default_option_link_manager_enabled', '__return_true' );
+// If the upgrade hasn't run yet, set some default options.
+add_filter( 'default_option_link_manager_enabled', '__return_true' ); // Assume link manager is used.
+add_filter( 'default_option_wp_enable_real_time_collaboration', '__return_true' ); // Enable real-time collaboration.
 
 // This option no longer exists; tell plugins we always support auto-embedding.
 add_filter( 'pre_option_embed_autourls', '__return_true' );

src/wp-includes/option.php

@@ -2887,10 +2887,10 @@ function register_initial_settings() {
 
 	register_setting(
 		'writing',
-		'wp_disable_real_time_collaboration',
+		'wp_enable_real_time_collaboration',
 		array(
 			'type'              => 'boolean',
-			'description'       => __( 'Disable real-time collaboration' ),
+			'description'       => __( 'Enable Real-Time Collaboration' ),
 			'sanitize_callback' => 'rest_sanitize_boolean',
 			'default'           => false,
 			'show_in_rest'      => true,

src/wp-includes/post.php

@@ -657,7 +657,7 @@ function create_initial_post_types() {
 		)
 	);
 
-	if ( ! boolval( get_option( 'wp_disable_real_time_collaboration' ) ) ) {
+	if ( get_option( 'wp_enable_real_time_collaboration' ) ) {
 		register_post_type(
 			'wp_sync_storage',
 			array(
@@ -8671,7 +8671,7 @@ function wp_create_initial_post_meta() {
 		)
 	);
 
-	if ( ! boolval( get_option( 'wp_disable_real_time_collaboration' ) ) ) {
+	if ( get_option( 'wp_enable_real_time_collaboration' ) ) {
 		register_meta(
 			'post',
 			'_crdt_document',

src/wp-includes/rest-api.php

@@ -430,7 +430,7 @@ function create_initial_rest_routes() {
 	$icons_controller->register_routes();
 
 	// Collaboration.
-	if ( ! boolval( get_option( 'wp_disable_real_time_collaboration' ) ) ) {
+	if ( get_option( 'wp_enable_real_time_collaboration' ) ) {
 		$sync_storage = new WP_Sync_Post_Meta_Storage();
 		$sync_server  = new WP_HTTP_Polling_Sync_Server( $sync_storage );
 		$sync_server->register_routes();

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

@@ -254,9 +254,9 @@ public function create_item( $request ) {
 		 *   the saved post. This diff is then applied to the in-memory CRDT
 		 *   document, which can lead to duplicate inserts or deletions.
 		 */
-		$is_collaboration_disabled = boolval( get_option( 'wp_disable_real_time_collaboration' ) );
+		$is_collaboration_enabled = get_option( 'wp_enable_real_time_collaboration' );
 
-		if ( $is_draft && (int) $post->post_author === $user_id && ! $post_lock && $is_collaboration_disabled ) {
+		if ( $is_draft && (int) $post->post_author === $user_id && ! $post_lock && ! $is_collaboration_enabled ) {
 			/*
 			 * Draft posts for the same author: autosaving updates the post and does not create a revision.
 			 * Convert the post object to an array and add slashes, wp_update_post() expects escaped array.

tests/phpunit/tests/rest-api/rest-autosaves-controller.php

@@ -570,7 +570,7 @@ public function test_rest_autosave_published_post() {
 	}
 
 	public function test_rest_autosave_draft_post_same_author() {
-		add_filter( 'pre_option_wp_disable_real_time_collaboration', '__return_true' );
+		add_filter( 'pre_option_wp_enable_real_time_collaboration', '__return_zero' ); // Zero as false doesn't work for pre-flight options.
 
 		wp_set_current_user( self::$editor_id );
 
@@ -606,7 +606,6 @@ public function test_rest_autosave_draft_post_same_author() {
 		$this->assertSame( $post_data['post_excerpt'], $post->post_excerpt );
 
 		wp_delete_post( $post_id );
-		remove_filter( 'pre_option_wp_disable_real_time_collaboration', '__return_true' );
 	}
 
 	public function test_rest_autosave_draft_post_different_author() {
@@ -747,7 +746,7 @@ public function test_get_item_sets_up_postdata() {
 	}
 
 	public function test_update_item_draft_page_with_parent() {
-		add_filter( 'pre_option_wp_disable_real_time_collaboration', '__return_true' );
+		add_filter( 'pre_option_wp_enable_real_time_collaboration', '__return_zero' ); // Zero as false doesn't work for pre-flight options.
 
 		wp_set_current_user( self::$editor_id );
 		$request = new WP_REST_Request( 'POST', '/wp/v2/pages/' . self::$child_draft_page_id . '/autosaves' );
@@ -766,8 +765,6 @@ public function test_update_item_draft_page_with_parent() {
 
 		$this->assertSame( self::$child_draft_page_id, $data['id'] );
 		$this->assertSame( self::$parent_page_id, $data['parent'] );
-
-		remove_filter( 'pre_option_wp_disable_real_time_collaboration', '__return_true' );
 	}
 
 	public function test_schema_validation_is_applied() {
@@ -933,7 +930,7 @@ public static function data_head_request_with_specified_fields_returns_success_r
 	 * same author should create a revision instead of updating the post directly.
 	 */
 	public function test_rest_autosave_draft_post_same_author_with_rtc() {
-		add_filter( 'pre_option_wp_disable_real_time_collaboration', '__return_false' );
+		add_filter( 'pre_option_wp_enable_real_time_collaboration', '__return_true' );
 
 		wp_set_current_user( self::$editor_id );
 
@@ -972,15 +969,14 @@ public function test_rest_autosave_draft_post_same_author_with_rtc() {
 		$this->assertSame( $post_data['post_excerpt'], $post->post_excerpt );
 
 		wp_delete_post( $post_id );
-		remove_filter( 'pre_option_wp_disable_real_time_collaboration', '__return_false' );
 	}
 
 	/**
 	 * When real-time collaboration is enabled, autosaving a draft page with
 	 * a parent should create a revision instead of updating the page directly.
 	 */
 	public function test_update_item_draft_page_with_parent_with_rtc() {
-		add_filter( 'pre_option_wp_disable_real_time_collaboration', '__return_false' );
+		add_filter( 'pre_option_wp_enable_real_time_collaboration', '__return_true' );
 
 		wp_set_current_user( self::$editor_id );
 		$request = new WP_REST_Request( 'POST', '/wp/v2/pages/' . self::$child_draft_page_id . '/autosaves' );
@@ -1000,7 +996,5 @@ public function test_update_item_draft_page_with_parent_with_rtc() {
 		// With RTC enabled, a revision is created instead of updating the page.
 		$this->assertNotSame( self::$child_draft_page_id, $data['id'] );
 		$this->assertSame( self::$child_draft_page_id, $data['parent'] );
-
-		remove_filter( 'pre_option_wp_disable_real_time_collaboration', '__return_false' );
 	}
 }