register_post_meta() WordPress Function

The register_post_meta() function is used to add meta data to a post. This function takes two arguments: the post ID and the meta key. The post ID is used to identify the post to which the meta data will be added. The meta key is used to identify the meta data.

register_post_meta( string $post_type, string $meta_key, array $args ) #

Registers a meta key for posts.


Parameters

$post_type

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

$meta_key

(string)(Required)The meta key to register.

$args

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


Top ↑

Return

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


Top ↑

Source

File: wp-includes/post.php

function register_post_meta( $post_type, $meta_key, array $args ) {
	$args['object_subtype'] = $post_type;

	return register_meta( 'post', $meta_key, $args );
}


Top ↑

Changelog

Changelog
VersionDescription
4.9.8Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More