This example demonstrates how to perform a specific operation on the User Rights page of every project, in which some HTML is output to the page and then manipulated using JavaScript/jQuery to move it to a different location on the page. This specific example shows how to add a box of yellow text on the page and then move it so that it appears directly beneath the instructional text on the page.

function redcap_user_rights()
{
    // Output a div containing a special announcement onto the page
    print  '<div class="yellow" id="my_custom_user_rights_div">
                Special announcement text to display right below the instructional text
                on every User Rights page.
            </div>';

    // Use JavaScript/jQuery to move our div right below the instructional text
    print  "<script type='text/javascript'>
            $(document).ready(function(){
                // Move our div right above the table listing all the users/roles
                $( 'div#user_rights_roles_table_parent' ).before( $('div#my_custom_user_rights_div') );
            });
            </script>";
}

This example shows a simple way of performing project-specific actions using the $project_id parameter. NOTE: This particular method is not as clean or as easy to maintain for many projects at once. See the next example for a better way to implement project-specific actions for many projects.

function redcap_user_rights($project_id)
{
    // Perform certain actions for specific projects (using "switch" or "if" statements).
    switch ($project_id) {

        // Perform operations for project_id 212
        case 212:
            // do something specific for this project ...
            break;

        // Perform operations for project_id 4775
        case 4775:
            // do something specific for this project ...
            break;

        // ...
    }
}

A much more manageable way to perform project-specific operations for many projects at once is to create a directory structure where each project has its own subdirectory under the main Hooks directory (e.g., named "redcap/hooks/pid{$project_id}/redcap_user_rights.php"). This allows the code for each project to be sandboxed and separated and also makes it more manageable to utilize other files (e.g., PHP, HTML, CSS, and/or JavaScript files) that you can keep in the project's subdirectory (i.e., "pid{$project_id}") in the Hooks folder. Then the designated project handler PHP script can utilize any of the parameters passed in the function to perform actions specific to each project. NOTE: This example assumes that the "hooks" sub-directory is located in the same directory as the PHP file containing the Hook functions.

function redcap_user_rights($project_id)
{
    // Set the full path of the project handler PHP script located inside the
    // project-specific sub-folder, which itself exists in the main Hooks folder.
    $project_handler_script = dirname(__FILE__) . "/hooks/pid{$project_id}/redcap_user_rights.php";

    // Check if the project handler PHP script exists for this project, and if so,
    // then "include" the script to execute it. If not, do nothing.
    if (file_exists($project_handler_script)) include $project_handler_script;
}