*/ namespace RankMath\Sitemap; use RankMath\KB; use RankMath\Helper; use RankMath\Traits\Ajax; use RankMath\Module\Base; use RankMath\Admin\Options; use RankMath\Helpers\Str; use RankMath\Helpers\Param; defined( 'ABSPATH' ) || exit; /** * Admin class. */ class Admin extends Base { use Ajax; /** * Module ID. * * @var string */ public $id = ''; /** * Module directory. * * @var string */ public $directory = ''; /** * The Constructor. */ public function __construct() { $directory = dirname( __FILE__ ); $this->config( [ 'id' => 'sitemap', 'directory' => $directory, ] ); parent::__construct(); $this->action( 'init', 'register_setting_page', 999 ); $this->action( 'admin_footer', 'admin_scripts' ); $this->filter( 'rank_math/settings/sitemap', 'post_type_settings' ); $this->filter( 'rank_math/settings/sitemap', 'taxonomy_settings' ); // Attachment. $this->filter( 'media_send_to_editor', 'media_popup_html', 10, 2 ); if ( Helper::has_cap( 'sitemap' ) ) { $this->filter( 'attachment_fields_to_edit', 'media_popup_fields', 20, 2 ); $this->filter( 'attachment_fields_to_save', 'media_popup_fields_save', 20, 2 ); } $this->ajax( 'remove_nginx_notice', 'remove_nginx_notice' ); } /** * Register setting page. */ public function register_setting_page() { $sitemap_url = Router::get_base_url( Sitemap::get_sitemap_index_slug() . '.xml' ); $tabs = [ 'general' => [ 'icon' => 'rm-icon rm-icon-settings', 'title' => esc_html__( 'General', 'rank-math' ), 'file' => $this->directory . '/settings/general.php', 'desc' => esc_html__( 'This tab contains General settings related to the XML sitemaps.', 'rank-math' ) . ' ' . esc_html__( 'Learn more', 'rank-math' ) . '', /* translators: sitemap url */ 'after_row' => $this->get_notice_start() . sprintf( esc_html__( 'Your sitemap index can be found here: %s', 'rank-math' ), '' . $sitemap_url . '' ) . '

' . $this->get_nginx_notice(), ], ]; $tabs['html_sitemap'] = [ 'icon' => 'rm-icon rm-icon-sitemap', 'title' => esc_html__( 'HTML Sitemap', 'rank-math' ), 'file' => $this->directory . '/settings/html-sitemap.php', 'desc' => esc_html__( 'This tab contains settings related to the HTML sitemap.', 'rank-math' ) . ' ' . esc_html__( 'Learn more', 'rank-math' ) . '', 'classes' => 'html-sitemap', ]; if ( Helper::is_author_archive_indexable() ) { $tabs['authors'] = [ 'icon' => 'rm-icon rm-icon-users', 'title' => esc_html__( 'Authors', 'rank-math' ), /* translators: Learn more link. */ 'desc' => sprintf( esc_html__( 'Set the sitemap options for author archive pages. %s.', 'rank-math' ), '' . esc_html__( 'Learn more', 'rank-math' ) . '' ), 'file' => $this->directory . '/settings/authors.php', ]; } $tabs = $this->do_filter( 'settings/sitemap', $tabs ); new Options( [ 'key' => 'rank-math-options-sitemap', 'title' => esc_html__( 'Sitemap Settings', 'rank-math' ), 'menu_title' => esc_html__( 'Sitemap Settings', 'rank-math' ), 'capability' => 'rank_math_sitemap', 'folder' => 'titles', 'position' => 99, 'tabs' => $tabs, ] ); } /** * Add post type tabs in the Sitemap Settings options panel. * * @param array $tabs Hold tabs for the options panel. * * @return array */ public function post_type_settings( $tabs ) { $icons = Helper::choices_post_type_icons(); $things = [ 'attachment' => esc_html__( 'attachments', 'rank-math' ), 'product' => esc_html__( 'your product pages', 'rank-math' ), ]; $urls = [ 'post' => KB::get( 'sitemap-post', 'Options Panel Sitemap Posts Tab' ), 'page' => KB::get( 'sitemap-page', 'Options Panel Sitemap Page Tab' ), 'attachment' => KB::get( 'sitemap-media', 'Options Panel Sitemap Attachments Tab' ), 'product' => KB::get( 'sitemap-product', 'Options Panel Sitemap Product Tab' ), ]; // Post type label seprator. $tabs['p_types'] = [ 'title' => esc_html__( 'Post Types:', 'rank-math' ), 'type' => 'seprator', ]; foreach ( Helper::get_accessible_post_types() as $post_type ) { $object = get_post_type_object( $post_type ); $sitemap_url = Router::get_base_url( $object->name . '-sitemap.xml' ); $notice_end = '

'; $name = strtolower( $object->label ); /* translators: Post Type label */ $thing = isset( $things[ $post_type ] ) ? $things[ $post_type ] : sprintf( __( 'single %s', 'rank-math' ), $name ); $url = isset( $urls[ $post_type ] ) ? $urls[ $post_type ] : KB::get( 'configure-sitemaps' ); $tabs[ 'sitemap-post-type-' . $object->name ] = [ 'title' => 'attachment' === $post_type ? esc_html__( 'Attachments', 'rank-math' ) : $object->label, 'icon' => isset( $icons[ $object->name ] ) ? $icons[ $object->name ] : $icons['default'], /* translators: %1$s: thing, %2$s: Learn more link. */ 'desc' => sprintf( esc_html__( 'Change Sitemap settings of %1$s. %2$s.', 'rank-math' ), $thing, '' . esc_html__( 'Learn more', 'rank-math' ) . '' ), 'post_type' => $object->name, 'file' => $this->directory . '/settings/post-types.php', /* translators: Post Type Sitemap Url */ 'after_row' => $this->get_notice_start() . sprintf( esc_html__( 'Sitemap URL: %s', 'rank-math' ), '' . $sitemap_url . '' ) . $notice_end, ]; if ( 'attachment' === $post_type ) { $tabs[ 'sitemap-post-type-' . $object->name ]['after_row'] = $this->get_notice_start() . esc_html__( 'Please note that this will add the attachment page URLs to the sitemap, not direct image URLs.', 'rank-math' ) . $notice_end; $tabs[ 'sitemap-post-type-' . $object->name ]['classes'] = 'rank-math-advanced-option'; } } return $tabs; } /** * Add taxonomy tabs in the Sitemap Settings options panel. * * @param array $tabs Hold tabs for the options panel. * * @return array */ public function taxonomy_settings( $tabs ) { $icons = Helper::choices_taxonomy_icons(); // Taxonomy label seprator. $tabs['t_types'] = [ 'title' => esc_html__( 'Taxonomies:', 'rank-math' ), 'type' => 'seprator', ]; foreach ( Helper::get_accessible_taxonomies() as $taxonomy ) { if ( 'post_format' === $taxonomy->name ) { continue; } $hash_links = [ 'category' => '#categories', 'post_tag' => '#tags', 'product_cat' => '#product-categories', 'product_tag' => '#product-tags', ]; $sitemap_url = Router::get_base_url( $taxonomy->name . '-sitemap.xml' ); $notice_end = '

'; $taxonomy_name = strtolower( $taxonomy->name ); $url = isset( $hash_links[ $taxonomy_name ] ) ? KB::get( 'configure-sitemaps', 'Options Panel Sitemap ' . $taxonomy->labels->name . ' Tab' ) . $hash_links[ $taxonomy_name ] : KB::get( 'configure-sitemaps' ); switch ( $taxonomy->name ) { case 'product_cat': case 'product_tag': /* translators: Taxonomy singular label */ $thing = sprintf( __( 'your product %s pages', 'rank-math' ), strtolower( $taxonomy->labels->singular_name ) ); break; default: /* translators: Taxonomy singular label */ $thing = sprintf( __( '%s archives', 'rank-math' ), strtolower( $taxonomy->labels->singular_name ) ); $name = strtolower( $taxonomy->labels->name ); } $tabs[ 'sitemap-taxonomy-' . $taxonomy->name ] = [ 'icon' => isset( $icons[ $taxonomy->name ] ) ? $icons[ $taxonomy->name ] : $icons['default'], 'title' => $taxonomy->label, /* translators: %1$s: thing, %2$s: Learn more link. */ 'desc' => sprintf( esc_html__( 'Change Sitemap settings of %1$s. %2$s.', 'rank-math' ), $thing, '' . esc_html__( 'Learn more', 'rank-math' ) . '' ), 'taxonomy' => $taxonomy->name, 'file' => $this->directory . '/settings/taxonomies.php', /* translators: Taxonomy Sitemap Url */ 'after_row' => $this->get_notice_start() . sprintf( esc_html__( 'Sitemap URL: %s', 'rank-math' ), '' . $sitemap_url . '' ) . $notice_end, ]; } return $tabs; } /** * Adds new "exclude from sitemap" checkbox to the media popup in the post editor. * * @param array $form_fields Default form fields. * @param object $post Current post. * * @return array New form fields */ public function media_popup_fields( $form_fields, $post ) { $exclude = get_post_meta( $post->ID, 'rank_math_exclude_sitemap', true ); $checkbox = ''; $form_fields['rank_math_exclude_sitemap'] = [ 'tr' => "\t\t$checkbox\n" ]; return $form_fields; } /** * Saves new "exclude from sitemap" field as post meta for the attachment. * * @param array $post Attachment ID. * @param array $attachment Attachment data. * * @return array Post */ public function media_popup_fields_save( $post, $attachment ) { if ( isset( $attachment['rank_math_media_exclude_sitemap'] ) ) { update_post_meta( $post['ID'], 'rank_math_exclude_sitemap', true ); } else { delete_post_meta( $post['ID'], 'rank_math_exclude_sitemap' ); } Cache_Watcher::invalidate_post( $post['ID'] ); return $post; } /** * Adds the "data-sitemapexclude" HTML attribute to the img tag in the post * editor when necessary. * * @param string $html Original img HTML tag. * @param int $attachment_id Attachment ID. * * @return string New img HTML tag. */ public function media_popup_html( $html, $attachment_id ) { $post = get_post( $attachment_id ); if ( Str::starts_with( 'image', $post->post_mime_type ) && get_post_meta( $attachment_id, 'rank_math_exclude_sitemap', true ) ) { $html = str_replace( ' class="', ' data-sitemapexclude="true" class="', $html ); } return $html; } /** * Remove Sitemap nginx notice. * * @since 1.0.73 */ public function remove_nginx_notice() { check_ajax_referer( 'rank-math-ajax-nonce', 'security' ); $this->has_cap_ajax( 'sitemap' ); update_option( 'rank_math_remove_nginx_notice', true, false ); $this->success(); } /** * Get opening tags for the notice HTML. * * @return string */ private function get_notice_start() { return '

'; } /** * Get nginx notice. * * @since 1.0.41 * * @return string */ private function get_nginx_notice() { if ( 'rank-math-options-sitemap' !== Param::get( 'page' ) || empty( Param::server( 'SERVER_SOFTWARE' ) ) || get_option( 'rank_math_remove_nginx_notice' ) ) { return ''; } $server_software = explode( '/', Param::server( 'SERVER_SOFTWARE' ) ); if ( ! in_array( 'nginx', array_map( 'strtolower', $server_software ), true ) ) { return ''; } $sitemap_base = Router::get_sitemap_base() ? Router::get_sitemap_base() : ''; $message = sprintf( /* Translators: the placeholder is for the sitemap base url. */ __( 'Since you are using an NGINX server, you may need to add the following code to your %s if your Sitemap pages are not loading. If you are unsure how to do it, please contact your hosting provider.', 'rank-math' ), '' . __( 'configuration file', 'rank-math' ) . '' ); return '

' . '

' . $message . ' ' . __( 'Click here to see the code.', 'rank-math' ) . '' . __( 'Hide', 'rank-math' ) . ' ' . __( 'I already added', 'rank-math' ) . ' 

 # START Nginx Rewrites for Rank Math Sitemaps
 rewrite ^/' . $sitemap_base . Sitemap::get_sitemap_index_slug() . '\\.xml$ /index.php?sitemap=1 last;
 rewrite ^/' . $sitemap_base . '([^/]+?)-sitemap([0-9]+)?.xml$ /index.php?sitemap=$1&sitemap_n=$2 last;
 # END Nginx Rewrites for Rank Math Sitemaps
'; } /** * Add some inline JS for the sitemap settings admin page. */ public function admin_scripts() { if ( 'rank-math-options-sitemap' !== Param::get( 'page' ) ) { return; } ?>