[wp-meta] [Making WordPress.org] #7780: Documentation Update: Missing one important param

Making WordPress.org noreply at wordpress.org
Fri Sep 20 00:38:26 UTC 2024


#7780: Documentation Update: Missing one important param
---------------------------+--------------------------------
 Reporter:  pyrobd         |       Owner:  (none)
     Type:  enhancement    |      Status:  closed
 Priority:  normal         |   Milestone:
Component:  Developer Hub  |  Resolution:  reported-upstream
 Keywords:                 |
---------------------------+--------------------------------
Changes (by dd32):

 * status:  new => closed
 * resolution:   => reported-upstream
 * component:  General => Developer Hub


Comment:

 Hi @pyrobd and welcome to Meta Trac!

 Meta.trac is for reporting bugs on WordPress.org, and is not intended to
 be used for documentation updates.

 However, I'll forward this report onto the appropriate teams for action.

 The parameters listed on the linked page are specifically for the
 `register_activation_hook` function, which only has 2 parameters.

 However, as you note, when the callback passed as a parameter is called,
 it does have an additional `$network_wide` parameter passed. That
 parameter is documented where the callback is triggered from, the
 [https://developer.wordpress.org/reference/hooks/activate_plugin/
 activate_{$plugin} hook].

 A note on the documentation: The majority of the docs are extracted
 directly from the PHPDoc block for the function, and as such, updates to
 those sections of the code should be made via
 https://core.trac.wordpress.org/ as it's a change to the WordPress code
 itself.

 The `More Information` section is however freeform text that any
 [https://make.wordpress.org/docs/ Docs team contributors] can edit, and as
 such, I've edited it to make the link to the above action far more clear
 than it currently was, by adding this at the top:

 > For more information on what will be passed to your `$callback`, please
 see [https://developer.wordpress.org/reference/hooks/activate_plugin/ the
 activate_{$plugin} hook].

 I'm marking this as `reported upstream` as I'll mention it to the Docs
 team on Slack, although the above text change may have 'fixed' it.

-- 
Ticket URL: <https://meta.trac.wordpress.org/ticket/7780#comment:1>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org


More information about the wp-meta mailing list