Difference between revisions of "Search Engine Friendly URLs"
From Joomla! Documentation
m (→What do the numbers in the URL mean?: Spelling corrections) |
(Spelling and punctuation changes.) |
||
| Line 24: | Line 24: | ||
=== There is no “index.php” in the URL anymore. Can I delete the file now? === | === There is no “index.php” in the URL anymore. Can I delete the file now? === | ||
| − | |||
No! The URL may doesn't contain the "index.php" anymore, but internally the mod_rewrite will only redirect to the original path without showing it to you. | No! The URL may doesn't contain the "index.php" anymore, but internally the mod_rewrite will only redirect to the original path without showing it to you. | ||
=== What is the Alias value? And how does it get created? === | === What is the Alias value? And how does it get created? === | ||
| − | + | Alias is listed beneath the Title field in Articles, Categories, Sections and Menu Items. Joomla! can automatically create the [[alias]] for you. An automatic alias begins with the title. All upper case letters are changed to lower case. Spaces and special characters not allowed in a URL; they are changed to dashes. | |
| − | Alias is listed beneath the Title field in Articles, Categories, Sections and Menu Items. Joomla! | ||
=== I want to specify my own value for Alias. === | === I want to specify my own value for Alias. === | ||
| − | + | If you do not like the alias provided by Joomla!, you can enter a value of your choosing into that field. Many believe using good keywords in your URL helps search engine optimization. You can do so by including those keywords in your title, and allowing Joomla! to create the alias, or by creating the alias yourself. | |
| − | If you do not like the | ||
=== How is Alias used in a URL? === | === How is Alias used in a URL? === | ||
| + | For a menu item, Joomla! uses the alias as the URL plug. Assume that you use the first two SEF URL options and you create a menu item called Products. Your URL would be example.com/products. | ||
| − | + | Joomla! also uses the primary key values of data within the URL to help the router navigate to the correct page. Continuing with the previous example, if your products menu item was for an Article/Category Blog, the link for the Article Title and/or Read More link would have three parts: | |
| − | |||
| − | Joomla! also uses the primary key values of data within the URL to help the router navigate to the correct page. Continuing with the previous example, if your products menu item was for an | ||
| − | |||
| − | and/or Read More link would | ||
* The menu item URL - example.com/products; | * The menu item URL - example.com/products; | ||
| Line 49: | Line 43: | ||
* Plus, the primary key for the Article and the Article alias - 1-apple; | * Plus, the primary key for the Article and the Article alias - 1-apple; | ||
| − | + | The complete URL is: <code><nowiki>http://example.com/products/32-fruit/1-apple</nowiki></code> | |
=== How can I get rid of the numbers in the SEF URLs? === | === How can I get rid of the numbers in the SEF URLs? === | ||
| − | |||
The numbers in the SEF URL are needed by Joomla!'s router to know how to direct site traffic. Once the router logic stabilizes, simple third party system plugins can be developed to augment the router capabilities by allowing more choice. At that time, numbers will likely be removed from the URL. | The numbers in the SEF URL are needed by Joomla!'s router to know how to direct site traffic. Once the router logic stabilizes, simple third party system plugins can be developed to augment the router capabilities by allowing more choice. At that time, numbers will likely be removed from the URL. | ||
== Technical Overview == | == Technical Overview == | ||
| − | |||
=== Joomla Routes === | === Joomla Routes === | ||
| + | Joomla routes are created by [[JRouter|the JRouter class]]. This class looks in the component root of the component specified in the "option" portion of the query string and includes the router.php file in that component's root directory. It then calls one of two functions: one for creating the SEF link and one for interpreting the SEF link. | ||
| − | + | The JRouter class is overridden by the Joomla CMS in /includes/router.php. In this file the build and parse functions are overridden to properly build and parse the URLs for the Joomla CMS. | |
| − | |||
| − | The JRouter class is overridden by the Joomla CMS in /includes/router.php. | ||
com_component/router.php | com_component/router.php | ||
| Line 78: | Line 69: | ||
=== The SEF Plugin === | === The SEF Plugin === | ||
| − | + | The Joomla System SEF plugin inherits JPlugin and overrides the onAfterRender() function. In this function the body of the response that will be sent to the browser is retrieved using JResponse::getBody(). The body of the response is then searched for links containing "/index.php..." and replaces them with a correct SEF url by calling JRoute::_(url). | |
| − | The Joomla System SEF plugin inherits JPlugin and overrides the onAfterRender() function. | ||
JRoute builds SEF URLs by instantiating a JRouter object and requesting that it build the correct link from the passed in URL. | JRoute builds SEF URLs by instantiating a JRouter object and requesting that it build the correct link from the passed in URL. | ||
=== Handling SEF URLs === | === Handling SEF URLs === | ||
| + | By default the SEF URLs are handled by the the JRouterSite object (from /includes/router.php) and is called by a call to JApplication::route() in index.php. This call is made on the $mainframe variable which is actually an instance of JSite (from /includes/application.php). | ||
| − | + | JApplication::route() has a non-destructive result on the $_GET array. That is, JApplication::route() sets variables in $_GET by calling JRequest::set() with the overwrite flag set to false. Thus if a variable name is returned from JRouter::route() that is already in $_GET, it will not put that value into $_GET. This allows for custom routing. | |
| − | |||
| − | JApplication::route() has a non-destructive result on the $_GET array. | ||
=== Custom Routing === | === Custom Routing === | ||
| − | + | Joomla allows you to create your own routing mechanism. In order to create this mechanism you must have a plugin that overrides the JPlugin::onAfterInitialise() function. This function then parses the URL and creates the needed variables in $_GET before the standard Joomla routing is done. | |
| − | Joomla allows you to create your own routing mechanism. | ||
[[Category:Search Engine Friendly URLs| ]] | [[Category:Search Engine Friendly URLs| ]] | ||
Revision as of 14:10, 28 November 2011
Human readable or search engine friendly URLs are URLs that make sense to both humans and search engines because they explain the path to the particular page they point to. Since version 1.5, Joomla! is capable of creating and parsing URLs in any format, including human readable URL's. This does not depend on URL rewriting executed by the web server, so it works even if Joomla! runs a server other than Apache with the mod_rewrite module. The process of creating and processing human readable URLs is called routing. Routing uses aliases that can be defined by the user.
A good example of routing is the URL to "Welcome to Joomla!" article in the sample data.
- Without human readable URLs turned on, the URL is
http://www.example.com/index.php?option=com_content&view=article&id=1:welcome-to-joomla&catid=1:latest-news&Itemid=50 - With human readable URLs on and mod_rewrite off, it's
http://www.example.com/index.php/the-news/1-latest-news/1-welcome-to-joomla - With both human readable URLs and mod_rewrite on, it's
http://www.example.com/the-news/1-latest-news/1-welcome-to-joomla
Human readable/search engine friendly URLs can be activated by turning on the Search Engine Friendly URLs option in the Global Configuration. This option is on by default since Joomla! 1.6. See Enabling Search Engine Friendly (SEF) URLs for more information.
Frequently Asked Questions[edit]
What do the numbers in the URL mean?[edit]
By comparing the old and the new URL we can see numbers in the old URL,
http://www.example.com/index.php?option=com_content&view=article&id=1:welcome-to-joomla&catid=1:latest-news&Itemid=50
but also in the new URL:
http://www.example.com/the-news/1-latest-news/1-welcome-to-joomla
These numbers are the parameters that are needed by Joomla! to get the internal URL and show the page you want to see. (In this case, the first numeral one is the ID of the category, the second numeral one is the ID of the article.)
There is no “index.php” in the URL anymore. Can I delete the file now?[edit]
No! The URL may doesn't contain the "index.php" anymore, but internally the mod_rewrite will only redirect to the original path without showing it to you.
What is the Alias value? And how does it get created?[edit]
Alias is listed beneath the Title field in Articles, Categories, Sections and Menu Items. Joomla! can automatically create the alias for you. An automatic alias begins with the title. All upper case letters are changed to lower case. Spaces and special characters not allowed in a URL; they are changed to dashes.
I want to specify my own value for Alias.[edit]
If you do not like the alias provided by Joomla!, you can enter a value of your choosing into that field. Many believe using good keywords in your URL helps search engine optimization. You can do so by including those keywords in your title, and allowing Joomla! to create the alias, or by creating the alias yourself.
How is Alias used in a URL?[edit]
For a menu item, Joomla! uses the alias as the URL plug. Assume that you use the first two SEF URL options and you create a menu item called Products. Your URL would be example.com/products.
Joomla! also uses the primary key values of data within the URL to help the router navigate to the correct page. Continuing with the previous example, if your products menu item was for an Article/Category Blog, the link for the Article Title and/or Read More link would have three parts:
- The menu item URL - example.com/products;
- Plus, the primary key for the Category and the Category alias - 32-fruit;
- Plus, the primary key for the Article and the Article alias - 1-apple;
The complete URL is: http://example.com/products/32-fruit/1-apple
How can I get rid of the numbers in the SEF URLs?[edit]
The numbers in the SEF URL are needed by Joomla!'s router to know how to direct site traffic. Once the router logic stabilizes, simple third party system plugins can be developed to augment the router capabilities by allowing more choice. At that time, numbers will likely be removed from the URL.
Technical Overview[edit]
Joomla Routes[edit]
Joomla routes are created by the JRouter class. This class looks in the component root of the component specified in the "option" portion of the query string and includes the router.php file in that component's root directory. It then calls one of two functions: one for creating the SEF link and one for interpreting the SEF link.
The JRouter class is overridden by the Joomla CMS in /includes/router.php. In this file the build and parse functions are overridden to properly build and parse the URLs for the Joomla CMS.
com_component/router.php
The router.php file should contain the following two functions:
- ContentBuildRoute - this builds the SEF url
- Parameters
- $query - this is a named array containing the querystring variables
- Returns: an array of segments where each segment is separated by a '/' when later combined to create the actual link (the items in the array should not contain '/' characters)
- Parameters
- ContentParseRoute - this interprets an SEF url
- Parameters
- $segments - this is an array that contains the segments of the url requested.
- Returns: a name => value array of the querystring variables that the link maps to
- Parameters
For more information on creating a router, see Supporting SEF URLs in your component.
The SEF Plugin[edit]
The Joomla System SEF plugin inherits JPlugin and overrides the onAfterRender() function. In this function the body of the response that will be sent to the browser is retrieved using JResponse::getBody(). The body of the response is then searched for links containing "/index.php..." and replaces them with a correct SEF url by calling JRoute::_(url).
JRoute builds SEF URLs by instantiating a JRouter object and requesting that it build the correct link from the passed in URL.
Handling SEF URLs[edit]
By default the SEF URLs are handled by the the JRouterSite object (from /includes/router.php) and is called by a call to JApplication::route() in index.php. This call is made on the $mainframe variable which is actually an instance of JSite (from /includes/application.php).
JApplication::route() has a non-destructive result on the $_GET array. That is, JApplication::route() sets variables in $_GET by calling JRequest::set() with the overwrite flag set to false. Thus if a variable name is returned from JRouter::route() that is already in $_GET, it will not put that value into $_GET. This allows for custom routing.
Custom Routing[edit]
Joomla allows you to create your own routing mechanism. In order to create this mechanism you must have a plugin that overrides the JPlugin::onAfterInitialise() function. This function then parses the URL and creates the needed variables in $_GET before the standard Joomla routing is done.