_load_remote_block_patterns( WP_Screen $deprecated = null )

Parameters

$deprecatedWP_Screenoptional

Unused. Formerly the screen that the current request was triggered from.Default: null

Hooks fired · 1

One hook fires while _load_remote_block_patterns() runs, in this order:

1. 1
   apply_filters( should_load_remote_block_patterns )filterline 228 (+18 into the body)

   Filter to disable remote block patterns.

Uses · 8

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• get_theme_support()Gets the theme support arguments passed when registering that support.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• rest_do_request()Do a REST request.
• wp_normalize_remote_block_pattern()Normalize the pattern properties to camelCase.
• sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
• register_block_pattern()Registers a new block pattern.
• WP_REST_Request::__construct()Constructor.

Used by · 1

• WP_REST_Block_Patterns_Controller::get_items()Retrieves all block patterns.

Source

View on Trac ↗View on GitHub ↗

210function _load_remote_block_patterns( $deprecated = null ) {211	if ( ! empty( $deprecated ) ) {212		_deprecated_argument( __FUNCTION__, '5.9.0' );213		$current_screen = $deprecated;214		if ( ! $current_screen->is_block_editor ) {215			return;216		}217	}218 219	$supports_core_patterns = get_theme_support( 'core-block-patterns' );220 221	/**222	 * Filter to disable remote block patterns.223	 *224	 * @since 5.8.0225	 *226	 * @param bool $should_load_remote227	 */228	$should_load_remote = apply_filters( 'should_load_remote_block_patterns', true );229 230	if ( $supports_core_patterns && $should_load_remote ) {231		$request         = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );232		$core_keyword_id = 11; // 11 is the ID for "core".233		$request->set_param( 'keyword', $core_keyword_id );234		$response = rest_do_request( $request );235		if ( $response->is_error() ) {236			return;237		}238		$patterns = $response->get_data();239 240		foreach ( $patterns as $pattern ) {241			$pattern['source']  = 'pattern-directory/core';242			$normalized_pattern = wp_normalize_remote_block_pattern( $pattern );243			$pattern_name       = 'core/' . sanitize_title( $normalized_pattern['title'] );244			register_block_pattern( $pattern_name, $normalized_pattern );245		}246	}247}

History

Introduced in 5.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/block-patterns.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.