register_post_meta( string $post_type, string $meta_key, array $args ): bool

Parameters

$post_typestring

Post type to register a meta key for. Pass an empty string to register the meta key across all existing post types.

$meta_keystring

The meta key to register.

$argsarray

Data used to describe the meta key when registered. See register_meta() for a list of supported arguments.

Return

bool

True if the meta key was successfully registered, false if not.

Uses · 1

• register_meta()Registers a meta key.

Used by · 2

• register_block_core_footnotes_post_meta()Registers the footnotes meta field required for footnotes to work.
• wp_create_initial_post_meta()Registers any additional post meta fields.

Source

View on Trac ↗View on GitHub ↗

2812function register_post_meta( $post_type, $meta_key, array $args ) {2813	$args['object_subtype'] = $post_type;2814 2815	return register_meta( 'post', $meta_key, $args );2816}

History

Introduced in 4.9.8. 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/post.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.