bp_document_update_meta( int $document_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )

Update a piece of document meta.

Description

Parameters

$document_id

(Required) ID of the document item whose metadata is being updated.

$meta_key

(Required) Key of the metadata being updated.

$meta_value

(Required) Value to be set.

$prev_value

(Optional) If specified, only update existing metadata entries with the specified value. Otherwise, update all entries.

Default value: ''

Return

(bool|int) Returns false on failure. On successful update of existing metadata, returns true. On successful creation of new metadata, returns the integer ID of the new metadata row.

Source

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

function bp_document_update_meta( $document_id, $meta_key, $meta_value, $prev_value = '' ) {
	add_filter( 'query', 'bp_filter_metaid_column_name' );
	$retval = update_metadata( 'document', $document_id, $meta_key, $meta_value, $prev_value );
	remove_filter( 'query', 'bp_filter_metaid_column_name' );

	return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyBoss 1.4.0	Introduced.

Used By
Used By	Description
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::bbp_document_update_rest_field_callback()	The function to use to update the document’s value of the topic REST Field.
bp-document/classes/class-bp-document.php: BP_Document::save()	Save the document item to the database.
bp-document/classes/class-bp-document.php: BP_Document::bp_document_pdf_previews()	Does the actual PDF preview regenerate.
bp-document/bp-document-functions.php: bp_document_rename_file()	This function will rename the document name.
bp-document/bp-document-functions.php: bp_document_add_handler()	Document add handler function
bp-document/bp-document-filters.php: bp_document_forums_new_post_document_save()	Save document when new topic or reply is saved
bp-document/bp-document-filters.php: bp_document_attach_document_to_message()	Attach document to the message object.

Show 2 more used by Hide more used by

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.

Contents