pre_user_id
Filters the comment author's user id before it is set.
Description
The first time this filter is evaluated, user_ID is checked (for back-compat), followed by the standard user_id value.
Parameters (1)
- 0. $commentdata_user_id (int)
- The comment author's user ID.
Usage
- To run the hook, copy the example below.
- $commentdata_user_id = apply_filters( 'pre_user_id', $commentdata_user_id );
- if ( !empty( $commentdata_user_id ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the pre_user_id callback
- function filter_pre_user_id( $commentdata_user_id ) {
- // make filter magic happen here...
- return $commentdata_user_id;
- };
- // add the filter
- add_filter( 'pre_user_id', 'filter_pre_user_id', 10, 1 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( 'pre_user_id', 'filter_pre_user_id', 10, 1 );
Defined (2)
The filter is defined in the following location(s).
- /wp-includes/comment.php
- $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_ID'] );
- $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_id'] );