2020-07-06 06:50:02 -04:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Register the block patterns and block patterns categories
|
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @since 5.5.0
|
|
|
|
*/
|
|
|
|
|
2020-07-16 07:50:07 -04:00
|
|
|
add_theme_support( 'core-block-patterns' );
|
2020-07-06 06:50:02 -04:00
|
|
|
|
2020-07-16 07:50:07 -04:00
|
|
|
/**
|
|
|
|
* Registers the core block patterns and categories.
|
|
|
|
*
|
|
|
|
* @since 5.5.0
|
|
|
|
* @private
|
|
|
|
*/
|
|
|
|
function _register_core_block_patterns_and_categories() {
|
|
|
|
$should_register_core_patterns = get_theme_support( 'core-block-patterns' );
|
|
|
|
|
|
|
|
if ( $should_register_core_patterns ) {
|
|
|
|
$core_block_patterns = array(
|
2021-05-21 07:13:57 -04:00
|
|
|
'query-standard-posts',
|
|
|
|
'query-medium-posts',
|
|
|
|
'query-small-posts',
|
|
|
|
'query-grid-posts',
|
|
|
|
'query-large-title-posts',
|
|
|
|
'query-offset-posts',
|
|
|
|
'social-links-shared-background-color',
|
2020-07-16 07:50:07 -04:00
|
|
|
);
|
|
|
|
|
|
|
|
foreach ( $core_block_patterns as $core_block_pattern ) {
|
|
|
|
register_block_pattern(
|
|
|
|
'core/' . $core_block_pattern,
|
|
|
|
require __DIR__ . '/block-patterns/' . $core_block_pattern . '.php'
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-07-16 10:13:03 -04:00
|
|
|
register_block_pattern_category( 'buttons', array( 'label' => _x( 'Buttons', 'Block pattern category' ) ) );
|
|
|
|
register_block_pattern_category( 'columns', array( 'label' => _x( 'Columns', 'Block pattern category' ) ) );
|
|
|
|
register_block_pattern_category( 'gallery', array( 'label' => _x( 'Gallery', 'Block pattern category' ) ) );
|
|
|
|
register_block_pattern_category( 'header', array( 'label' => _x( 'Headers', 'Block pattern category' ) ) );
|
|
|
|
register_block_pattern_category( 'text', array( 'label' => _x( 'Text', 'Block pattern category' ) ) );
|
2021-07-02 10:35:58 -04:00
|
|
|
register_block_pattern_category( 'query', array( 'label' => _x( 'Query', 'Block pattern category' ) ) );
|
2020-07-06 06:50:02 -04:00
|
|
|
}
|
2021-05-25 21:11:59 -04:00
|
|
|
|
|
|
|
/**
|
2021-06-22 17:24:58 -04:00
|
|
|
* Register Core's official patterns from wordpress.org/patterns.
|
|
|
|
*
|
|
|
|
* @since 5.8.0
|
Editor: Explicitly load remote block patterns in the block and site editor screens.
Remote block patterns from wp.org were to be loaded through a callback hooked into the `current_screen` filter. Within 2 callbacks, i.e. `_load_remote_featured_patterns()` and `_load_remote_block_patterns()`, a guard clause bailed out early if the `$current_screen->is_block_editor` is `false`.
However, the `current_screen` filter is unreliable to detect the block editor. Why? In the block and Site Editor screens, `$current_scren->is_block_editor` is not set until after the filter is executed. Whoopsie.
This commit no longer uses the `current_screen` filter. Instead, it explicitly loads the remote block patterns by invoking both private functions (now not callbacks) directly in the screen files for the block and site editor screens.
With this change, passing `WP_Screen` object into these functions is no longer needed. As the `_load_remote_block_patterns()` function was introduced in 5.8.0, its function parameter is now deprecated and the guard clause retained for backwards compatibility.
Follow-up to [51021], [52377].
Props poena, noisysocks, peterwilsoncc, hellofromTonya, audrasjb.
Fixes #54806.
Built from https://develop.svn.wordpress.org/trunk@52593
git-svn-id: http://core.svn.wordpress.org/trunk@52181 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-01-17 17:42:03 -05:00
|
|
|
* @since 5.9.0 The $current_screen argument was removed.
|
2021-06-22 17:24:58 -04:00
|
|
|
*
|
Editor: Explicitly load remote block patterns in the block and site editor screens.
Remote block patterns from wp.org were to be loaded through a callback hooked into the `current_screen` filter. Within 2 callbacks, i.e. `_load_remote_featured_patterns()` and `_load_remote_block_patterns()`, a guard clause bailed out early if the `$current_screen->is_block_editor` is `false`.
However, the `current_screen` filter is unreliable to detect the block editor. Why? In the block and Site Editor screens, `$current_scren->is_block_editor` is not set until after the filter is executed. Whoopsie.
This commit no longer uses the `current_screen` filter. Instead, it explicitly loads the remote block patterns by invoking both private functions (now not callbacks) directly in the screen files for the block and site editor screens.
With this change, passing `WP_Screen` object into these functions is no longer needed. As the `_load_remote_block_patterns()` function was introduced in 5.8.0, its function parameter is now deprecated and the guard clause retained for backwards compatibility.
Follow-up to [51021], [52377].
Props poena, noisysocks, peterwilsoncc, hellofromTonya, audrasjb.
Fixes #54806.
Built from https://develop.svn.wordpress.org/trunk@52593
git-svn-id: http://core.svn.wordpress.org/trunk@52181 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-01-17 17:42:03 -05:00
|
|
|
* @param WP_Screen $deprecated Unused. Formerly the screen that the current request was triggered from.
|
2021-05-25 21:11:59 -04:00
|
|
|
*/
|
Editor: Explicitly load remote block patterns in the block and site editor screens.
Remote block patterns from wp.org were to be loaded through a callback hooked into the `current_screen` filter. Within 2 callbacks, i.e. `_load_remote_featured_patterns()` and `_load_remote_block_patterns()`, a guard clause bailed out early if the `$current_screen->is_block_editor` is `false`.
However, the `current_screen` filter is unreliable to detect the block editor. Why? In the block and Site Editor screens, `$current_scren->is_block_editor` is not set until after the filter is executed. Whoopsie.
This commit no longer uses the `current_screen` filter. Instead, it explicitly loads the remote block patterns by invoking both private functions (now not callbacks) directly in the screen files for the block and site editor screens.
With this change, passing `WP_Screen` object into these functions is no longer needed. As the `_load_remote_block_patterns()` function was introduced in 5.8.0, its function parameter is now deprecated and the guard clause retained for backwards compatibility.
Follow-up to [51021], [52377].
Props poena, noisysocks, peterwilsoncc, hellofromTonya, audrasjb.
Fixes #54806.
Built from https://develop.svn.wordpress.org/trunk@52593
git-svn-id: http://core.svn.wordpress.org/trunk@52181 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-01-17 17:42:03 -05:00
|
|
|
function _load_remote_block_patterns( $deprecated = null ) {
|
|
|
|
if ( ! empty( $deprecated ) ) {
|
|
|
|
_deprecated_argument( __FUNCTION__, '5.9.0' );
|
|
|
|
$current_screen = $deprecated;
|
|
|
|
if ( ! $current_screen->is_block_editor ) {
|
|
|
|
return;
|
|
|
|
}
|
2021-05-25 21:11:59 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
$supports_core_patterns = get_theme_support( 'core-block-patterns' );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Filter to disable remote block patterns.
|
|
|
|
*
|
|
|
|
* @since 5.8.0
|
|
|
|
*
|
|
|
|
* @param bool $should_load_remote
|
|
|
|
*/
|
|
|
|
$should_load_remote = apply_filters( 'should_load_remote_block_patterns', true );
|
|
|
|
|
|
|
|
if ( $supports_core_patterns && $should_load_remote ) {
|
2021-06-22 17:24:58 -04:00
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
|
|
$core_keyword_id = 11; // 11 is the ID for "core".
|
|
|
|
$request->set_param( 'keyword', $core_keyword_id );
|
|
|
|
$response = rest_do_request( $request );
|
|
|
|
if ( $response->is_error() ) {
|
|
|
|
return;
|
2021-05-25 21:11:59 -04:00
|
|
|
}
|
2021-06-22 17:24:58 -04:00
|
|
|
$patterns = $response->get_data();
|
2021-05-25 21:11:59 -04:00
|
|
|
|
|
|
|
foreach ( $patterns as $settings ) {
|
|
|
|
$pattern_name = 'core/' . sanitize_title( $settings['title'] );
|
|
|
|
register_block_pattern( $pattern_name, (array) $settings );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2021-12-14 14:39:06 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Register `Featured` (category) patterns from wordpress.org/patterns.
|
|
|
|
*
|
|
|
|
* @since 5.9.0
|
|
|
|
*/
|
Editor: Explicitly load remote block patterns in the block and site editor screens.
Remote block patterns from wp.org were to be loaded through a callback hooked into the `current_screen` filter. Within 2 callbacks, i.e. `_load_remote_featured_patterns()` and `_load_remote_block_patterns()`, a guard clause bailed out early if the `$current_screen->is_block_editor` is `false`.
However, the `current_screen` filter is unreliable to detect the block editor. Why? In the block and Site Editor screens, `$current_scren->is_block_editor` is not set until after the filter is executed. Whoopsie.
This commit no longer uses the `current_screen` filter. Instead, it explicitly loads the remote block patterns by invoking both private functions (now not callbacks) directly in the screen files for the block and site editor screens.
With this change, passing `WP_Screen` object into these functions is no longer needed. As the `_load_remote_block_patterns()` function was introduced in 5.8.0, its function parameter is now deprecated and the guard clause retained for backwards compatibility.
Follow-up to [51021], [52377].
Props poena, noisysocks, peterwilsoncc, hellofromTonya, audrasjb.
Fixes #54806.
Built from https://develop.svn.wordpress.org/trunk@52593
git-svn-id: http://core.svn.wordpress.org/trunk@52181 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-01-17 17:42:03 -05:00
|
|
|
function _load_remote_featured_patterns() {
|
2021-12-14 14:39:06 -05:00
|
|
|
$supports_core_patterns = get_theme_support( 'core-block-patterns' );
|
|
|
|
|
|
|
|
/** This filter is documented in wp-includes/block-patterns.php */
|
|
|
|
$should_load_remote = apply_filters( 'should_load_remote_block_patterns', true );
|
|
|
|
|
|
|
|
if ( ! $should_load_remote || ! $supports_core_patterns ) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( ! WP_Block_Pattern_Categories_Registry::get_instance()->is_registered( 'featured' ) ) {
|
|
|
|
register_block_pattern_category( 'featured', array( 'label' => __( 'Featured' ) ) );
|
|
|
|
}
|
|
|
|
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
|
|
$featured_cat_id = 26; // This is the `Featured` category id from pattern directory.
|
|
|
|
$request->set_param( 'category', $featured_cat_id );
|
|
|
|
$response = rest_do_request( $request );
|
|
|
|
if ( $response->is_error() ) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
$patterns = $response->get_data();
|
|
|
|
|
|
|
|
foreach ( $patterns as $pattern ) {
|
|
|
|
$pattern_name = sanitize_title( $pattern['title'] );
|
|
|
|
$registry = WP_Block_Patterns_Registry::get_instance();
|
2022-01-18 15:29:06 -05:00
|
|
|
// Some patterns might be already registered as core patterns with the `core` prefix.
|
2021-12-14 14:39:06 -05:00
|
|
|
$is_registered = $registry->is_registered( $pattern_name ) || $registry->is_registered( "core/$pattern_name" );
|
|
|
|
if ( ! $is_registered ) {
|
|
|
|
register_block_pattern( $pattern_name, (array) $pattern );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|