File "class-blocks.php"
Full path: /home/webcknlt/admissiontell.com/wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-blocks/src/class-blocks.php
File
size: 17.37 B (17.37 KB bytes)
MIME-type: text/x-php
Charset: utf-8
Download Open Edit Advanced Editor &nnbsp; Back
<?php
/** Blocks package.
*
* @since 1.1.0
*
* This package lifts elements from Jetpack's Jetpack_Gutenberg class.
* It is now an standalone package reusable outside Jetpack.
*
* @package automattic/jetpack-blocks
*/
namespace Automattic\Jetpack;
use Automattic\Jetpack\Constants as Jetpack_Constants;
use Jetpack_Gutenberg;
/**
* Register and manage blocks within a plugin. Used to manage block registration, enqueues, and more.
*
* @since 1.1.0
*/
class Blocks {
/**
* Wrapper function to safely register a Gutenberg block type
*
* @see register_block_type
* @see Automattic\Jetpack\Blocks::is_gutenberg_version_available
*
* @since 1.1.0
*
* @param string $slug Slug of the block or absolute path to the block source code directory.
* @param array $args {
* Arguments that are passed into register_block_type.
* See register_block_type for full list of arguments.
* Can also include 2 extra arguments not currently supported by register_block_type.
*
* @type array $version_requirements Array containing required Gutenberg version and, if known, the WordPress version that was released with this minimum version.
* @type bool $plan_check Should we check for a specific plan before registering the block.
* }
*
* @return \WP_Block_Type|false The registered block type on success, or false on failure.
*/
public static function jetpack_register_block( $slug, $args = array() ) {
// Slug doesn't start with `jetpack/`, isn't an absolute path, or doesn't contain a slash
// (synonym of a namespace) at all.
if ( ! str_starts_with( $slug, 'jetpack/' ) && ! path_is_absolute( $slug ) && ! strpos( $slug, '/' ) ) {
_doing_it_wrong( 'jetpack_register_block', 'Prefix the block with jetpack/ ', 'Jetpack 9.0.0' );
$slug = 'jetpack/' . $slug;
}
$block_type = $slug;
// If a path is passed, make sure to get the block.json file from the build directory and get
// the block name from that file.
if ( path_is_absolute( $slug ) ) {
$block_type = self::get_path_to_block_metadata( $slug );
$slug = self::get_block_name_from_path_convention( $slug );
}
if (
isset( $args['version_requirements'] )
&& ! self::is_gutenberg_version_available( $args['version_requirements'], $slug )
) {
return false;
}
// Checking whether block is registered to ensure it isn't registered twice.
if ( self::is_registered( $slug ) ) {
return false;
}
$feature_name = self::remove_extension_prefix( $slug );
// This is only useful in Jetpack.
if ( ! self::is_standalone_block() ) {
// If the block is dynamic, and a Jetpack block, wrap the render_callback to check availability.
if ( ! empty( $args['plan_check'] ) ) {
// Set up attributes.
if ( ! isset( $args['attributes'] ) ) {
$args['attributes'] = array();
}
$args['attributes'] = array_merge(
$args['attributes'],
array(
// Indicates that this block should display an upgrade nudge on the frontend when applicable.
'shouldDisplayFrontendBanner' => array(
'type' => 'boolean',
'default' => true,
),
)
);
if ( isset( $args['render_callback'] ) ) {
$args['render_callback'] = Jetpack_Gutenberg::get_render_callback_with_availability_check( $feature_name, $args['render_callback'] );
}
$method_name = 'set_availability_for_plan';
} else {
$method_name = 'set_extension_available';
}
add_action(
'jetpack_register_gutenberg_extensions',
function () use ( $feature_name, $method_name ) {
call_user_func( array( 'Jetpack_Gutenberg', $method_name ), $feature_name );
}
);
// Ensure editor styles are registered so that the site editor knows about the
// editor style dependency when copying styles to the editor iframe.
if ( ! isset( $args['editor_style'] ) ) {
$args['editor_style'] = 'jetpack-blocks-editor';
}
}
return register_block_type( $block_type, $args );
}
/**
* Get the block metadata. Accepts a block.json file's path (or its folder's) or its content, in
* which case it becomes an identity function.
*
* It's used by other helpers in this class so that they can accept various types as argument.
*
* @param string|array $arg Path to block.json or its parent folder, or its content as an array.
*
* @return array The block metadata.
*/
private static function get_block_metadata( $arg ) {
$metadata = is_array( $arg ) ? $arg : null;
if ( ! isset( $metadata ) ) {
$path = is_string( $arg ) ? $arg : null;
if ( isset( $path ) && ! empty( $path ) ) {
$metadata = self::get_block_metadata_from_file( self::get_path_to_block_metadata( $path ) );
}
}
return isset( $metadata ) ? $metadata : array();
}
/**
* Read block metadata from a block.json file.
*
* @param string $filename The path to the block.json file or its directory.
*
* @return array The block metadata.
*/
public static function get_block_metadata_from_file( $filename ) {
$metadata = array();
$needle = '/block.json';
$filename = $needle === substr( $filename, -strlen( $needle ) ) ? $filename : $filename . $needle;
if ( file_exists( $filename ) ) {
try {
$metadata = wp_json_file_decode( $filename, array( 'associative' => true ) );
} catch ( \Exception $e ) {
$metadata = array();
}
}
return $metadata;
}
/**
* Get the block name (includes the `jetpack` prefix).
*
* @param string|array $arg Path to block.json or its parent folder, or its content as an array.
*
* @return string The block name.
*/
public static function get_block_name( $arg ) {
$metadata = self::get_block_metadata( $arg );
return self::get_block_name_from_metadata( $metadata );
}
/**
* Get the block name from the path convention.
* For example, path "./extensions/blocks/pinterest" is assumed to define
* a block named "jetpack/pinterest" without checking any files.
*
* Any exceptions should be added to the $breaks_convention array.
* For example, blocks/premium-content defines "premium-content\/container", not "jetpack/premium-content".
* These paths will use the code that checks the disk for the block name.
*
* The unit test test_get_block_name_from_path_convention_matches_get_block_name() verifies that
* all names are correctly guessed.
*
* Run with `./vendor/bin/phpunit --filter WP_Test_Jetpack_Gutenberg`.
*
* @param string $path The path to extract the block name from.
*
* @return string The block name with 'jetpack/' prefix.
*/
public static function get_block_name_from_path_convention( $path ) {
$path_parts = explode( '/', $path );
if ( count( $path_parts ) <= 0 ) {
$block_type = self::get_path_to_block_metadata( $path );
return self::get_block_name( $block_type );
}
$last_part = $path_parts[ count( $path_parts ) - 1 ];
$breaks_convention = array( 'premium-content' );
if ( in_array( $last_part, $breaks_convention, true ) ) {
$block_type = self::get_path_to_block_metadata( $path );
return self::get_block_name( $block_type );
}
return 'jetpack/' . $last_part;
}
/**
* Get the block name from the its metadata.
*
* @param array $metadata The block metadata.
*
* @return string The block name.
*/
public static function get_block_name_from_metadata( $metadata ) {
return ! isset( $metadata['name'] ) || empty( $metadata['name'] ) ? '' : $metadata['name'];
}
/**
* Get the block feature name (i.e. the name without the `jetpack` prefix).
*
* @param string|array $arg Path to block.json or its parent folder, or its content as an array.
*
* @return string The block feature name.
*/
public static function get_block_feature( $arg ) {
$metadata = self::get_block_metadata( $arg );
return self::get_block_feature_from_metadata( $metadata );
}
/**
* Get the block feature name (i.e. the name without the `jetpack` prefix) from its metadata.
*
* @param array $metadata The block metadata.
*
* @return string The block feature name.
*/
public static function get_block_feature_from_metadata( $metadata ) {
return str_replace( 'jetpack/', '', self::get_block_name_from_metadata( $metadata ) );
}
/**
* Check if an extension/block is already registered
*
* @since 1.1.0
*
* @param string $slug Name of extension/block to check.
*
* @return bool
*/
public static function is_registered( $slug ) {
return \WP_Block_Type_Registry::get_instance()->is_registered( $slug );
}
/**
* Remove the 'jetpack/' or jetpack-' prefix from an extension name
*
* @since 1.1.0
*
* @param string $extension_name The extension name.
*
* @return string The unprefixed extension name.
*/
public static function remove_extension_prefix( $extension_name ) {
if ( str_starts_with( $extension_name, 'jetpack/' ) || str_starts_with( $extension_name, 'jetpack-' ) ) {
return substr( $extension_name, strlen( 'jetpack/' ) );
}
return $extension_name;
}
/**
* Check to see if a minimum version of Gutenberg is available. Because a Gutenberg version is not available in
* php if the Gutenberg plugin is not installed, if we know which minimum WP release has the required version we can
* optionally fall back to that.
*
* @since 1.1.0
*
* @param array $version_requirements {
* An array containing the required Gutenberg version and, if known, the WordPress version that was released with this minimum version.
*
* @type string $gutenberg Gutenberg version.
* @type string $wp Optional. WordPress version.
* }
* @param string $slug The slug of the block or plugin that has the Gutenberg version requirement.
*
* @return boolean True if the version of Gutenberg required by the block or plugin is available.
*/
public static function is_gutenberg_version_available( $version_requirements, $slug ) {
global $wp_version;
// Bail if we don't at least have the Gutenberg version requirement, the WP version is optional.
if ( empty( $version_requirements['gutenberg'] ) ) {
return false;
}
// If running a local dev build of Gutenberg plugin GUTENBERG_DEVELOPMENT_MODE is set so assume correct version.
if ( defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE ) {
return true;
}
$version_available = false;
// If running a production build of the Gutenberg plugin then GUTENBERG_VERSION is set, otherwise if WP version
// with required version of Gutenberg is known check that.
if ( defined( 'GUTENBERG_VERSION' ) ) {
$version_available = version_compare( GUTENBERG_VERSION, $version_requirements['gutenberg'], '>=' );
} elseif ( ! empty( $version_requirements['wp'] ) ) {
$version_available = version_compare( $wp_version, $version_requirements['wp'], '>=' );
}
if (
! $version_available
&& ! self::is_standalone_block() // This is only useful in Jetpack.
) {
$slug = Jetpack_Gutenberg::remove_extension_prefix( $slug );
Jetpack_Gutenberg::set_extension_unavailable(
$slug,
'incorrect_gutenberg_version',
array(
'required_feature' => $slug,
'required_version' => $version_requirements,
'current_version' => array(
'wp' => $wp_version,
'gutenberg' => defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : null,
),
)
);
}
return $version_available;
}
/**
* Get CSS classes for a block.
*
* @since 1.1.0
*
* @param string $slug Block slug.
* @param array $attr Block attributes.
* @param array $extra Potential extra classes you may want to provide.
*
* @return string $classes List of CSS classes for a block.
*/
public static function classes( $slug, $attr, $extra = array() ) {
if ( empty( $slug ) ) {
return '';
}
// Basic block name class.
$classes = array(
'wp-block-jetpack-' . $slug,
);
// Add alignment if provided.
if (
! empty( $attr['align'] )
&& in_array( $attr['align'], array( 'left', 'center', 'right', 'wide', 'full' ), true )
) {
$classes[] = 'align' . $attr['align'];
}
// Add custom classes if provided in the block editor.
if ( ! empty( $attr['className'] ) ) {
$classes[] = $attr['className'];
}
// Add any extra classes.
if ( is_array( $extra ) && ! empty( $extra ) ) {
$classes = array_merge( $classes, array_filter( $extra ) );
}
return implode( ' ', $classes );
}
/**
* Does the page return AMP content.
*
* @since 1.1.0
*
* @return bool $is_amp_request Are we on an AMP view.
*/
public static function is_amp_request() {
$is_amp_request = ( function_exists( 'is_amp_endpoint' ) && is_amp_endpoint() );
/** This filter is documented in 3rd-party/class.jetpack-amp-support.php */
return apply_filters( 'jetpack_is_amp_request', $is_amp_request );
}
/**
* Is the current theme an FSE/Site Editor theme.
*
* @since 1.4.0
* @since 1.4.22 Remove support for deprecated `gutenberg_is_fse_theme` function.
*
* @return bool True if the current theme is an FSE/Site Editor theme.
*/
public static function is_fse_theme() {
$is_fse_theme = wp_is_block_theme();
/**
* Returns true if the current theme is an FSE/Site Editor theme.
*
* @since 1.4.0
*
* @param boolean $is_fse_theme Is the theme an FSE theme.
*/
return apply_filters( 'jetpack_is_fse_theme', $is_fse_theme );
}
/**
* Check whether or the block being registered is a standalone block,
* running in a context outside of the Jetpack plugin.
*
* @since 1.3.0
*
* @return bool
*/
public static function is_standalone_block() {
$is_standalone_block = ! class_exists( Jetpack_Gutenberg::class );
/**
* Returns true if the block is not being registered within a Jetpack plugin context.
*
* @since 1.3.0
*
* @param boolean $is_standalone_block Is the block running standalone versus as part of the Jetpack plugin.
*/
return apply_filters( 'jetpack_is_standalone_block', $is_standalone_block );
}
/**
* Returns the path to the directory containing the block.json metadata file of a block, given its
* source code directory and, optionally, the directory that holds the blocks built files of
* the package. If the directory doesn't exist, falls back to the source directory.
*
* @since 1.6.0
*
* @param string $block_src_dir The path to the folder containing the block source code.
* Typically this is done by passing __DIR__ as the argument.
* @param string $package_dist_dir Optional. A full path to the directory containing the blocks
* built files of the package. Default empty.
*
* @return string The path to the directory.
*/
public static function get_path_to_block_metadata( $block_src_dir, $package_dist_dir = '' ) {
$dir = basename( $block_src_dir );
$dist_path = empty( $package_dist_dir ) ? dirname( Jetpack_Constants::get_constant( 'JETPACK__PLUGIN_FILE' ) ) . '/_inc/blocks' : $package_dist_dir;
$result = realpath( "$dist_path/$dir" );
return false === $result ? $block_src_dir : $result;
}
/**
* Determine whether a site should use the default set of blocks, or a custom set.
* Possible variations are currently beta, experimental, and production.
*
* @since 3.1.0
*
* @return string $block_variation production|beta|experimental
*/
public static function get_variation() {
// Default to production blocks.
$block_variation = 'production';
/*
* Prefer to use this JETPACK_BLOCKS_VARIATION constant
* or the jetpack_blocks_variation filter
* to set the block variation in your code.
*/
$default = Constants::get_constant( 'JETPACK_BLOCKS_VARIATION' );
if ( ! empty( $default ) && in_array( $default, array( 'beta', 'experimental', 'production' ), true ) ) {
$block_variation = $default;
}
/**
* Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
*
* @since jetpack-6.9.0
* @deprecated jetpack-11.8.0 Use jetpack_blocks_variation filter instead.
*
* @param boolean
*/
$is_beta = apply_filters_deprecated(
'jetpack_load_beta_blocks',
array( false ),
'jetpack-11.8.0',
'jetpack_blocks_variation'
);
/*
* Switch to beta blocks if you use the JETPACK_BETA_BLOCKS constant
* or the deprecated jetpack_load_beta_blocks filter.
* This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
*/
if ( empty( $default )
&& (
$is_beta
|| Constants::is_true( 'JETPACK_BETA_BLOCKS' )
)
) {
$block_variation = 'beta';
}
/**
* Alternative to `JETPACK_EXPERIMENTAL_BLOCKS`, set to `true` to load Experimental Blocks.
*
* @since jetpack-6.9.0
* @deprecated jetpack-11.8.0 Use jetpack_blocks_variation filter instead.
*
* @param boolean
*/
$is_experimental = apply_filters_deprecated(
'jetpack_load_experimental_blocks',
array( false ),
'jetpack-11.8.0',
'jetpack_blocks_variation'
);
/*
* Switch to experimental blocks if you use the JETPACK_EXPERIMENTAL_BLOCKS constant
* or the deprecated jetpack_load_experimental_blocks filter.
* This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
*/
if ( empty( $default )
&& (
$is_experimental
|| Constants::is_true( 'JETPACK_EXPERIMENTAL_BLOCKS' )
)
) {
$block_variation = 'experimental';
}
/**
* Allow customizing the variation of blocks in use on a site.
* Overwrites any previously set values, whether by constant or filter.
*
* @since jetpack-8.1.0
*
* @param string $block_variation Can be beta, experimental, and production. Defaults to production.
*/
return apply_filters( 'jetpack_blocks_variation', $block_variation );
}
}