Description
Filters the links array of the logged in state for WP-Members special pages (login, register, user profile). This filter comes before wpmem_{$page}_links and allows you much more control over the elements that are in that HTML output.
{$page} can be the following:
- login (login page/shortcode); use as wpmem_login_links_args.
- register (register page/shortcode); use as wpmem_register_links_args.
- member (user profile page/shortcode); use as wpmem_member_links_args.
Parameters
$arr
(array) (required) An array of information for the links displayed when logged in:
- before_wrapper – Anything that comes before the wrapper (register|member only).
- wrapper_before – The wrapper opening tag (default: <ul>).
- rows – Row items HTML (register|member only).
- user_login – The user’s login name/username (login only)
- welcome – The welcome text string (login only).
- logout_text – The text for the logout link (login only).
- logout_link – The link for logging out (pre-filtered with wpmem_logout_link) (login only)
- wrapper_after – The wrapper closing tag (default: </ul>).
- after_wrapper – Anything that comes after the wrapper (register|member only).
Usage
The following example uses the {register}
tag (so wpmem_register_links_args
) to customize the links display of the logged in state of the [wpmem_form register] shortcode:
add_filter( 'wpmem_register_links_args', function( $args ) { // Change link #2. (Note PHP arrays begin at 0) $args['rows'][1] = '<li><a href=' . home_url( 'my-page' ) . '>Enter the members area</a></li>'; // Add another link. $args['rows'][] = '<li><a href=' . home_url( 'some-page' ) . '>My Extra Link</a></li>'; return $args; });
Notes
The array this filter handles is used to assemble a string of HTML for the logged in state of various pages (profile|register|login). This filter makes it easy to target specific parts of HTML so you can more easily change content, HTML tags, or the attributes of various tags (such as classes and IDs). The assembled HTML can be filtered later as a single string using the following (depending on the specific page/$tag):
Changelog
- Introduced in version 2.9.9 (wpmem_login_links_args)
- Introduced in version 3.0.9 (member|register args)
- Added after_wrapper parameter in 3.1.0
Source
wpmem_{$page}_links_args is located in /includes/class-wp-members-shortcodes.php.