_load_remote_block_patterns() WordPress Function
The load_remote_block_patterns() function loads block patterns from a remote server. This is useful for loading patterns from a central server, or for loading patterns from a third-party server.
_load_remote_block_patterns( WP_Screen $deprecated = null ) #
Register Core’s official patterns from wordpress.org/patterns.
Parameters
- $deprecated
(WP_Screen)(Optional)Unused. Formerly the screen that the current request was triggered from.
Default value: null
Source
File: wp-includes/block-patterns.php
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; } } $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 ) { $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; } $patterns = $response->get_data(); foreach ( $patterns as $settings ) { $pattern_name = 'core/' . sanitize_title( $settings['title'] ); register_block_pattern( $pattern_name, (array) $settings ); } } }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.9.0 | The $current_screen argument was removed. |
5.8.0 | Introduced. |