Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Sitemaps: WP_Sitemaps_Users class

[2] Fix | Delete

[3] Fix | Delete

* Builds the sitemaps for the 'user' object type.

[4] Fix | Delete

[5] Fix | Delete

* @package WordPress

[6] Fix | Delete

* @subpackage Sitemaps

[7] Fix | Delete

* @since 5.5.0

[8] Fix | Delete

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Users XML sitemap provider.

[12] Fix | Delete

[13] Fix | Delete

* @since 5.5.0

[14] Fix | Delete

[15] Fix | Delete

class WP_Sitemaps_Users extends WP_Sitemaps_Provider {

[16] Fix | Delete

/**

[17] Fix | Delete

* WP_Sitemaps_Users constructor.

[18] Fix | Delete

[19] Fix | Delete

* @since 5.5.0

[20] Fix | Delete

[21] Fix | Delete

public function __construct() {

[22] Fix | Delete

$this->name = 'users';

[23] Fix | Delete

$this->object_type = 'user';

[24] Fix | Delete

}

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Gets a URL list for a user sitemap.

[28] Fix | Delete

[29] Fix | Delete

* @since 5.5.0

[30] Fix | Delete

[31] Fix | Delete

* @param int $page_num Page of results.

[32] Fix | Delete

* @param string $object_subtype Optional. Not applicable for Users but

[33] Fix | Delete

* required for compatibility with the parent

[34] Fix | Delete

* provider class. Default empty.

[35] Fix | Delete

* @return array[] Array of URL information for a sitemap.

[36] Fix | Delete

[37] Fix | Delete

public function get_url_list( $page_num, $object_subtype = '' ) {

[38] Fix | Delete

/**

[39] Fix | Delete

* Filters the users URL list before it is generated.

[40] Fix | Delete

[41] Fix | Delete

* Returning a non-null value will effectively short-circuit the generation,

[42] Fix | Delete

* returning that value instead.

[43] Fix | Delete

[44] Fix | Delete

* @since 5.5.0

[45] Fix | Delete

[46] Fix | Delete

* @param array[]|null $url_list The URL list. Default null.

[47] Fix | Delete

* @param int $page_num Page of results.

[48] Fix | Delete

[49] Fix | Delete

$url_list = apply_filters(

[50] Fix | Delete

'wp_sitemaps_users_pre_url_list',

[51] Fix | Delete

null,

[52] Fix | Delete

$page_num

[53] Fix | Delete

);

[54] Fix | Delete

[55] Fix | Delete

if ( null !== $url_list ) {

[56] Fix | Delete

return $url_list;

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

$args = $this->get_users_query_args();

[60] Fix | Delete

$args['paged'] = $page_num;

[61] Fix | Delete

[62] Fix | Delete

$query = new WP_User_Query( $args );

[63] Fix | Delete

$users = $query->get_results();

[64] Fix | Delete

$url_list = array();

[65] Fix | Delete

[66] Fix | Delete

foreach ( $users as $user ) {

[67] Fix | Delete

$sitemap_entry = array(

[68] Fix | Delete

'loc' => get_author_posts_url( $user->ID ),

[69] Fix | Delete

);

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Filters the sitemap entry for an individual user.

[73] Fix | Delete

[74] Fix | Delete

* @since 5.5.0

[75] Fix | Delete

[76] Fix | Delete

* @param array $sitemap_entry Sitemap entry for the user.

[77] Fix | Delete

* @param WP_User $user User object.

[78] Fix | Delete

[79] Fix | Delete

$sitemap_entry = apply_filters( 'wp_sitemaps_users_entry', $sitemap_entry, $user );

[80] Fix | Delete

$url_list[] = $sitemap_entry;

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

return $url_list;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Gets the max number of pages available for the object type.

[88] Fix | Delete

[89] Fix | Delete

* @since 5.5.0

[90] Fix | Delete

[91] Fix | Delete

* @see WP_Sitemaps_Provider::max_num_pages

[92] Fix | Delete

[93] Fix | Delete

* @param string $object_subtype Optional. Not applicable for Users but

[94] Fix | Delete

* required for compatibility with the parent

[95] Fix | Delete

* provider class. Default empty.

[96] Fix | Delete

* @return int Total page count.

[97] Fix | Delete

[98] Fix | Delete

public function get_max_num_pages( $object_subtype = '' ) {

[99] Fix | Delete

/**

[100] Fix | Delete

* Filters the max number of pages for a user sitemap before it is generated.

[101] Fix | Delete

[102] Fix | Delete

* Returning a non-null value will effectively short-circuit the generation,

[103] Fix | Delete

* returning that value instead.

[104] Fix | Delete

[105] Fix | Delete

* @since 5.5.0

[106] Fix | Delete

[107] Fix | Delete

* @param int|null $max_num_pages The maximum number of pages. Default null.

[108] Fix | Delete

[109] Fix | Delete

$max_num_pages = apply_filters( 'wp_sitemaps_users_pre_max_num_pages', null );

[110] Fix | Delete

[111] Fix | Delete

if ( null !== $max_num_pages ) {

[112] Fix | Delete

return $max_num_pages;

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

$args = $this->get_users_query_args();

[116] Fix | Delete

$query = new WP_User_Query( $args );

[117] Fix | Delete

[118] Fix | Delete

$total_users = $query->get_total();

[119] Fix | Delete

[120] Fix | Delete

return (int) ceil( $total_users / wp_sitemaps_get_max_urls( $this->object_type ) );

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Returns the query args for retrieving users to list in the sitemap.

[125] Fix | Delete

[126] Fix | Delete

* @since 5.5.0

[127] Fix | Delete

[128] Fix | Delete

* @return array Array of WP_User_Query arguments.

[129] Fix | Delete

[130] Fix | Delete

protected function get_users_query_args() {

[131] Fix | Delete

$public_post_types = get_post_types(

[132] Fix | Delete

array(

[133] Fix | Delete

'public' => true,

[134] Fix | Delete

)

[135] Fix | Delete

);

[136] Fix | Delete

[137] Fix | Delete

// We're not supporting sitemaps for author pages for attachments and pages.

[138] Fix | Delete

unset( $public_post_types['attachment'] );

[139] Fix | Delete

unset( $public_post_types['page'] );

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Filters the query arguments for authors with public posts.

[143] Fix | Delete

[144] Fix | Delete

* Allows modification of the authors query arguments before querying.

[145] Fix | Delete

[146] Fix | Delete

* @see WP_User_Query for a full list of arguments

[147] Fix | Delete

[148] Fix | Delete

* @since 5.5.0

[149] Fix | Delete

[150] Fix | Delete

* @param array $args Array of WP_User_Query arguments.

[151] Fix | Delete

[152] Fix | Delete

$args = apply_filters(

[153] Fix | Delete

'wp_sitemaps_users_query_args',

[154] Fix | Delete

array(

[155] Fix | Delete

'has_published_posts' => array_keys( $public_post_types ),

[156] Fix | Delete

'number' => wp_sitemaps_get_max_urls( $this->object_type ),

[157] Fix | Delete

)

[158] Fix | Delete

);

[159] Fix | Delete

[160] Fix | Delete

return $args;

[161] Fix | Delete

}

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete