sitemap-buffer-image-xmlwriter.php — Jetpack – WP Security, Backup, Speed, & Growth 14.7.1

jetpack / modules / sitemaps / sitemap-buffer-image-xmlwriter.php

jetpack / modules / sitemaps Last commit date

sitemap-buffer-image-xmlwriter.php

102 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* XMLWriter implementation of the image sitemap buffer.
4	*
5	* @since 14.6
6	* @package automattic/jetpack
7	*/
8
9	/**
10	* A buffer for constructing sitemap image xml files using XMLWriter.
11	*
12	* @since 14.6
13	*/
14	class Jetpack_Sitemap_Buffer_Image_XMLWriter extends Jetpack_Sitemap_Buffer_XMLWriter {
15	/**
16	* Initialize the buffer with required headers and root element.
17	*/
18	protected function initialize_buffer() {
19	// Add generator comment
20	$this->writer->writeComment( "generator='jetpack-" . JETPACK__VERSION . "'" );
21	$this->writer->writeComment( 'Jetpack_Sitemap_Buffer_Image_XMLWriter' );
22
23	// Add stylesheet
24	$this->writer->writePi(
25	'xml-stylesheet',
26	'type="text/xsl" href="' . $this->finder->construct_sitemap_url( 'image-sitemap.xsl' ) . '"'
27	);
28
29	// Start root element with namespaces
30	$this->writer->startElement( 'urlset' );
31
32	/**
33	* Filter the XML namespaces included in image sitemaps.
34	*
35	* @module sitemaps
36	*
37	* @since 4.8.0
38	*
39	* @param array $namespaces Associative array with namespaces and namespace URIs.
40	*/
41	$namespaces = apply_filters(
42	'jetpack_sitemap_image_ns',
43	array(
44	'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
45	'xsi:schemaLocation' => 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd',
46	'xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9',
47	'xmlns:image' => 'http://www.google.com/schemas/sitemap-image/1.1',
48	)
49	);
50
51	foreach ( $namespaces as $name => $value ) {
52	$this->writer->writeAttribute( $name, $value );
53	}
54	}
55
56	/**
57	* Append a URL entry with image information to the sitemap.
58	*
59	* @param array $array The URL item to append.
60	*/
61	protected function append_item( $array ) {
62	if ( ! isset( $array['url'] ) \|\| ! is_array( $array['url'] ) ) {
63	return;
64	}
65
66	$url = $array['url'];
67
68	$this->writer->startElement( 'url' );
69
70	if ( isset( $url['loc'] ) ) {
71	$this->writer->writeElement( 'loc', esc_url( $url['loc'] ) );
72	}
73
74	if ( isset( $url['lastmod'] ) ) {
75	$this->writer->writeElement( 'lastmod', esc_html( $url['lastmod'] ) );
76	}
77
78	if ( isset( $url['image:image'] ) && is_array( $url['image:image'] ) ) {
79	$this->writer->startElement( 'image:image' );
80
81	// Required image loc
82	if ( isset( $url['image:image']['image:loc'] ) ) {
83	$this->writer->writeElement( 'image:loc', esc_url( $url['image:image']['image:loc'] ) );
84	}
85
86	// Optional image title
87	if ( ! empty( $url['image:image']['image:title'] ) ) {
88	$this->writer->writeElement( 'image:title', esc_html( $url['image:image']['image:title'] ) );
89	}
90
91	// Optional image caption
92	if ( ! empty( $url['image:image']['image:caption'] ) ) {
93	$this->writer->writeElement( 'image:caption', esc_html( $url['image:image']['image:caption'] ) );
94	}
95
96	$this->writer->endElement(); // image:image
97	}
98
99	$this->writer->endElement(); // url
100	}
101	}
102