Changeset 48098
- Timestamp:
- 06/19/2020 10:24:14 PM (3 years ago)
- Location:
- trunk/src/wp-includes
- Files:
-
- 10 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/wp-includes/sitemaps.php
r48094 r48098 50 50 * @since 5.5.0 51 51 * 52 * @param WP_Sitemaps $ sitemaps Serverobject.52 * @param WP_Sitemaps $wp_sitemaps Sitemaps object. 53 53 */ 54 54 do_action( 'wp_sitemaps_init', $wp_sitemaps ); … … 59 59 60 60 /** 61 * Gets a listof sitemap providers.61 * Gets an array of sitemap providers. 62 62 * 63 63 * @since 5.5.0 64 64 * 65 * @return array $sitemaps A list of registeredsitemap providers.65 * @return WP_Sitemaps_Provider[] Array of sitemap providers. 66 66 */ 67 67 function wp_get_sitemaps() { -
trunk/src/wp-includes/sitemaps/class-wp-sitemaps-index.php
r48093 r48098 41 41 * @since 5.5.0 42 42 * 43 * @return array Listof all sitemaps.43 * @return array[] Array of all sitemaps. 44 44 */ 45 45 public function get_sitemap_list() { … … 70 70 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 71 71 * 72 * @return string The sitemap index url.72 * @return string The sitemap index URL. 73 73 */ 74 74 public function get_index_url() { -
trunk/src/wp-includes/sitemaps/class-wp-sitemaps-provider.php
r48093 r48098 62 62 * @since 5.5.0 63 63 * 64 * @return array Listof sitemap types including object subtype name and number of pages.64 * @return array[] Array of sitemap types including object subtype name and number of pages. 65 65 */ 66 66 public function get_sitemap_type_data() { … … 99 99 * @since 5.5.0 100 100 * 101 * @return array List of sitemaps.101 * @return array[] Array of sitemap entries. 102 102 */ 103 103 public function get_sitemap_entries() { … … 121 121 * @param string $object_subtype Object subtype name. 122 122 * Empty string if the object type does not support subtypes. 123 * @param string $page Pageof results.123 * @param int $page Page number of results. 124 124 */ 125 125 $sitemap_entry = apply_filters( 'wp_sitemaps_index_entry', $sitemap_entry, $this->object_type, $type['name'], $page ); -
trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php
r48072 r48098 21 21 * @since 5.5.0 22 22 * 23 * @var arrayArray of registered sitemaps.23 * @var WP_Sitemaps_Provider[] Array of registered sitemaps. 24 24 */ 25 25 private $sitemaps = array(); … … 74 74 * @since 5.5.0 75 75 * 76 * @return array List of sitemaps.76 * @return WP_Sitemaps_Provider[] Array of sitemap providers. 77 77 */ 78 78 public function get_sitemaps() { -
trunk/src/wp-includes/sitemaps/class-wp-sitemaps-renderer.php
r48093 r48098 60 60 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 61 61 * 62 * @return string The sitemap stylesheet url.62 * @return string The sitemap stylesheet URL. 63 63 */ 64 64 public function get_sitemap_stylesheet_url() { … … 74 74 * Filters the URL for the sitemap stylesheet. 75 75 * 76 * If a fals y value is returned, no stylesheet will be used and76 * If a falsey value is returned, no stylesheet will be used and 77 77 * the "raw" XML of the sitemap will be displayed. 78 78 * 79 79 * @since 5.5.0 80 80 * 81 * @param string $sitemap_url Full URL for the sitemaps xslfile.81 * @param string $sitemap_url Full URL for the sitemaps XSL file. 82 82 */ 83 83 return apply_filters( 'wp_sitemaps_stylesheet_url', $sitemap_url ); … … 91 91 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 92 92 * 93 * @return string The sitemap index stylesheet url.93 * @return string The sitemap index stylesheet URL. 94 94 */ 95 95 public function get_sitemap_index_stylesheet_url() { … … 105 105 * Filters the URL for the sitemap index stylesheet. 106 106 * 107 * If a fals y value is returned, no stylesheet will be used and107 * If a falsey value is returned, no stylesheet will be used and 108 108 * the "raw" XML of the sitemap index will be displayed. 109 109 * 110 110 * @since 5.5.0 111 111 * 112 * @param string $sitemap_url Full URL for the sitemaps index xslfile.112 * @param string $sitemap_url Full URL for the sitemaps index XSL file. 113 113 */ 114 114 return apply_filters( 'wp_sitemaps_stylesheet_index_url', $sitemap_url ); -
trunk/src/wp-includes/sitemaps/class-wp-sitemaps-stylesheet.php
r48081 r48098 17 17 class WP_Sitemaps_Stylesheet { 18 18 /** 19 * Renders the xsl stylesheet depending on whether its the sitemap index or not.19 * Renders the XSL stylesheet depending on whether it's the sitemap index or not. 20 20 * 21 21 * @param string $type Stylesheet type. Either 'sitemap' or 'index'. … … 38 38 39 39 /** 40 * Returns the escaped xslfor all sitemaps, except index.40 * Returns the escaped XSL for all sitemaps, except index. 41 41 * 42 42 * @since 5.5.0 … … 142 142 * @since 5.5.0 143 143 * 144 * @param string $xsl Full content for the xmlstylesheet.144 * @param string $xsl_content Full content for the XML stylesheet. 145 145 */ 146 146 return apply_filters( 'wp_sitemaps_stylesheet_content', $xsl_content ); … … 148 148 149 149 /** 150 * Returns the escaped xslfor the index sitemaps.150 * Returns the escaped XSL for the index sitemaps. 151 151 * 152 152 * @since 5.5.0 … … 236 236 * @since 5.5.0 237 237 * 238 * @param string $xsl Full content for the xmlstylesheet.238 * @param string $xsl_content Full content for the XML stylesheet. 239 239 */ 240 240 return apply_filters( 'wp_sitemaps_stylesheet_index_content', $xsl_content ); … … 278 278 279 279 /** 280 * Filters the cssonly for the sitemap stylesheet.280 * Filters the CSS only for the sitemap stylesheet. 281 281 * 282 282 * @since 5.5.0 283 283 * 284 * @param string $css CSS to be applied to default xslfile.284 * @param string $css CSS to be applied to default XSL file. 285 285 */ 286 286 return apply_filters( 'wp_sitemaps_stylesheet_css', $css ); -
trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php
r48093 r48098 84 84 * Array of WP_Sitemaps_Provider objects keyed by their name. 85 85 * 86 * @type object$posts The WP_Sitemaps_Posts object.87 * @type object$taxonomies The WP_Sitemaps_Taxonomies object.88 * @type object$users The WP_Sitemaps_Users object.86 * @type WP_Sitemaps_Posts $posts The WP_Sitemaps_Posts object. 87 * @type WP_Sitemaps_Taxonomies $taxonomies The WP_Sitemaps_Taxonomies object. 88 * @type WP_Sitemaps_Users $users The WP_Sitemaps_Users object. 89 89 * } 90 90 */ -
trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php
r48072 r48098 32 32 * @since 5.5.0 33 33 * 34 * @return array Map of registered post type objects (WP_Post_Type)keyed by their name.34 * @return WP_Post_Type[] Array of registered post type objects keyed by their name. 35 35 */ 36 36 public function get_object_subtypes() { … … 43 43 * @since 5.5.0 44 44 * 45 * @param array $post_types Map of registered post type objects (WP_Post_Type)keyed by their name.45 * @param WP_Post_Type[] $post_types Array of registered post type objects keyed by their name. 46 46 */ 47 47 return apply_filters( 'wp_sitemaps_post_types', $post_types ); … … 55 55 * @param int $page_num Page of results. 56 56 * @param string $post_type Optional. Post type name. Default empty. 57 * @return array $url_listArray of URLs for a sitemap.57 * @return array Array of URLs for a sitemap. 58 58 */ 59 59 public function get_url_list( $page_num, $post_type = '' ) { … … 160 160 * Filters the max number of pages before it is generated. 161 161 * 162 * Passing a non-null value will effectivelyshort-circuit the generation,162 * Passing a non-null value will short-circuit the generation, 163 163 * returning that value instead. 164 164 * 165 165 * @since 5.5.0 166 166 * 167 * @param int $max_num_pages The maximum number of pages. Default null.168 * @param string $post_typePost type name.167 * @param null|int $max_num_pages The maximum number of pages. Default null. 168 * @param string $post_type Post type name. 169 169 */ 170 170 $max_num_pages = apply_filters( 'wp_sitemaps_posts_pre_max_num_pages', null, $post_type ); … … 189 189 * 190 190 * @param string $post_type Post type name. 191 * @return array $argsArray of WP_Query arguments.191 * @return array Array of WP_Query arguments. 192 192 */ 193 193 protected function get_posts_query_args( $post_type ) { -
trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php
r48072 r48098 31 31 * @since 5.5.0 32 32 * 33 * @return array Mapof registered taxonomy objects keyed by their name.33 * @return WP_Taxonomy[] Array of registered taxonomy objects keyed by their name. 34 34 */ 35 35 public function get_object_subtypes() { … … 41 41 * @since 5.5.0 42 42 * 43 * @param array $taxonomies Mapof registered taxonomy objects keyed by their name.43 * @param WP_Taxonomy[] $taxonomies Array of registered taxonomy objects keyed by their name. 44 44 */ 45 45 return apply_filters( 'wp_sitemaps_taxonomies', $taxonomies ); … … 53 53 * @param int $page_num Page of results. 54 54 * @param string $taxonomy Optional. Taxonomy name. Default empty. 55 * @return array $url_listArray of URLs for a sitemap.55 * @return array Array of URLs for a sitemap. 56 56 */ 57 57 public function get_url_list( $page_num, $taxonomy = '' ) { … … 135 135 * Filters the max number of pages before it is generated. 136 136 * 137 * Passing a non-null value will effectivelyshort-circuit the generation,137 * Passing a non-null value will short-circuit the generation, 138 138 * returning that value instead. 139 139 * 140 140 * @since 5.5.0 141 141 * 142 * @param int $max_num_pages The maximum number of pages. Default null.143 * @param string $taxonomy Taxonomy name.142 * @param int $max_num_pages The maximum number of pages. Default null. 143 * @param string $taxonomy Taxonomy name. 144 144 */ 145 145 $max_num_pages = apply_filters( 'wp_sitemaps_taxonomies_pre_max_num_pages', null, $taxonomy ); … … 160 160 * 161 161 * @param string $taxonomy Taxonomy name. 162 * @return array $argsArray of WP_Term_Query arguments.162 * @return array Array of WP_Term_Query arguments. 163 163 */ 164 164 protected function get_taxonomies_query_args( $taxonomy ) { -
trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-users.php
r48072 r48098 35 35 * required for compatibility with the parent 36 36 * provider class. Default empty. 37 * @return array $url_listArray of URLs for a sitemap.37 * @return array Array of URLs for a sitemap. 38 38 */ 39 39 public function get_url_list( $page_num, $object_subtype = '' ) {
Note: See TracChangeset
for help on using the changeset viewer.