BP XProfile Hooks Documentation

[tw2113]

This ticket will be where all BP XProfile patches go for the Hooks Documentation.

Relevant files:
bp-xprofile-actions.php
bp-xprofile-activity.php
bp-xprofile-admin.php
bp-xprofile-cache.php
bp-xprofile-caps.php
bp-xprofile-classes.php
bp-xprofile-cssjs.php
bp-xprofile-filters.php
bp-xprofile-functions.php
bp-xprofile-loader.php
bp-xprofile-screens.php
bp-xprofile-settings.php
bp-xprofile-template.php

[DJPaul]

Moving into Future Release; we can keep these here and move them into particular releases' milestones as we commit things (or work on them).

[tw2113]

In 9284:

Adding complete version number and hook docs to bp-xprofile-caps.php.

See #5949.

[tw2113]

In 9285:

Adding hooks documentation to bp-xprofile-actions.php.

See #5949

[tw2113]

In 9286:

Adding hooks documentation for bp-xprofile-activity.php.

See #5949

[tw2113]

In 9287:

Add hook docs and fix version numbers for bp-xprofile-cssjs.php and bp-xprofile-filters.php.

See #5949.

[tw2113]

In 9289:

Adding hook docs and 3-digit @since numbers to bp-xprofile-loader.php.

See #5949

[tw2113]

In 9290:

Add hooks docs to bp-xprofile-screens.php.

See #5949.

[tw2113]

How would we like to handle these action hooks?

do_action( bp_get_the_profile_field_errors_action() );

From the looks of it, it's technically a dynamic hook based on field IDs. From the example in the phpdoc block for bp_get_the_profile_field_errors_action, they look similar to bp_field_12_errors. with the number corresponding to the field.

[boonebgorges]

My preference would be to leave the code as-is, and put the documentation as per usual right above the do_action() calls. In the documentation, explain that it's a dynamic hook, and explain how it's concatenated (like you've done here).

If, for some technical reason, this won't work with the parser, then we could start concatenating inline, and stop using bp_get_the_profile_field_errors_action() function in core.

[tw2113]

In 9298:

Adds hooks documentation for bp-xprofile-admin.php.

See #5949.

[tw2113]

In 9299:

Adds hooks documentation to bp-xprofile-template.php.

See #5949.

[tw2113]

In 9303:

Adds hooks documentation for bp-xprofile-functions.php.

See #5949.

[tw2113]

In 9304:

Adds hooks documentation to bp-xprofile-classes.php

Fixes #5949.

[tw2113]

In 9643:

Fixes double digit version numbers missed from hooks docs work.

See #5949.

[tw2113]

In 9790:

Adds hooks documentation for a field added in 2.3.0.

See #5949.

[offereins]

In 11866:

Docs: document hooks in BP_XProfile_ProfileData::save().

Adds missing hooks documentation for the 'before_save' filters applied to
the user_id, field_id, value, and last_updated details of profile field
data.

Probably missed in [9304].

See #5949.