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

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

jetpack / modules / sitemaps Last commit date

sitemap-buffer-image-xmlwriter.php

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