114 | 
115 |
76 |
88 | enable();
140 |
--------------------------------------------------------------------------------
/includes/ConvertToBlocks/Assets.php:
--------------------------------------------------------------------------------
1 | is_block_editor();
80 | }
81 |
82 | }
83 |
--------------------------------------------------------------------------------
/includes/ConvertToBlocks/ClassicEditorSupport.php:
--------------------------------------------------------------------------------
1 | container->has_classic_param() ) {
49 | return false;
50 | }
51 |
52 | if ( $this->container->post_supports_convert_to_blocks( $post ) ) {
53 | return true;
54 | }
55 |
56 | return $enabled;
57 | }
58 |
59 | }
60 |
--------------------------------------------------------------------------------
/includes/ConvertToBlocks/MigrationAgent.php:
--------------------------------------------------------------------------------
1 | has_ctb_client_param() ) {
20 | return;
21 | }
22 |
23 | if ( ! $this->is_running() ) {
24 | return;
25 | }
26 |
27 | $posts_to_update = get_option( 'ctb_posts_to_update' );
28 | $cursor = get_option( 'ctb_cursor' );
29 | $posts_to_update = is_array( $posts_to_update ) ? $posts_to_update : [];
30 | $post_id = $posts_to_update[ $cursor ] ?? 0;
31 |
32 | wp_localize_script(
33 | 'convert_to_blocks_editor',
34 | 'convert_to_blocks_agent',
35 | [
36 | 'agent' => [
37 | 'next' => $this->next(),
38 | 'save_delay' => apply_filters( 'convert_to_blocks_save_delay', 0, $post_id ),
39 | ],
40 | ]
41 | );
42 | }
43 |
44 | /**
45 | * Always register since this check needs to be happen later in lifecycle.
46 | *
47 | * @return bool
48 | */
49 | public function can_register() {
50 | return true;
51 | }
52 |
53 | /**
54 | * Starts the batch conversion
55 | *
56 | * @param array $opts Optional opts.
57 | * @return bool
58 | */
59 | public function start( $opts = [] ) {
60 | $posts_to_update = $this->get_posts_to_update( $opts );
61 |
62 | if ( empty( $posts_to_update ) ) {
63 | return false;
64 | }
65 |
66 | update_option( 'ctb_running', 1 );
67 | update_option( 'ctb_posts_to_update', $posts_to_update );
68 | update_option( 'ctb_cursor', -1 );
69 |
70 | return $this->next();
71 | }
72 |
73 | /**
74 | * Stops the batch conversion if running and resets the previous session.
75 | */
76 | public function stop() {
77 | update_option( 'ctb_running', 0 );
78 | update_option( 'ctb_posts_to_update', [] );
79 | update_option( 'ctb_cursor', -1 );
80 | }
81 |
82 | /**
83 | * Returns the current status of the batch conversion.
84 | *
85 | * @return array
86 | */
87 | public function get_status() {
88 | $running = get_option( 'ctb_running' );
89 | $posts_to_update = get_option( 'ctb_posts_to_update' );
90 |
91 | if ( empty( $posts_to_update ) ) {
92 | $posts_to_update = [];
93 | }
94 |
95 | $total = count( $posts_to_update );
96 | $cursor = get_option( 'ctb_cursor' );
97 |
98 | if ( $total > 0 ) {
99 | $progress = round( ( $cursor + 1 ) / $total * 100 );
100 | } else {
101 | $progress = 0;
102 | }
103 |
104 | return [
105 | 'running' => $running,
106 | 'cursor' => $cursor,
107 | 'total' => $total,
108 | 'progress' => $progress,
109 | 'active' => $this->get_client_link( $posts_to_update[ $cursor ] ?? 0 ),
110 | ];
111 | }
112 |
113 | /**
114 | * Returns a boolean based on whether a migration is currently running.
115 | *
116 | * @return bool
117 | */
118 | public function is_running() {
119 | $running = get_option( 'ctb_running' );
120 | return ! empty( $running );
121 | }
122 |
123 | /**
124 | * Updates the progress cursor to jump to the next post in the queue.
125 | */
126 | public function next() {
127 | $posts_to_update = get_option( 'ctb_posts_to_update' );
128 | $total = count( $posts_to_update );
129 | $cursor = get_option( 'ctb_cursor' );
130 |
131 | if ( $cursor + 1 < $total ) {
132 | $next_cursor = ++$cursor;
133 | update_option( 'ctb_cursor', $next_cursor );
134 |
135 | return $this->get_client_link( $posts_to_update[ $next_cursor ] );
136 | } elseif ( $cursor + 1 === $total ) {
137 | update_option( 'ctb_running', 0 );
138 | return false;
139 | } else {
140 | return false;
141 | }
142 | }
143 |
144 | /**
145 | * Returns the next post URL to migrate.
146 | *
147 | * @param int $post_id The next post id.
148 | * @return string
149 | */
150 | public function get_client_link( $post_id ) {
151 | if ( empty( $post_id ) ) {
152 | return '';
153 | }
154 |
155 | $edit_post_link = admin_url( 'post.php' );
156 |
157 | $args = [
158 | 'post' => $post_id,
159 | 'action' => 'edit',
160 | 'ctb_client' => $post_id,
161 | ];
162 |
163 | return add_query_arg( $args, $edit_post_link );
164 | }
165 |
166 | /**
167 | * Returns the list of post ids that need to be migrated.
168 | *
169 | * @param array $opts Optional opts
170 | * @return array
171 | */
172 | public function get_posts_to_update( $opts = [] ) {
173 | if ( ! empty( $opts['post_type'] ) ) {
174 | $post_type = explode( ',', $opts['post_type'] );
175 | $post_type = array_filter( $post_type );
176 |
177 | if ( empty( $post_type ) ) {
178 | $post_type = [ 'post', 'page' ];
179 | }
180 | } else {
181 | $post_type = [ 'post', 'page' ];
182 | }
183 |
184 | $posts_per_page = $opts['per_page'] ?? -1;
185 | $page = $opts['page'] ?? 1;
186 |
187 | $query_params = [
188 | 'post_type' => $post_type,
189 | 'post_status' => 'publish',
190 | 'fields' => 'ids',
191 | 'posts_per_page' => $posts_per_page,
192 | 'paged' => $page,
193 | 'ignore_sticky_posts' => true,
194 | ];
195 |
196 | if ( ! empty( $opts['catalog'] ) ) {
197 | $query_params['tax_query'] = [
198 | [
199 | 'taxonomy' => BLOCK_CATALOG_TAXONOMY,
200 | 'field' => 'slug',
201 | 'terms' => [ 'core-classic' ],
202 | ],
203 | ];
204 | }
205 |
206 | /**
207 | * Filter query parameters for the query to get the posts to be updated.
208 | *
209 | * @since 1.1.2
210 | *
211 | * @hook convert_to_blocks_update_posts_query_params
212 | *
213 | * @param {array} $query_params Array of query parameters.
214 | * @param {array} $post_type Array with the post types.
215 | * @param {array} $opts Optional opts.
216 | *
217 | * @return {array} Array of request arguments.
218 | */
219 | $query_params = apply_filters( 'convert_to_blocks_update_posts_query_params', $query_params, $post_type, $opts );
220 |
221 | if ( ! empty( $opts['only'] ) ) {
222 | $post_in = explode( ',', $opts['only'] );
223 | $post_in = array_map( 'intval', $post_in );
224 | $post_in = array_filter( $post_in );
225 |
226 | $query_params['post__in'] = $post_in;
227 | }
228 |
229 | $query = new \WP_Query( $query_params );
230 | $posts = $query->posts;
231 |
232 | if ( ! empty( $posts ) && defined( '\WP_CLI' ) && \WP_CLI ) {
233 | $posts_per_page = $posts_per_page > 0 ? $posts_per_page : $query->found_posts;
234 | $pages = ceil( $query->found_posts / $posts_per_page );
235 | \WP_CLI::line( sprintf( 'Pagination: %d/%d of %d', $page, $pages, $query->found_posts ) );
236 | }
237 |
238 | return $posts;
239 | }
240 |
241 | /**
242 | * Returns a boolean based on whether the current url has the ctb_client
243 | * editor parameter
244 | *
245 | * @return bool
246 | */
247 | public function has_ctb_client_param() {
248 | // phpcs:disable
249 | $ctb_client = sanitize_text_field( $_GET['ctb_client'] ?? '' );
250 | // phpcs:enable
251 | $ctb_client = intval( $ctb_client );
252 |
253 | return ! empty( $ctb_client );
254 | }
255 |
256 | }
257 |
--------------------------------------------------------------------------------
/includes/ConvertToBlocks/MigrationCommand.php:
--------------------------------------------------------------------------------
1 | ]
21 | * : Optional comma delimited list of post types to migrate. Defaults to post,page
22 | *
23 | * [--per_page=77 | 86 |
87 |
92 |
98 | container->is_classic_referer() || $this->container->has_classic_param() ) {
49 | $location = add_query_arg( [ 'classic' => 1 ], $location );
50 | }
51 |
52 | return $location;
53 | }
54 |
55 | /**
56 | * Ensures that restoring revision from Classic Editor takes user back to CE.
57 | *
58 | * @param array $revision_data The revision data array
59 | * @param array $revision The revision meta
60 | * @param WP_Post $post The revision post object
61 | */
62 | public function update_revision_js( $revision_data, $revision, $post ) {
63 | if ( $this->container->is_classic_referer() || $this->container->has_classic_param() ) {
64 | $revision_data['restoreUrl'] = add_query_arg( [ 'classic' => 1 ], $revision_data['restoreUrl'] );
65 | }
66 |
67 | return $revision_data;
68 | }
69 |
70 | }
71 |
--------------------------------------------------------------------------------
/includes/ConvertToBlocks/Settings.php:
--------------------------------------------------------------------------------
1 | init();
56 |
57 | add_action( 'admin_menu', [ $this, 'add_menu' ] );
58 | add_action( 'admin_init', [ $this, 'register_section' ], 10 );
59 | add_action( 'admin_init', [ $this, 'register_fields' ], 20 );
60 | add_action( 'admin_notices', [ $this, 'filter_notice' ], 10 );
61 | add_filter( 'plugin_action_links_' . CONVERT_TO_BLOCKS_PLUGIN_BASENAME, [ $this, 'add_settings_link' ] );
62 | }
63 |
64 | /**
65 | * Only registers on admin context.
66 | */
67 | public function can_register() {
68 | return is_admin();
69 | }
70 |
71 | /**
72 | * Configures variables and fetches post types.
73 | *
74 | * @return void
75 | */
76 | public function init() {
77 | // Configure variables.
78 | $this->settings_page = sprintf( '%s-%s', CONVERT_TO_BLOCKS_SLUG, $this->settings_page );
79 | $this->settings_section = sprintf( '%s-%s', CONVERT_TO_BLOCKS_SLUG, $this->settings_section );
80 | $this->settings_group = sprintf( '%s_%s', CONVERT_TO_BLOCKS_SLUG, $this->settings_group );
81 |
82 | // Get post types.
83 | $this->post_types = $this->get_post_types();
84 | }
85 |
86 | /**
87 | * Retrieves all public post types.
88 | *
89 | * @return array
90 | */
91 | public function get_post_types() {
92 | $post_types = get_post_types(
93 | [ 'public' => true ]
94 | );
95 |
96 | if ( ! empty( $post_types['attachment'] ) ) {
97 | unset( $post_types['attachment'] );
98 | }
99 |
100 | return $post_types;
101 | }
102 |
103 | /**
104 | * Adds a submenu item for the `Settings` menu.
105 | *
106 | * @return void
107 | */
108 | public function add_menu() {
109 | add_options_page(
110 | esc_html__( 'Convert to Blocks', 'convert-to-blocks' ),
111 | esc_html__( 'Convert to Blocks', 'convert-to-blocks' ),
112 | $this->capability,
113 | CONVERT_TO_BLOCKS_SLUG,
114 | [ $this, 'settings_page' ]
115 | );
116 | }
117 |
118 | /**
119 | * Registers the settings page.
120 | *
121 | * @return void
122 | */
123 | public function settings_page() {
124 | ?>
125 |
93 |
94 |
95 | [ 'href' => true ] ] ); ?>
96 |
126 |
130 | 131 |
143 | settings_section,
154 | false,
155 | false,
156 | CONVERT_TO_BLOCKS_SLUG
157 | );
158 | }
159 |
160 | /**
161 | * Registers setting fields.
162 | *
163 | * @return void
164 | */
165 | public function register_fields() {
166 | // Supported post types.
167 | add_settings_field(
168 | sprintf( '%s_post_types', CONVERT_TO_BLOCKS_SLUG ),
169 | esc_html__( 'Supported Post Types', 'convert-to-blocks' ),
170 | [ $this, 'field_post_types' ],
171 | CONVERT_TO_BLOCKS_SLUG,
172 | $this->settings_section,
173 | [
174 | 'label_for' => sprintf( '%s_post_types', CONVERT_TO_BLOCKS_SLUG ),
175 | ]
176 | );
177 |
178 | register_setting(
179 | $this->settings_group,
180 | sprintf( '%s_post_types', CONVERT_TO_BLOCKS_SLUG ),
181 | [
182 | 'sanitize_callback' => [ $this, 'sanitize_post_types' ],
183 | ]
184 | );
185 | }
186 |
187 | /**
188 | * Renders the `post_types` field.
189 | *
190 | * @return void
191 | */
192 | public function field_post_types() {
193 | $post_types = get_option(
194 | sprintf( '%s_post_types', CONVERT_TO_BLOCKS_SLUG ),
195 | Plugin::get_instance()->get_default_post_types()
196 | );
197 | $output_html = '';
198 |
199 | foreach ( $this->post_types as $post_type ) {
200 | $output_html .= sprintf(
201 | ' 127 | 128 |
129 |130 | 131 |
132 | 133 |
134 | 135 | 142 |', 202 | sprintf( '%s_post_types_%s', esc_attr( CONVERT_TO_BLOCKS_SLUG ), esc_attr( $post_type ) ), 203 | sprintf( '%s_post_types', esc_attr( CONVERT_TO_BLOCKS_SLUG ) ), 204 | checked( in_array( $post_type, $post_types, true ), 1, false ), 205 | esc_attr( $post_type ), 206 | esc_attr( ucfirst( $post_type ) ) 207 | ); 208 | } 209 | ?> 210 | 213 | post_type ) || in_array( $screen->id, $show_on_pages, true ) ) ) { 252 | return; 253 | } 254 | 255 | ?> 256 |
257 |
261 | %s',
277 | esc_url(
278 | add_query_arg(
279 | [
280 | 'page' => CONVERT_TO_BLOCKS_SLUG,
281 | ],
282 | admin_url( 'options-general.php' )
283 | )
284 | ),
285 | esc_html__( 'Settings', 'convert-to-blocks' )
286 | );
287 |
288 | return [ $settings_link, ...$links ];
289 | }
290 |
291 | }
292 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "convert-to-blocks",
3 | "version": "1.3.2",
4 | "description": "Convert to Blocks is a WordPress plugin that transforms classic editor content to blocks on the fly.",
5 | "author": {
6 | "name": "10up",
7 | "email": "opensource@10up.com",
8 | "url": "https://10up.com",
9 | "role": "developer"
10 | },
11 | "license": "GPL-2.0-or-later",
12 | "scripts": {
13 | "test": "phpunit",
14 | "start": "composer install && npm install && npm run build",
15 | "build": "NODE_ENV=production wp-scripts build",
16 | "watch": "NODE_ENV=development wp-scripts start",
17 | "build-release": "npm install && composer install --no-dev -o && npm run build",
18 | "lint-release": "npm install && composer install && npm run lint",
19 | "lint-js": "wp-scripts lint-js ./assets/js",
20 | "lint-php": "composer run lint",
21 | "format-js": "wp-scripts format ./assets/js",
22 | "lint": "npm run lint-js && npm run lint-php",
23 | "format": "npm run format-js",
24 | "wp-env": "wp-env",
25 | "env:start": "wp-env start",
26 | "env:stop": "wp-env stop",
27 | "env:reset": "wp-env clean all",
28 | "env:destroy": "wp-env destroy",
29 | "cypress:open": "cypress open --config-file tests/cypress/config.js --e2e --browser chrome",
30 | "cypress:run": "cypress run --config-file tests/cypress/config.js",
31 | "env": "wp-env",
32 | "postenv:start": "./tests/bin/initialize.sh"
33 | },
34 | "husky": {
35 | "hooks": {
36 | "pre-commit": "lint-staged"
37 | }
38 | },
39 | "lint-staged": {
40 | "*.js": [
41 | "eslint"
42 | ]
43 | },
44 | "repository": {
45 | "type": "git",
46 | "url": "https://github.com/10up/convert-to-blocks"
47 | },
48 | "devDependencies": {
49 | "@10up/cypress-wp-utils": "^0.2.0",
50 | "@10up/eslint-config": "^4.0.0",
51 | "@wordpress/env": "^10.2.0",
52 | "@wordpress/scripts": "^30.4.0",
53 | "cypress": "^13.3.0",
54 | "cypress-mochawesome-reporter": "^3.6.0",
55 | "husky": "^3.1.0",
56 | "lint-staged": "^9.5.0",
57 | "prettier": "^3.2.5"
58 | },
59 | "engines": {
60 | "node": ">=8.11"
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/phpcs.xml:
--------------------------------------------------------------------------------
1 |
2 | 258 | 259 |
260 |Heading 2
2 |Heading 3
3 |Heading 4
4 |Heading 5
5 |Heading 6
6 | 7 |Paragraph duis fringilla maximus ullamcorper. Sed id nulla semper, varius augue eu, cursus sapien. In hac habitasse platea dictumst.
8 | 9 | 10 | 11 |-
12 |
- Curabitur in lacus lorem. 13 |
- Sed purus ipsum, luctus eu augue sed, aliquam luctus lacus. 14 |
-
17 |
- Curabitur in lacus lorem. 18 |
- Sed purus ipsum, luctus eu augue sed, aliquam luctus lacus. 19 |
24 |27 | -------------------------------------------------------------------------------- /tests/cypress/support/commands.js: -------------------------------------------------------------------------------- 1 | // *********************************************** 2 | // This example commands.js shows you how to 3 | // create various custom commands and overwrite 4 | // existing commands. 5 | // 6 | // For more comprehensive examples of custom 7 | // commands please read more here: 8 | // https://on.cypress.io/custom-commands 9 | // *********************************************** 10 | // 11 | // 12 | // -- This is a parent command -- 13 | // Cypress.Commands.add('login', (email, password) => { ... }) 14 | // 15 | // 16 | // -- This is a child command -- 17 | // Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... }) 18 | // 19 | // 20 | // -- This is a dual command -- 21 | // Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... }) 22 | // 23 | // 24 | // -- This will overwrite an existing command -- 25 | // Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... }) 26 | -------------------------------------------------------------------------------- /tests/cypress/support/e2e.js: -------------------------------------------------------------------------------- 1 | // *********************************************************** 2 | // This example support/e2e.js is processed and 3 | // loaded automatically before your test files. 4 | // 5 | // This is a great place to put global configuration and 6 | // behavior that modifies Cypress. 7 | // 8 | // You can change the location of this file or turn off 9 | // automatically serving support files with the 10 | // 'supportFile' configuration option. 11 | // 12 | // You can read more here: 13 | // https://on.cypress.io/configuration 14 | // *********************************************************** 15 | 16 | import "@10up/cypress-wp-utils"; 17 | 18 | // Import commands.js using ES2015 syntax: 19 | import "./commands"; 20 | -------------------------------------------------------------------------------- /tests/cypress/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "allowJs": true, 4 | "types": ["cypress"] 5 | }, 6 | "include": ["**/*.*"] 7 | } 8 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | const defaultConfig = require('@wordpress/scripts/config/webpack.config'); 2 | 3 | module.exports = { 4 | ...defaultConfig, 5 | entry: { 6 | ...defaultConfig.entry, 7 | editor: './assets/js/editor/editor.js', 8 | }, 9 | module: { 10 | ...defaultConfig.module, 11 | }, 12 | }; 13 | --------------------------------------------------------------------------------Quote commodo molestie dui, ut convallis sapien sodales vel. Mauris at commodo ante, eu tristique justo. Duis elementum egestas nulla, bibendum eleifend massa hendrerit sit amet. Sed id ipsum et velit lacinia mattis. Mauris facilisis non ante id elementum.
25 | J. Smith 26 |