Document hook_predeploy_NAME() hook in .api.php file

Created on 11 May 2023, over 1 year ago
Updated 25 October 2023, about 1 year ago

Problem/Motivation

It'd be nice if we had a drush_pre_deploy.api.php file which could be used to document custom Drupal hooks like hook_predeploy_NAME().

This is useful because certain IDE plugins e.g. PHPStorm's Drupal integration pick these API hook declarations up and provides you with contextual autocomplete options when writing new hook implementations.

Steps to reproduce

In PHPStorm with Drupal integration enabled.

Inside a custom module custom_module.module, type function custom_module_ and trigger the autocomplete, there should be a suggestion for custom_module_predeploy_NAME() in the list of available hooks.

Proposed resolution

Provide a simple drush_pre_deploy.api.php file documenting hook_predeploy_NAME() (example file available here)

Remaining tasks

Provide issue fork.

User interface changes

N/A

API changes

N/A

Feature request
Status

Fixed

Version

1.0

Component

Documentation

Created by

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024