deploy.api.php is out of date: it documents hooks that have been removed/refactored or moved to the Entity Dependency API project.
Update deploy.api.php to match the current API as best as possible:
| Hook | Proposed change |
|---|---|
| hook_deploy_entity_dependencies | It's now hook_entity_dependencies, no action needed. |
| hook_deploy_entity_dependencies_alter | It's now hook_entity_dependencies_alter, move it: #2426633: Update entity_dependency.api.php |
| hook_deploy_entity_belongings | It's now hook_entity_belongings, but it's currently not being called (commented out). |
| hook_deploy_entity_belongings_alter | No current equivalent. |
| hook_deploy_field_dependencies | It's now hook_field_entity_dependencies, API docs already exist in entity_dependency. |
| hook_deploy_field_dependency_alter | It's now hook_field_entity_dependencies_alter, move it: #2426633: Update entity_dependency.api.php |
| hook_deploy_item_deployed | It looks like this hook has been replaced by hook_deploy_operation_info to set up preprocess and postprocess callbacks. |
Patch needs review.
n/a
n/a
I tried to implement hook_deploy_entity_dependencies_alter from my custom module, but seems there is no where called this hook in deploy module, and my implementation does not work at all.
| Comment | File | Size | Author |
|---|---|---|---|
| #4 | deploy-1902774-4.patch | 5.43 KB | star-szr |
Comments
Comment #1
star-szrYup, I ran into this too. I think this is as a result of the entity_dependency split. Use hook_entity_dependencies_alter(), the function signature is the same. It seems like this documentation can be tweaked and moved to the entity_dependency module's api.php file.
I will create a patch to remove these docs and other dead alter hooks from deploy.api.php and create another issue in the Entity Dependency queue to add these docs there.
Comment #2
bohemier commentedThank you @Cottser
Comment #3
star-szrThanks for the bump @bohemier, time to make good on my word. I updated the issue summary with a table to indicate where everything is heading, see #2426633: Update entity_dependency.api.php for the corresponding patch in the entity_dependency project that I will post shortly.
The docs for hook_deploy_operation_info() are a lot of guesswork on my part from digging through the code. @maintainers - if those docs are too far off, documenting that hook could be split up into its own issue to make this a simple removal issue to avoid the confusion that is happening.
Comment #4
star-szrIssue summary tweak and better patch file name.
Comment #5
bohemier commentedThanks for clarifying this Cottser. Didn't know about hook_deploy_operation_info, that's a nice find :)
You're right, this really api needs updating.
Best regards
Comment #6
star-szrComment #7
badjava commentedThis looks good and we should commit this asap.
Comment #9
skwashd commentedMerged. Thanks for your work on this.