File Manager

📂 File Manager

📝 Edit File: block-bindings.php

<?php
/**
 * Block Bindings API
 *
 * Contains functions for managing block bindings in WordPress.
 *
 * @package WordPress
 * @subpackage Block Bindings
 * @since 6.5.0
 */

/**
 * Registers a new block bindings source.
 *
 * Registering a source consists of defining a **name** for that source and a callback function specifying
 * how to get a value from that source and pass it to a block attribute.
 *
 * Once a source is registered, any block that supports the Block Bindings API can use a value
 * from that source by setting its `metadata.bindings` attribute to a value that refers to the source.
 *
 * Note that `register_block_bindings_source()` should be called from a handler attached to the `init` hook.
 *
 *
 * ## Example
 *
 * ### Registering a source
 *
 * First, you need to define a function that will be used to get the value from the source.
 *
 *     function my_plugin_get_custom_source_value( array $source_args, $block_instance, string $attribute_name ) {
 *       // Your custom logic to get the value from the source.
 *       // For example, you can use the `$source_args` to look up a value in a custom table or get it from an external API.
 *       $value = $source_args['key'];
 *
 *       return "The value passed to the block is: $value"
 *     }
 *
 * The `$source_args` will contain the arguments passed to the source in the block's
 * `metadata.bindings` attribute. See the example in the "Usage in a block" section below.
 *
 *     function my_plugin_register_block_bindings_sources() {
 *       register_block_bindings_source( 'my-plugin/my-custom-source', array(
 *         'label'              => __( 'My Custom Source', 'my-plugin' ),
 *         'get_value_callback' => 'my_plugin_get_custom_source_value',
 *       ) );
 *     }
 *     add_action( 'init', 'my_plugin_register_block_bindings_sources' );
 *
 * ### Usage in a block
 *
 * In a block's `metadata.bindings` attribute, you can specify the source and
 * its arguments. Such a block will use the source to override the block
 * attribute's value. For example:
 *
 *     
 *     <p>Fallback text that gets replaced.</p>
 *     
 *
 * @since 6.5.0
 *
 * @param string $source_name       The name of the source. It must be a string containing a namespace prefix, i.e.
 *                                  `my-plugin/my-custom-source`. It must only contain lowercase alphanumeric
 *                                  characters, the forward slash `/` and dashes.
 * @param array  $source_properties {
 *     The array of arguments that are used to register a source.
 *
 *     @type string   $label              The label of the source.
 *     @type callable $get_value_callback A callback executed when the source is processed during block rendering.
 *                                        The callback should have the following signature:
 *
 *                                        `function( $source_args, $block_instance, $attribute_name ): mixed`
 *                                            - @param array    $source_args    Array containing source arguments
 *                                                                              used to look up the override value,
 *                                                                              i.e. {"key": "foo"}.
 *                                            - @param WP_Block $block_instance The block instance.
 *                                            - @param string   $attribute_name The name of an attribute.
 *                                        The callback has a mixed return type; it may return a string to override
 *                                        the block's original value, null, false to remove an attribute, etc.
 *     @type string[] $uses_context       Optional. Array of values to add to block `uses_context` needed by the source.
 * }
 * @return WP_Block_Bindings_Source|false Source when the registration was successful, or `false` on failure.
 */
function register_block_bindings_source( string $source_name, array $source_properties ) {
	return WP_Block_Bindings_Registry::get_instance()->register( $source_name, $source_properties );
}

/**
 * Unregisters a block bindings source.
 *
 * @since 6.5.0
 *
 * @param string $source_name Block bindings source name including namespace.
 * @return WP_Block_Bindings_Source|false The unregistered block bindings source on success and `false` otherwise.
 */
function unregister_block_bindings_source( string $source_name ) {
	return WP_Block_Bindings_Registry::get_instance()->unregister( $source_name );
}

/**
 * Retrieves the list of all registered block bindings sources.
 *
 * @since 6.5.0
 *
 * @return WP_Block_Bindings_Source[] The array of registered block bindings sources.
 */
function get_all_registered_block_bindings_sources() {
	return WP_Block_Bindings_Registry::get_instance()->get_all_registered();
}

/**
 * Retrieves a registered block bindings source.
 *
 * @since 6.5.0
 *
 * @param string $source_name The name of the source.
 * @return WP_Block_Bindings_Source|null The registered block bindings source, or `null` if it is not registered.
 */
function get_block_bindings_source( string $source_name ) {
	return WP_Block_Bindings_Registry::get_instance()->get_registered( $source_name );
}

Type	Item Name	Actions
📁	..
📁	assets
📁	block-bindings
📁	block-patterns
📁	block-supports
📁	blocks
📁	certificates
📁	css
📁	customize
📁	fonts
📁	html-api
📁	ID3
📁	images
📁	interactivity-api
📁	IXR
📁	js
📁	l10n
📁	php-compat
📁	PHPMailer
📁	pomo
📁	Requests
📁	rest-api
📁	SimplePie
📁	sitemaps
📁	sodium_compat
📁	style-engine
📁	Text
📁	theme-compat
📁	widgets
📄	admin-bar.php
📄	atomlib.php
📄	author-template.php
📄	block-bindings.php
📄	block-editor.php
📄	block-i18n.json
📄	block-patterns.php
📄	block-template-utils.php
📄	block-template.php
📄	blocks.php
📄	bookmark-template.php
📄	bookmark.php
📄	cache-compat.php
📄	cache.php
📄	canonical.php
📄	capabilities.php
📄	category-template.php
📄	category.php
📄	class-avif-info.php
📄	class-feed.php
📄	class-http.php
📄	class-IXR.php
📄	class-json.php
📄	class-oembed.php
📄	class-phpass.php
📄	class-phpmailer.php
📄	class-pop3.php
📄	class-requests.php
📄	class-simplepie.php
📄	class-smtp.php
📄	class-snoopy.php
📄	class-walker-category-dropdown.php
📄	class-walker-category.php
📄	class-walker-comment.php
📄	class-walker-nav-menu.php
📄	class-walker-page-dropdown.php
📄	class-walker-page.php
📄	class-wp-admin-bar.php
📄	class-wp-ajax-response.php
📄	class-wp-application-passwords.php
📄	class-wp-block-bindings-registry.php
📄	class-wp-block-bindings-source.php
📄	class-wp-block-editor-context.php
📄	class-wp-block-list.php
📄	class-wp-block-metadata-registry.php
📄	class-wp-block-parser-block.php
📄	class-wp-block-parser-frame.php
📄	class-wp-block-parser.php
📄	class-wp-block-pattern-categories-registry.php
📄	class-wp-block-patterns-registry.php
📄	class-wp-block-styles-registry.php
📄	class-wp-block-supports.php
📄	class-wp-block-template.php
📄	class-wp-block-templates-registry.php
📄	class-wp-block-type-registry.php
📄	class-wp-block-type.php
📄	class-wp-block.php
📄	class-wp-classic-to-block-menu-converter.php
📄	class-wp-comment-query.php
📄	class-wp-comment.php
📄	class-wp-customize-control.php
📄	class-wp-customize-manager.php
📄	class-wp-customize-nav-menus.php
📄	class-wp-customize-panel.php
📄	class-wp-customize-section.php
📄	class-wp-customize-setting.php
📄	class-wp-customize-widgets.php
📄	class-wp-date-query.php
📄	class-wp-dependencies.php
📄	class-wp-dependency.php
📄	class-wp-duotone.php
📄	class-wp-editor.php
📄	class-wp-embed.php
📄	class-wp-error.php
📄	class-wp-exception.php
📄	class-wp-fatal-error-handler.php
📄	class-wp-feed-cache-transient.php
📄	class-wp-feed-cache.php
📄	class-wp-hook.php
📄	class-wp-http-cookie.php
📄	class-wp-http-curl.php
📄	class-wp-http-encoding.php
📄	class-wp-http-ixr-client.php
📄	class-wp-http-proxy.php
📄	class-wp-http-requests-hooks.php
📄	class-wp-http-requests-response.php
📄	class-wp-http-response.php
📄	class-wp-http-streams.php
📄	class-wp-http.php
📄	class-wp-image-editor-gd.php
📄	class-wp-image-editor-imagick.php
📄	class-wp-image-editor.php
📄	class-wp-list-util.php
📄	class-wp-locale-switcher.php
📄	class-wp-locale.php
📄	class-wp-matchesmapregex.php
📄	class-wp-meta-query.php
📄	class-wp-metadata-lazyloader.php
📄	class-wp-navigation-fallback.php
📄	class-wp-network-query.php
📄	class-wp-network.php
📄	class-wp-object-cache.php
📄	class-wp-oembed-controller.php
📄	class-wp-oembed.php
📄	class-wp-paused-extensions-storage.php
📄	class-wp-plugin-dependencies.php
📄	class-wp-post-type.php
📄	class-wp-post.php
📄	class-wp-query.php
📄	class-wp-recovery-mode-cookie-service.php
📄	class-wp-recovery-mode-email-service.php
📄	class-wp-recovery-mode-key-service.php
📄	class-wp-recovery-mode-link-service.php
📄	class-wp-recovery-mode.php
📄	class-wp-rewrite.php
📄	class-wp-role.php
📄	class-wp-roles.php
📄	class-wp-script-modules.php
📄	class-wp-scripts.php
📄	class-wp-session-tokens.php
📄	class-wp-simplepie-file.php
📄	class-wp-simplepie-sanitize-kses.php
📄	class-wp-site-query.php
📄	class-wp-site.php
📄	class-wp-styles.php
📄	class-wp-tax-query.php
📄	class-wp-taxonomy.php
📄	class-wp-term-query.php
📄	class-wp-term.php
📄	class-wp-text-diff-renderer-inline.php
📄	class-wp-text-diff-renderer-table.php
📄	class-wp-textdomain-registry.php
📄	class-wp-theme-json-data.php
📄	class-wp-theme-json-resolver.php
📄	class-wp-theme-json-schema.php
📄	class-wp-theme-json.php
📄	class-wp-theme.php
📄	class-wp-token-map.php
📄	class-wp-user-meta-session-tokens.php
📄	class-wp-user-query.php
📄	class-wp-user-request.php
📄	class-wp-user.php
📄	class-wp-walker.php
📄	class-wp-widget-factory.php
📄	class-wp-widget.php
📄	class-wp-xmlrpc-server.php
📄	class-wp.php
📄	class-wpdb.php
📄	class.wp-dependencies.php
📄	class.wp-scripts.php
📄	class.wp-styles.php
📄	comment-template.php
📄	comment.php
📄	compat.php
📄	cron.php
📄	date.php
📄	default-constants.php
📄	default-filters.php
📄	default-widgets.php
📄	deprecated.php
📄	embed-template.php
📄	embed.php
📄	error-protection.php
📄	feed-atom-comments.php
📄	feed-atom.php
📄	feed-rdf.php
📄	feed-rss.php
📄	feed-rss2-comments.php
📄	feed-rss2.php
📄	feed.php
📄	fonts.php
📄	formatting.php
📄	functions.php
📄	functions.wp-scripts.php
📄	functions.wp-styles.php
📄	general-template.php
📄	global-styles-and-settings.php
📄	http.php
📄	https-detection.php
📄	https-migration.php
📄	kses.php
📄	l10n.php
📄	link-template.php
📄	load.php
📄	locale.php
📄	media-template.php
📄	media.php
📄	meta.php
📄	ms-blogs.php
📄	ms-default-constants.php
📄	ms-default-filters.php
📄	ms-deprecated.php
📄	ms-files.php
📄	ms-functions.php
📄	ms-load.php
📄	ms-network.php
📄	ms-settings.php
📄	ms-site.php
📄	nav-menu-template.php
📄	nav-menu.php
📄	option.php
📄	pluggable-deprecated.php
📄	pluggable.php
📄	plugin.php
📄	post-formats.php
📄	post-template.php
📄	post-thumbnail-template.php
📄	post.php
📄	query.php
📄	registration-functions.php
📄	registration.php
📄	rest-api.php
📄	revision.php
📄	rewrite.php
📄	robots-template.php
📄	rss-functions.php
📄	rss.php
📄	script-loader.php
📄	script-modules.php
📄	session.php
📄	shortcodes.php
📄	sitemaps.php
📄	spl-autoload-compat.php
📄	style-engine.php
📄	taxonomy.php
📄	template-canvas.php
📄	template-loader.php
📄	template.php
📄	theme-i18n.json
📄	theme-previews.php
📄	theme-templates.php
📄	theme.json
📄	theme.php
📄	update.php
📄	user.php
📄	vars.php
📄	version.php
📄	widgets.php
📄	wp-db.php
📄	wp-diff.php