WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

add_meta()

add_meta( int $post_id ): int|bool

In this article

Back to top

Adds post meta data defined in the $_POST superglobal for a post with given ID.

Parameters

$post_idintrequired

Return

int|bool

More Information

  • The information used is POSTed from the “Custom Fields” form on the Edit Post Administration screen.
  • Data used for the added metadata is taken from $_POST['metakeyselect'], $_POST['metakeyinput'], $_POST['metavalue']. Either the select or input fields are used for the meta key. If both are present, input field is used.

Source

function add_meta( $post_id ) {
	$post_id = (int) $post_id;

	$metakeyselect = isset( $_POST['metakeyselect'] ) ? wp_unslash( trim( $_POST['metakeyselect'] ) ) : '';
	$metakeyinput  = isset( $_POST['metakeyinput'] ) ? wp_unslash( trim( $_POST['metakeyinput'] ) ) : '';
	$metavalue     = isset( $_POST['metavalue'] ) ? $_POST['metavalue'] : '';
	if ( is_string( $metavalue ) ) {
		$metavalue = trim( $metavalue );
	}

	if ( ( ( '#NONE#' !== $metakeyselect ) && ! empty( $metakeyselect ) ) || ! empty( $metakeyinput ) ) {
		/*
		 * We have a key/value pair. If both the select and the input
		 * for the key have data, the input takes precedence.
		 */
		if ( '#NONE#' !== $metakeyselect ) {
			$metakey = $metakeyselect;
		}

		if ( $metakeyinput ) {
			$metakey = $metakeyinput; // Default.
		}

		if ( is_protected_meta( $metakey, 'post' ) || ! current_user_can( 'add_post_meta', $post_id, $metakey ) ) {
			return false;
		}

		$metakey = wp_slash( $metakey );

		return add_post_meta( $post_id, $metakey, $metavalue );
	}

	return false;
}

View all references View on Trac View on GitHub

UsesDescription
add_post_meta()wp-includes/post.php

Adds a meta field to the given post.

is_protected_meta()wp-includes/meta.php

Determines whether a meta key is considered protected.

current_user_can()wp-includes/capabilities.php

Returns whether the current user has the specified capability.

wp_unslash()wp-includes/formatting.php

Removes slashes from a string or recursively removes slashes from strings within an array.

wp_slash()wp-includes/formatting.php

Adds slashes to a string or recursively adds slashes to strings within an array.

Show 3 moreShow less
Used byDescription
wp_write_post()wp-admin/includes/post.php

Creates a new post from the “Write Post” form using $_POST information.

edit_post()wp-admin/includes/post.php

Updates an existing post with values provided in $_POST.

wp_ajax_add_meta()wp-admin/includes/ajax-actions.php

Handles adding meta via AJAX.

Changelog

VersionDescription
1.2.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.