How can I add a required field in New User Registration Form?

ikram · March 29, 2019, 6:46am

Hi all,

In our journal authors’ ORCID ID is required information and I want to add user ORCID ID in register form Profile section.
Ekran%20Al%C4%B1nt%C4%B1s%C4%B1

How can I add this field?

Thanks in advance.

ctgraham · March 29, 2019, 12:13pm

Use the orcidProfile plugin for the basis of this functionality:

I think you would need to make a modification to make the ORCID required; but if you made this an option within the plugin it might make for a good pull request.

ikram · March 29, 2019, 5:59pm

You’re right. I want to make a modification to make the ORCID required. I made this for OJS2 and it was too easy. I didn’t find how I can modify this.

ctgraham · March 29, 2019, 6:08pm

Currently, the plugin exposes the new field on the template:

github.com

pkp/orcidProfile/blob/a604ac0f51413b51324b32e28331674746818d84/OrcidProfilePlugin.inc.php#L50


	private $currentContextId;

	/**
	 * @copydoc Plugin::register()
	 */
	function register($category, $path, $mainContextId = null) {
		$success = parent::register($category, $path, $mainContextId);
		if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE')) return true;
		if ($success && $this->getEnabled($mainContextId)) {
			// Register callback for Smarty filters; add CSS
			HookRegistry::register('TemplateManager::display', array($this, 'handleTemplateDisplay'));
			// Add "Connect ORCID" button to PublicProfileForm
			HookRegistry::register('User::PublicProfile::AdditionalItems', array($this, 'handleUserPublicProfileDisplay'));
			// Display additional ORCID access information and checkbox to send e-mail to authors in the AuthorForm
			HookRegistry::register('authorform::display', array($this, 'handleFormDisplay'));
			// Send email to author, if the added checkbox was ticked
			HookRegistry::register('authorform::execute', array($this, 'handleAuthorFormExecute'));
			// Insert the OrcidHandler to handle ORCID redirects
			HookRegistry::register('LoadHandler', array($this, 'setupCallbackHandler'));

			// Handle ORCID on user registration

And processes that new field on user registration:

github.com

pkp/orcidProfile/blob/a604ac0f51413b51324b32e28331674746818d84/OrcidProfilePlugin.inc.php#L61


			// Add "Connect ORCID" button to PublicProfileForm
			HookRegistry::register('User::PublicProfile::AdditionalItems', array($this, 'handleUserPublicProfileDisplay'));
			// Display additional ORCID access information and checkbox to send e-mail to authors in the AuthorForm
			HookRegistry::register('authorform::display', array($this, 'handleFormDisplay'));
			// Send email to author, if the added checkbox was ticked
			HookRegistry::register('authorform::execute', array($this, 'handleAuthorFormExecute'));
			// Insert the OrcidHandler to handle ORCID redirects
			HookRegistry::register('LoadHandler', array($this, 'setupCallbackHandler'));

			// Handle ORCID on user registration
			HookRegistry::register('registrationform::execute', array($this, 'collectUserOrcidId'));

			// Send emails to authors without ORCID id upon submission
			HookRegistry::register('submissionsubmitstep3form::execute', array($this, 'handleSubmissionSubmitStep3FormExecute'));
			// Add more ORCiD fields to author DAO
			HookRegistry::register('authordao::getAdditionalFieldNames', array($this, 'handleAdditionalFieldNames'));
			// Add more ORCiD fields to UserDAO
			HookRegistry::register('userdao::getAdditionalFieldNames', array($this, 'handleAdditionalFieldNames'));
			// Send submission meta data upload to ORCID profiles on publication of an issue
			HookRegistry::register('IssueGridHandler::publishIssue', array($this, 'handlePublishIssue'));
			HookRegistry::register('issueentrypublicationmetadataform::execute', array($this, 'handleScheduleForPublication'));

It sounds like you would also want to hook into the form validation. You would use similar logic, but with the validation hook. There is an example of such a validation hook here:

github.com

ulsdevteam/pkp-formHoneypot/blob/7214d03d7ac047570d0a888e93bc0559ebb8528d/FormHoneypotPlugin.inc.php#L60


		$request = Application::getRequest();
		$contextId = $request->getContext() ? $request->getContext()->getId() : CONTEXT_ID_NONE;

		if ($success && $this->getEnabled($mainContextId)) {
			$request = Application::getRequest();
            $contextId = $request->getContext() ? $request->getContext()->getId() : CONTEXT_ID_NONE;
			
			// Attach to the page footer
			HookRegistry::register('Templates::Common::Footer::PageFooter', array($this, 'insertTag'));
			// Attach to the registration form validation
			HookRegistry::register('registrationform::validate', array($this, 'validateHoneypot'));
			// Attach to the registration form display
			HookRegistry::register('registrationform::display', array($this, 'initializeTimer'));
			// Add custom field if desired
			HookRegistry::register('TemplateManager::display', array($this, 'handleTemplateDisplay'));
			HookRegistry::register('registrationform::readuservars', array($this, 'handleUserVar'));
			$element = $this->getSetting($contextId, 'customElement');
			if(!$element) {
				// generate new form field
				$this->updateSetting($contextId, 'customElement', $this->generateElementName());
			}

ikram · March 29, 2019, 7:20pm

I applied this solution bu unfortunately it doesn’t work. Orcid is additionally information and it exists in both PKPUserDAO.inc.php and RegistrationForm.inc.php. I want to learn that how can I change the orcid variable required? I checked out the related titles in the forum but I didn’t find how I can convert a variable to the required in the registration form.

ctgraham · March 29, 2019, 7:29pm

Making a field required is a function of the form validation. (Hence, the “registrationform::validate” hook.

Can you share the code you tried, but which didn’t work? Forking the orcidProfile repository in GitHub would be ideal, but you can also share code directly in the forum, if needed.

ikram · March 29, 2019, 7:48pm

I downloaded master branch orcid profile plugin and uploaded in plugins/generic folder. The changes already made those you give above in the OrcidProfilePlugin.inc.php. I activated the ORCID Profile plugin in Settings/Website/Plugins. When I enter the new user register, the page doesn’t work. There isn’t any error information about this in the error.log

ctgraham · March 29, 2019, 8:19pm

If you manually uploaded the plugin files (outside of the plugin gallery), did you run the upgrade script to register the new plugin?

What specific version of OJS are you using?

What specifically happens when you enter the new user registration page?

ikram · March 29, 2019, 8:29pm

My OJS version is 3.1.1.4. After uploaded plugin the new user registration page didn’t work. I didn’t run the upgrade script.

ctgraham · April 1, 2019, 12:14pm

When installing a new generic plugin, the plugin must be registered with the application. This happens automatically when uploading a plugin through the Plugin Gallery. If the files are copied manually, the best way to register the plugin is to re-run the OJS upgrade script, either from the command line or through the web interface:

github.com

pkp/ojs/blob/main/docs/UPGRADE.md#upgrading-the-ojs-database

# Upgrading an OJS Installation

Note: Before upgrading your installation, perform a complete backup of your
data files and database. If the upgrade process fails, you will need to recover
from backup before continuing.

If you are using PHP Safe Mode, please ensure that the max_execution_time
directive in your php.ini configuration file is set to a high limit. If this
or any other time limit (e.g. Apache's "Timeout" directive) is reached and
the upgrade process is interrupted, manual intervention will be required.


## Upgrading from OJS 2.0.x, 2.1.x, 2.2.x, or 2.3.x

See [docs/UPGRADE-UNSUPPORTED](UPGRADE-UNSUPPORTED.md).


## Upgrading from OJS 2.4.x

OJS 3.x is a major rewrite of Open Journal Systems, introducing numerous new

This file has been truncated. show original

ikram · April 1, 2019, 12:58pm

Alec you’re right. I’m already doing it. But before upgrading need to be careful. Because if the plugin is wrong version this upgrading can disrupt the db. I also uploaded a plugin about most read artciles and I’ve been trying to fix it since last night. At the end I can not reach Installed Plugins.

salehig · April 1, 2020, 1:50am

Hi @ctgraham,
I need to add a new field in registration form to be saved in the user profile, in ojs 3.1.0.1. However we do not want to modify the source code. We only would do it by adding a plugin. I was wondering if it is possible at all. I noticed there is already a setOrcid function that was used in orcidProfile plugin. How ever we cannot add a corresponding functin in core. Have you got any suggestion for this?

Regards
Ghazal

ctgraham · April 1, 2020, 12:43pm

This can be done entirely with a plugin calling core hooks.

For example, you can add a new datafield to a user:

github.com

ulsdevteam/pkp-akismet/blob/61e4e95cfc9833283730d1cdfc709754a1d3d05d/AkismetPlugin.inc.php#L40


      
          	 * @copydoc LazyLoadPlugin::register()
          	 */
          	function register($category, $path, $mainContextId = NULL) {
          		$success = parent::register($category, $path, $mainContextId);
          		if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE')) return true;
          		if ($success && $this->getEnabled()) {
          
          			// Enable Akismet anti-spam check of new registrations
          			HookRegistry::register('registrationform::validate', array(&$this, 'checkAkismet'));
          			HookRegistry::register('registrationform::execute', array(&$this, 'storeAkismetData'));
          			HookRegistry::register('userdao::getAdditionalFieldNames', array(&$this, 'addAkismetSetting'));
          			// Add a link to mark a missed spam user
          			HookRegistry::register('TemplateManager::fetch', array($this, 'templateFetchCallback'));
          			// Add a handler to process a missed spam user
          			HookRegistry::register('LoadComponentHandler', array($this, 'callbackLoadHandler'));
          			// Register callback to add text to registration page
          			HookRegistry::register('TemplateManager::display', array($this, 'handleTemplateDisplay'));
          			}
          		return $success;
          	}

github.com

ulsdevteam/pkp-akismet/blob/61e4e95cfc9833283730d1cdfc709754a1d3d05d/AkismetPlugin.inc.php#L67-L75


      
          	/**
          	 * Add the Akismet data to the User DAO
          	 * @see DAO::getAddtionalFieldNames
          	 */
          	function addAkismetSetting($hookname, $args) {
          		$fields =& $args[1];
          		$fields = array_merge($fields, array($this->getName()."::".$this->dataUserSetting));
          		return false;
          	}

You can add a field to a form, such as the registration form, as described above:

salehig · April 8, 2020, 6:22am

@ctgraham, Thanks so much for the help.
I made the new filed working on the registration form using the new plugin. I need to display it and make it available for edit in public profile tab as well. It displays the value saved at registration time. But I cannot save the edited value. I believe I need to a hook to be able to that. I have used User::PublicProfile::AdditionalItems for displaying in the user profile. Is there any hook for me to use to save it?

Thanks heaps.
Ghazal

salehig · April 9, 2020, 4:33am

I managed to find the right hook. It was publicprofileform::execute which worked for me.
Thanks