WP_Theme::get_block_patterns(): array

Description

/**
 * Title: My Pattern
 * Slug: my-theme/my-pattern
 *

<main><p><?php echo "Hello"; ?></p></main>

- Description
- Viewport Width
- Inserter (yes/no)
- Categories (comma-separated values)
- Keywords (comma-separated values)
- Block Types (comma-separated values)
- Post Types (comma-separated values)
- Template Types (comma-separated values)

Compatibility

Present in every tracked release (6.7.10 to 7.1.3), and compiles on PHP 7.4 through 8.6-dev.

Return value

array

Block pattern data.

Performance profile

How much work a call to WP_Theme::get_block_patterns() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

11–35

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 141.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• filesystemfilesystem accessfile_exists()called directly
• hookthird-party callbacksapply_filters()one call below WP_Theme::get_block_patterns()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 9 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme::get_block_patterns() can have, taken from its control-flow graph on PHP 8.5.

Uses · 9

• wp_is_development_mode()Checks whether the site is in the given development mode.
• get_file_data()Retrieves metadata from a file.
• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• wp_parse_list()Converts a comma- or space-separated list of scalar values to an array.
• WP_Theme::get_pattern_cache()Gets block pattern cache.
• WP_Theme::delete_pattern_cache()Clears block pattern cache.
• WP_Theme::get_stylesheet_directory()Returns the absolute path to the directory of a theme's "stylesheet" files.
• WP_Theme::set_pattern_cache()Sets block pattern cache.

Source code

View on Trac ↗View on GitHub ↗

1839	public function get_block_patterns() {1840		$can_use_cached = ! wp_is_development_mode( 'theme' );1841 1842		$pattern_data = $this->get_pattern_cache();1843		if ( is_array( $pattern_data ) ) {1844			if ( $can_use_cached ) {1845				return $pattern_data;1846			}1847			// If in development mode, clear pattern cache.1848			$this->delete_pattern_cache();1849		}1850 1851		$dirpath      = $this->get_stylesheet_directory() . '/patterns/';1852		$pattern_data = array();1853 1854		if ( ! file_exists( $dirpath ) ) {1855			if ( $can_use_cached ) {1856				$this->set_pattern_cache( $pattern_data );1857			}1858			return $pattern_data;1859		}1860		$files = glob( $dirpath . '*.php' );1861		if ( ! $files ) {1862			if ( $can_use_cached ) {1863				$this->set_pattern_cache( $pattern_data );1864			}1865			return $pattern_data;1866		}1867 1868		$default_headers = array(1869			'title'         => 'Title',1870			'slug'          => 'Slug',1871			'description'   => 'Description',1872			'viewportWidth' => 'Viewport Width',1873			'inserter'      => 'Inserter',1874			'categories'    => 'Categories',1875			'keywords'      => 'Keywords',1876			'blockTypes'    => 'Block Types',1877			'postTypes'     => 'Post Types',1878			'templateTypes' => 'Template Types',1879		);1880 1881		$properties_to_parse = array(1882			'categories',1883			'keywords',1884			'blockTypes',1885			'postTypes',1886			'templateTypes',1887		);1888 1889		foreach ( $files as $file ) {1890			$pattern = get_file_data( $file, $default_headers );1891 1892			if ( empty( $pattern['slug'] ) ) {1893				_doing_it_wrong(1894					__FUNCTION__,1895					sprintf(1896						/* translators: 1: file name. */1897						__( 'Could not register file "%s" as a block pattern ("Slug" field missing)' ),1898						$file1899					),1900					'6.0.0'1901				);1902				continue;1903			}1904 1905			if ( ! preg_match( '/^[A-z0-9\/_-]+$/', $pattern['slug'] ) ) {1906				_doing_it_wrong(1907					__FUNCTION__,1908					sprintf(1909						/* translators: 1: file name; 2: slug value found. */1910						__( 'Could not register file "%1$s" as a block pattern (invalid slug "%2$s")' ),1911						$file,1912						$pattern['slug']1913					),1914					'6.0.0'1915				);1916			}1917 1918			// Title is a required property.

Changelog

Introduced in 6.4.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.7.10 tag, from src/wp-includes/class-wp-theme.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.