Plugins, Hooks, & External Modules
Developer methods for
Plugins, Hooks, & External Modules
Hook functions
REDCap Developer Tools:
Documentation for Plugins, Hooks, & External Modules
REDCap Version 14.9.1
REDCap::getRecordIdField
(REDCap >= 5.5.0)
REDCap::getRecordIdField
— Determines the variable name of the Record ID field (i.e. the first field) of the current project
Description
string REDCap::getRecordIdField ( void )
Determines the variable name of the Record ID field (i.e. the first field) of the current project (e.g., study_id, participant_id).
Return Values
Returns the field variable name as a string.
Restrictions
This method can ONLY be used in a project context (i.e. when "pid" parameter is in the query string of the plugin URL) or else a fatal error is produced.
Examples
Example #1:
This example illustrates how to get the Record ID field to export all the record names from a project.
// Get the project's Record ID field
$record_id_field = REDCap::getRecordIdField();
// Export data in array format for all records for only the Record ID field
$data = REDCap::getData('array', null, $record_id_field);
// Since the data was returned as an array with multi-level keys, obtain the record names
// from the 1st-level array keys in $data via array_keys() and place them in a separate array.
$record_names = array_keys($data);
// Display all the record names on the page
var_dump($record_names);
REDCap 14.9.1 - © 2024 Vanderbilt University