cp_get_relationship_meta( int $relationship_id, string $meta_key = '', bool $single = '' )

Retrieves metadata for a relationship.

Parameters

$relationship_id

(Required) Relationship ID.

$meta_key

(Optional) The meta key to retrieve. By default, returns data for all keys.

Default value: ''

$single

(Optional) Whether to return a single value. This parameter has no effect if $key is not specified. Default false.

Default value: ''

Return

(mixed) An array of values if $single is false. The value of the meta field if $single is true. False for an invalid $term_id (non-numeric, zero, or negative value). An empty string if a valid but non-existing term ID is passed.

Source

File: wp-includes/object-relationships.php

function cp_get_relationship_meta( $relationship_id, $meta_key = '', $single = '' ) {
	return get_metadata( 'object_relationship', $relationship_id, $meta_key, $single );
}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/meta.php: get_metadata()	Retrieves the value of a metadata field for the specified object type and ID.

Used By

Used By
Used By	Description
wp-includes/object-relationships.php: cp_delete_relationship_meta_when_relationship_deleted()	Delete all object relationship metadata when the relationship to which it relates is deleted.

Changelog

Changelog
Version	Description
CP-2.2.0	Introduced. CP-2.2.0