Quantcast
Viewing all articles
Browse latest Browse all 295826

user.api.php hook summary lines should be more consistent with other entity hooks

Problem/Motivation

The hook_user_role_*() docs in user.api.php are not consistent with other documentation like hook_node_insert(). @Dave Reid pointed out in #1119158-6: user_role_save() doesn't implement a presave hook that these usually start with "Act on…".

Proposed resolution

Update the docblocks of these hooks.

Remaining tasks

Contributor tasks needed
TaskNovice task?Contributor instructionsComplete?
Create a patchYesInstructionsNo

User interface changes

n/a

API changes

n/a

Original report by @skwashd

Some of the language in user.api.inc is a little clunky and not consistent with others parts of core. This was raised during the review of #1119158: user_role_save() doesn't implement a presave hook.

An example of this is the docs for the hook_user_role_*() functions.

/**
* Inform other modules that a user role has been added.
*
...

Viewing all articles
Browse latest Browse all 295826

Trending Articles



<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>