add comments to apply_filters

Author: tharsheblows

classes/class-admin.php

@@ -851,7 +851,13 @@ public function erase_large_records( int $total, int $done, int $last_entry, int
 			return;
 		}
 
-		// We will do at most 250000 at a time.
+		/**
+		 * Filters the number of records in the {$wpdb->stream} table to do at a time.
+		 *
+		 * @since 4.1.0
+		 *
+		 * @param int $batch_size The batch size, default 250000.
+		 */
 		$batch_size = apply_filters( 'wp_stream_batch_size', 250000 );
 
 		// This will tend to erase them in reverse chronological order,

classes/class-plugin.php

@@ -384,6 +384,14 @@ public function get_site_type(): string {
 	 * @return bool Whether or not this should be considered large.
 	 */
 	public function is_large_records_table( int $record_number ): bool {
+		/**
+		 * Filters whether or not the number of records should be considered a large table.
+		 *
+		 * @since 4.1.0
+		 *
+		 * @param bool $is_large_table Whether or not the number of records should be considered large.
+		 * @param int  $record_number The number of records being checked.
+		 */
 		return apply_filters( 'wp_stream_is_large_records_table', $record_number > 1000000, $record_number );
 	}