laravel sitemap
7.3.0
Este paquete puede generar un mapa del sitio sin que usted tenga que agregarle direcciones URL manualmente. Esto funciona rastreando todo su sitio.
use Spatie Sitemap SitemapGenerator ;
SitemapGenerator:: create ( ' https://example.com ' )-> writeToFile ( $ path );También puedes crear tu mapa del sitio manualmente:
use Carbon Carbon ;
use Spatie Sitemap Sitemap ;
use Spatie Sitemap Tags Url ;
Sitemap:: create ()
-> add (Url:: create ( ' /home ' )
-> setLastModificationDate (Carbon:: yesterday ())
-> setChangeFrequency (Url:: CHANGE_FREQUENCY_YEARLY )
-> setPriority ( 0.1 ))
-> add (...)
-> writeToFile ( $ path );O puede tener lo mejor de ambos mundos generando un mapa del sitio y luego agregando más enlaces:
SitemapGenerator:: create ( ' https://example.com ' )
-> getSitemap ()
-> add (Url:: create ( ' /extra-page ' )
-> setLastModificationDate (Carbon:: yesterday ())
-> setChangeFrequency (Url:: CHANGE_FREQUENCY_YEARLY )
-> setPriority ( 0.1 ))
-> add (...)
-> writeToFile ( $ path );También puedes controlar la profundidad máxima del mapa del sitio:
SitemapGenerator:: create ( ' https://example.com ' )
-> configureCrawler ( function ( Crawler $ crawler ) {
$ crawler -> setMaximumDepth ( 3 );
})
-> writeToFile ( $ path );El generador tiene la capacidad de ejecutar JavaScript en cada página, por lo que también se rastrearán los enlaces inyectados en el dom mediante JavaScript.
También puede utilizar uno de los discos de su sistema de archivos disponibles para escribir el mapa del sitio.
SitemapGenerator:: create ( ' https://example.com ' )-> getSitemap ()-> writeToDisk ( ' public ' , ' sitemap.xml ' ); Es posible que deba configurar la visibilidad del archivo en uno de sus mapas de sitio. Por ejemplo, si está escribiendo un mapa del sitio para S3 que desea que esté disponible públicamente. Puede establecer el tercer parámetro en true para hacerlo público. Nota: Esto sólo se puede utilizar en el método ->writeToDisk() .
SitemapGenerator:: create ( ' https://example.com ' )-> getSitemap ()-> writeToDisk ( ' public ' , ' sitemap.xml ' , true ); También puede agregar sus modelos directamente implementando la interfaz SpatieSitemapContractsSitemapable .
use Spatie Sitemap Contracts Sitemapable ;
use Spatie Sitemap Tags Url ;
class Post extends Model implements Sitemapable
{
public function toSitemapTag (): Url | string | array
{
// Simple return :
return route ( ' blog.post.show ' , $ this );
// Return with fine - grained control :
return Url:: create ( route ( ' blog.post.show ' , $ this ))
-> setLastModificationDate (Carbon:: create ( $ this -> updated_at ))
-> setChangeFrequency (Url:: CHANGE_FREQUENCY_YEARLY )
-> setPriority ( 0.1 );
}
}Ahora puedes agregar un modelo de publicación única al mapa del sitio o incluso una colección completa.
use Spatie Sitemap Sitemap ;
Sitemap:: create ()
-> add ( $ post )
-> add (Post:: all ());De esta manera puedes agregar todas tus páginas súper rápido sin la necesidad de rastrearlas todas.
Invertimos muchos recursos en la creación de los mejores paquetes de código abierto. Puedes apoyarnos comprando uno de nuestros productos pagos.
Agradecemos mucho que nos envíe una postal desde su ciudad natal, mencionando cuál de nuestros paquetes está utilizando. Encontrarás nuestra dirección en nuestra página de contacto. Publicamos todas las postales recibidas en nuestro muro virtual de postales.
Primero, instale el paquete a través del compositor:
composer require spatie/laravel-sitemapEl paquete se registrará automáticamente.
Si desea actualizar su mapa del sitio de forma automática y frecuente, debe realizar algunos pasos adicionales.
Puede anular las opciones predeterminadas del rastreador. Primero publique la configuración:
php artisan vendor:publish --provider= " SpatieSitemapSitemapServiceProvider " --tag=sitemap-config Esto copiará la configuración predeterminada a config/sitemap.php donde podrá editarla.
use GuzzleHttp RequestOptions ;
use Spatie Sitemap Crawler Profile ;
return [
/ *
* These options will be passed to GuzzleHttp Client when it is created .
* For in - depth information on all options see the Guzzle docs :
*
* http : // docs . guzzlephp . org / en / stable / request - options . html
* /
' guzzle_options ' => [
/ *
* Whether or not cookies are used in a request .
* /
RequestOptions:: COOKIES => true ,
/ *
* The number of seconds to wait while trying to connect to a server .
* Use 0 to wait indefinitely .
* /
RequestOptions:: CONNECT_TIMEOUT => 10 ,
/ *
* The timeout of the request in seconds . Use 0 to wait indefinitely .
* /
RequestOptions:: TIMEOUT => 10 ,
/ *
* Describes the redirect behavior of a request .
* /
RequestOptions:: ALLOW_REDIRECTS => false ,
],
/ *
* The sitemap generator can execute JavaScript on each page so it will
* discover links that are generated by your JS scripts . This feature
* is powered by headless Chrome .
* /
' execute_javascript ' => false ,
/ *
* The package will make an educated guess as to where Google Chrome is installed .
* You can also manually pass it ' s location here .
* /
' chrome_binary_path ' => '' ,
/ *
* The sitemap generator uses a CrawlProfile implementation to determine
* which urls should be crawled for the sitemap .
* /
' crawl_profile ' => Profile::class,
]; La forma más sencilla es rastrear el dominio determinado y generar un mapa del sitio con todos los enlaces encontrados. El destino del mapa del sitio debe especificarse mediante $path .
SitemapGenerator:: create ( ' https://example.com ' )-> writeToFile ( $ path );El mapa del sitio generado será similar a este:
<? xml version = " 1.0 " encoding = " UTF-8 " ?>
< urlset xmlns = " http://www.sitemaps.org/schemas/sitemap/0.9 " >
< url >
< loc >https://example.com</ loc >
< lastmod >2016-01-01T00:00:00+00:00</ lastmod >
< changefreq >daily</ changefreq >
< priority >0.8</ priority >
</ url >
< url >
< loc >https://example.com/page</ loc >
< lastmod >2016-01-01T00:00:00+00:00</ lastmod >
< changefreq >daily</ changefreq >
< priority >0.8</ priority >
</ url >
...
</ urlset > Puede crear un perfil de rastreo personalizado implementando la interfaz SpatieCrawlerCrawlProfilesCrawlProfile y personalizando el método shouldCrawl() para tener control total sobre qué URL/dominio/subdominio se debe rastrear:
use Spatie Crawler CrawlProfiles CrawlProfile ;
use Psr Http Message UriInterface ;
class CustomCrawlProfile extends CrawlProfile
{
public function shouldCrawl ( UriInterface $ url ): bool
{
if ( $ url -> getHost () !== ' localhost ' ) {
return false ;
}
return $ url -> getPath () === ' / ' ;
}
} y registre su CustomCrawlProfile::class en config/sitemap.php .
return [
...
/ *
* The sitemap generator uses a CrawlProfile implementation to determine
* which urls should be crawled for the sitemap .
* /
' crawl_profile ' => CustomCrawlProfile:: class ,
]; Para cambiar lastmod , changefreq y priority de la página de contacto:
use Carbon Carbon ;
use Spatie Sitemap SitemapGenerator ;
use Spatie Sitemap Tags Url ;
SitemapGenerator:: create ( ' https://example.com ' )
-> hasCrawled ( function ( Url $ url ) {
if ( $ url -> segment ( 1 ) === ' contact ' ) {
$ url -> setPriority ( 0.9 )
-> setLastModificationDate (Carbon:: create ( ' 2016 ' , ' 1 ' , ' 1 ' ));
}
return $ url ;
})
-> writeToFile ( $ sitemapPath ); Si no desea que aparezca un enlace rastreado en el mapa del sitio, simplemente no lo devuelva en el elemento invocable al que pasa hasCrawled .
use Spatie Sitemap SitemapGenerator ;
use Spatie Sitemap Tags Url ;
SitemapGenerator:: create ( ' https://example.com ' )
-> hasCrawled ( function ( Url $ url ) {
if ( $ url -> segment ( 1 ) === ' contact ' ) {
return ;
}
return $ url ;
})
-> writeToFile ( $ sitemapPath ); También puede indicarle al rastreador subyacente que no rastree algunas páginas pasando un callable a shouldCrawl .
Nota: shouldCrawl solo funcionará con el Profile de rastreo predeterminado o perfiles de rastreo personalizados que implementen un método shouldCrawlCallback .
use Spatie Sitemap SitemapGenerator ;
use Psr Http Message UriInterface ;
SitemapGenerator:: create ( ' https://example.com ' )
-> shouldCrawl ( function ( UriInterface $ url ) {
// All pages will be crawled , except the contact page .
// Links present on the contact page won ' t be added to the
// sitemap unless they are present on a crawlable page .
return strpos ( $ url -> getPath (), ' /contact ' ) === false ;
})
-> writeToFile ( $ sitemapPath );El rastreador en sí se puede configurar para que haga algunas cosas diferentes.
Puede configurar el rastreador utilizado por el generador de mapas del sitio, por ejemplo: para ignorar las comprobaciones de los robots; así.
SitemapGenerator:: create ( ' http://localhost:4020 ' )
-> configureCrawler ( function ( Crawler $ crawler ) {
$ crawler -> ignoreRobots ();
})
-> writeToFile ( $ file ); Puede limitar la cantidad de páginas rastreadas llamando a setMaximumCrawlCount
use Spatie Sitemap SitemapGenerator ;
SitemapGenerator:: create ( ' https://example.com ' )
-> setMaximumCrawlCount ( 500 ) // only the 500 first pages will be crawled
. . . El generador de mapas del sitio puede ejecutar JavaScript en cada página para descubrir enlaces generados por sus scripts JS. Puede habilitar esta función configurando execute_javascript en el archivo de configuración en true .
Debajo del capó, Chrome sin cabeza se utiliza para ejecutar JavaScript. A continuación se ofrecen algunos consejos sobre cómo instalarlo en su sistema.
El paquete hará una suposición fundamentada sobre dónde está instalado Chrome en su sistema. También puedes pasar manualmente la ubicación del binario de Chrome para executeJavaScript() .
Puede agregar enlaces manualmente a un mapa del sitio:
use Spatie Sitemap SitemapGenerator ;
use Spatie Sitemap Tags Url ;
SitemapGenerator:: create ( ' https://example.com ' )
-> getSitemap ()
// here we add one extra link , but you can add as many as you ' d like
-> add (Url:: create ( ' /extra-page ' )-> setPriority ( 0.5 ))
-> writeToFile ( $ sitemapPath );Los sitios multilingües pueden tener varias versiones alternativas de la misma página (una por idioma). Según el ejemplo anterior, agregar una alternativa se puede hacer de la siguiente manera:
use Spatie Sitemap SitemapGenerator ;
use Spatie Sitemap Tags Url ;
SitemapGenerator:: create ( ' https://example.com ' )
-> getSitemap ()
// here we add one extra link , but you can add as many as you ' d like
-> add (Url:: create ( ' /extra-page ' )-> setPriority ( 0.5 )-> addAlternate ( ' /extra-pagina ' , ' nl ' ))
-> writeToFile ( $ sitemapPath ); Tenga en cuenta la función addAlternate que toma una URL alternativa y la configuración regional a la que pertenece.
Las URL también pueden tener imágenes. Consulte también https://developers.google.com/search/docs/advanced/sitemaps/image-sitemaps
use Spatie Sitemap Sitemap ;
use Spatie Sitemap Tags Url ;
Sitemap:: create ()
// here we add an image to a URL
-> add (Url:: create ( ' https://example.com ' )-> addImage ( ' https://example.com/images/home.jpg ' , ' Home page image ' ))
-> writeToFile ( $ sitemapPath );Además de las imágenes, los vídeos se pueden empaquetar con etiquetas URL. Consulte https://developers.google.com/search/docs/crawling-indexing/sitemaps/video-sitemaps
Puede establecer los atributos requeridos de esta manera:
use Spatie Sitemap Sitemap ;
use Spatie Sitemap Tags Url ;
Sitemap:: create ()
-> add (
Url:: create ( ' https://example.com ' )
-> addVideo ( ' https://example.com/images/thumbnail.jpg ' , ' Video title ' , ' Video Description ' , ' https://example.com/videos/source.mp4 ' , ' https://example.com/video/123 ' )
)
-> writeToFile ( $ sitemapPath ); Si desea pasar parámetros opcionales como family_friendly , live o platform :
use Spatie Sitemap Sitemap ;
use Spatie Sitemap Tags Url ;
use Spatie Sitemap Tags Video ;
$ options = [ ' family_friendly ' => Video:: OPTION_YES , ' live ' => Video:: OPTION_NO ];
$ allowOptions = [ ' platform ' => Video:: OPTION_PLATFORM_MOBILE ];
$ denyOptions = [ ' restriction ' => ' CA ' ];
Sitemap:: create ()
-> add (
Url:: create ( ' https://example.com ' )
-> addVideo ( ' https://example.com/images/thumbnail.jpg ' , ' Video title ' , ' Video Description ' , ' https://example.com/videos/source.mp4 ' , ' https://example.com/video/123 ' , $ options , $ allowOptions , $ denyOptions )
)
-> writeToFile ( $ sitemapPath );También puedes crear un mapa del sitio completamente manual:
use Carbon Carbon ;
Sitemap:: create ()
-> add ( ' /page1 ' )
-> add ( ' /page2 ' )
-> add (Url:: create ( ' /page3 ' )-> setLastModificationDate (Carbon:: create ( ' 2016 ' , ' 1 ' , ' 1 ' )))
-> writeToFile ( $ sitemapPath );Puede crear un índice de mapa del sitio:
use Spatie Sitemap SitemapIndex ;
SitemapIndex:: create ()
-> add ( ' /pages_sitemap.xml ' )
-> add ( ' /posts_sitemap.xml ' )
-> writeToFile ( $ sitemapIndexPath ); Puede pasar un objeto SpatieSitemapTagsSitemap para establecer manualmente la propiedad lastModificationDate .
use Spatie Sitemap SitemapIndex ;
use Spatie Sitemap Tags Sitemap ;
SitemapIndex:: create ()
-> add ( ' /pages_sitemap.xml ' )
-> add (Sitemap:: create ( ' /posts_sitemap.xml ' )
-> setLastModificationDate (Carbon:: yesterday ()))
-> writeToFile ( $ sitemapIndexPath );El índice del mapa del sitio generado será similar a este:
<? xml version = " 1.0 " encoding = " UTF-8 " ?>
< sitemapindex xmlns = " http://www.sitemaps.org/schemas/sitemap/0.9 " >
< sitemap >
< loc >http://www.example.com/pages_sitemap.xml</ loc >
< lastmod >2016-01-01T00:00:00+00:00</ lastmod >
</ sitemap >
< sitemap >
< loc >http://www.example.com/posts_sitemap.xml</ loc >
< lastmod >2015-12-31T00:00:00+00:00</ lastmod >
</ sitemap >
</ sitemapindex > Puede llamar al método maxTagsPerSitemap para generar un mapa del sitio que solo contenga la cantidad dada de etiquetas.
use Spatie Sitemap SitemapGenerator ;
SitemapGenerator:: create ( ' https://example.com ' )
-> maxTagsPerSitemap ( 20000 )
-> writeToFile ( public_path ( ' sitemap.xml ' ));Probablemente su sitio se actualizará de vez en cuando. Para permitir que su mapa del sitio refleje estos cambios, puede ejecutar el generador periódicamente. La forma más sencilla de hacerlo es utilizar las capacidades de programación predeterminadas de Laravel.
Podrías configurar un comando artesanal muy parecido a este:
namespace App Console Commands ;
use Illuminate Console Command ;
use Spatie Sitemap SitemapGenerator ;
class GenerateSitemap extends Command
{
/ * *
* The console command name .
*
* @ var string
* /
protected $ signature = ' sitemap:generate ' ;
/ * *
* The console command description .
*
* @ var string
* /
protected $ description = ' Generate the sitemap. ' ;
/ * *
* Execute the console command .
*
* @ return mixed
* /
public function handle ()
{
// modify this to your own needs
SitemapGenerator:: create ( config ( ' app.url ' ))
-> writeToFile ( public_path ( ' sitemap.xml ' ));
}
}Luego, ese comando debería programarse en el kernel de la consola.
// app / Console / Kernel . php
protected function schedule ( Schedule $ schedule )
{
. . .
$ schedule -> command ( ' sitemap:generate ' )-> daily ();
. . .
}Consulte CHANGELOG para obtener más información sobre los cambios recientes.
Primero inicie el servidor de prueba en una sesión de terminal separada:
cd tests/server
./start_server.shCon el servidor en ejecución puedes ejecutar las pruebas:
$ composer test Consulte CONTRIBUCIÓN para obtener más detalles.
Si encuentra un error relacionado con la seguridad, envíe un correo electrónico a [email protected] en lugar de utilizar el rastreador de problemas.
Spatie es una agencia de diseño web con sede en Amberes, Bélgica. Encontrará una descripción general de todos nuestros proyectos de código abierto en nuestro sitio web.
¿Su negocio depende de nuestros aportes? Comuníquese con nosotros y apóyenos en Patreon. Todos los compromisos se dedicarán a asignar mano de obra para mantenimiento y cosas nuevas e increíbles.
La Licencia MIT (MIT). Consulte el archivo de licencia para obtener más información.
