bp_document_add_meta( int $document_id, string $meta_key, mixed $meta_value, bool $unique = false )

Add a piece of document metadata.

Description

Parameters

$document_id

(int) (Required) ID of the document item.

$meta_key

(string) (Required) Metadata key.

$meta_value

(mixed) (Required) Metadata value.

$unique

(bool) (Optional) Whether to enforce a single metadata value for the given key. If true, and the object already has a value for the key, no change will be made. Default: false.

Default value: false

Return

(int|bool) The meta ID on successful update, false on failure.

Source

File: bp-document/bp-document-functions.php

function bp_document_add_meta( $document_id, $meta_key, $meta_value, $unique = false ) {
	add_filter( 'query', 'bp_filter_metaid_column_name' );
	$retval = add_metadata( 'document', $document_id, $meta_key, $meta_value, $unique );
	remove_filter( 'query', 'bp_filter_metaid_column_name' );

	return $retval;
}

Changelog

Changelog
Version Description
BuddyBoss 1.4.0 Introduced.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.