wp_sitemaps_users_entry

Filter Hook

Description

Filters the sitemap entry for an individual user.

Hook Information

File Location	`wp-includes/sitemaps/providers/class-wp-sitemaps-users.php` View on GitHub
Hook Type	Filter
Line Number	`81`

Hook Parameters

Type	Name	Description
`array`	`$sitemap_entry`	Sitemap entry for the user.
`WP_User`	`$user`	User object.

Usage Examples

Basic Usage

<?php
// Hook into wp_sitemaps_users_entry
add_filter('wp_sitemaps_users_entry', 'my_custom_filter', 10, 2);

function my_custom_filter($sitemap_entry, $user) {
    // Your custom filtering logic here
    return $sitemap_entry;
}

Source Code Context

wp-includes/sitemaps/providers/class-wp-sitemaps-users.php:81 - How this hook is used in WordPress core

<?php
  76  			 * @since 5.5.0
  77  			 *
  78  			 * @param array   $sitemap_entry Sitemap entry for the user.
  79  			 * @param WP_User $user          User object.
  80  			 */
  81  			$sitemap_entry = apply_filters( 'wp_sitemaps_users_entry', $sitemap_entry, $user );
  82  			$url_list[]    = $sitemap_entry;
  83  		}
  84  
  85  		return $url_list;
  86  	}

PHP Documentation

<?php
/**
			 * Filters the sitemap entry for an individual user.
			 *
			 * @since 5.5.0
			 *
			 * @param array   $sitemap_entry Sitemap entry for the user.
			 * @param WP_User $user          User object.
			 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-includes/sitemaps/providers/class-wp-sitemaps-users.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.