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.7 to 7.1.0), 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–46

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

Plugin surface

1 hook

Third-party callbacks on 'theme_block_pattern_files' run inside this call, and their cost is not bounded by anything here.

Called by

0

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfile_exists()called directly

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.

Hooks and filters fired · 1

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

1. 1
   apply_filters( theme_block_pattern_files )filterline 1888 (+32 into the body)

   Filters list of block pattern files for a theme.

Uses · 12

• wp_is_development_mode()Checks whether the site is in the given development mode.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• trailingslashit()Appends a trailing slash.
• 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.
• WP_Theme::scandir()Scans a directory for files of a certain extension.

Source code

View on Trac ↗View on GitHub ↗

1856	public function get_block_patterns() {1857		$can_use_cached = ! wp_is_development_mode( 'theme' );1858 1859		$pattern_data = $this->get_pattern_cache();1860		if ( is_array( $pattern_data ) ) {1861			if ( $can_use_cached ) {1862				return $pattern_data;1863			}1864			// If in development mode, clear pattern cache.1865			$this->delete_pattern_cache();1866		}1867 1868		$dirpath      = $this->get_stylesheet_directory() . '/patterns';1869		$pattern_data = array();1870 1871		if ( ! file_exists( $dirpath ) ) {1872			if ( $can_use_cached ) {1873				$this->set_pattern_cache( $pattern_data );1874			}1875			return $pattern_data;1876		}1877 1878		$files = (array) self::scandir( $dirpath, 'php', -1 );1879 1880		/**1881		 * Filters list of block pattern files for a theme.1882		 *1883		 * @since 6.8.01884		 *1885		 * @param array  $files   Array of theme files found within `patterns` directory.1886		 * @param string $dirpath Path of theme `patterns` directory being scanned.1887		 */1888		$files = apply_filters( 'theme_block_pattern_files', $files, $dirpath );1889 1890		$dirpath = trailingslashit( $dirpath );1891 1892		if ( ! $files ) {1893			if ( $can_use_cached ) {1894				$this->set_pattern_cache( $pattern_data );1895			}1896			return $pattern_data;1897		}1898 1899		$default_headers = array(1900			'title'         => 'Title',1901			'slug'          => 'Slug',1902			'description'   => 'Description',1903			'viewportWidth' => 'Viewport Width',1904			'inserter'      => 'Inserter',1905			'categories'    => 'Categories',1906			'keywords'      => 'Keywords',1907			'blockTypes'    => 'Block Types',1908			'postTypes'     => 'Post Types',1909			'templateTypes' => 'Template Types',1910		);1911 1912		$properties_to_parse = array(1913			'categories',1914			'keywords',1915			'blockTypes',1916			'postTypes',1917			'templateTypes',1918		);1919 1920		foreach ( $files as $file ) {1921			$pattern = get_file_data( $file, $default_headers );1922 1923			if ( empty( $pattern['slug'] ) ) {1924				_doing_it_wrong(1925					__FUNCTION__,1926					sprintf(1927						/* translators: 1: file name. */1928						__( 'Could not register file "%s" as a block pattern ("Slug" field missing)' ),1929						$file1930					),1931					'6.0.0'1932				);1933				continue;1934			}1935

Changelog

Introduced in 6.4.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 7.1.0 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.