function arg

You are here

7 bootstrap.inc arg($index = NULL, $path = NULL)
4.6 bootstrap.inc arg($index)
4.7 path.inc arg($index)
5 path.inc arg($index)
6 path.inc arg($index = NULL, $path = NULL)
8 bootstrap.inc arg($index = NULL, $path = NULL)

Return a component of the current Drupal path.

When viewing a page at the path "admin/content/types", for example, arg(0) would return "admin", arg(1) would return "content", and arg(2) would return "types".

Avoid use of this function where possible, as resulting code is hard to read. Instead, attempt to use named arguments in menu callback functions. See the explanation in menu.inc for how to construct callbacks that take arguments.

Parameters

$index: The index of the component, where each component is separated by a '/' (forward-slash), and where the first component has an index of 0 (zero).

$path: A path to break into components. Defaults to the path of the current page.

Return value

The component specified by $index, or NULL if the specified component was not found. If called without arguments, it returns an array containing all the components of the current path.

34 calls to arg()
aggregator_form_category_submit in modules/aggregator/aggregator.admin.inc
Process aggregator_form_category form submissions.
aggregator_form_feed_submit in modules/aggregator/aggregator.admin.inc
Process aggregator_form_feed form submissions.
aggregator_page_category in modules/aggregator/aggregator.pages.inc
Menu callback; displays all the items aggregated in a particular category.
aggregator_page_last in modules/aggregator/aggregator.pages.inc
Menu callback; displays the most recent items gathered from any feed.
aggregator_page_rss in modules/aggregator/aggregator.pages.inc
Menu callback; generate an RSS 0.92 feed of aggregator items or categories.

... See full list

File

includes/path.inc, line 162
Functions to handle paths in Drupal, including path aliasing.

Code

function arg($index = NULL, $path = NULL) {
  static $arguments;

  if (!isset($path)) {
    $path = $_GET['q'];
  }
  if (!isset($arguments[$path])) {
    $arguments[$path] = explode('/', $path);
  }
  if (!isset($index)) {
    return $arguments[$path];
  }
  if (isset($arguments[$path][$index])) {
    return $arguments[$path][$index];
  }
}

Comments

If you're using Path or Pathauto and configure node 123123 to have the path http://yoursite.com/publication/book/number/123123, the arg() function will still return the internal node path.

For example, even though your address bar shows http://yoursite.com/publication/book/number/123123
print arg(0); // prints 'node'
print arg(1); // prints '123123'

Because publication ,book ,number and all this words are alias path not really argument
the argument are o => node and 1=> 123123

I am showing a block view in my sidebar filtering the contents by taxonomy term. My node is at host.com/events/new-york/some-event ... How can I get my view to use "new-york" as an argument in this case?

("new-york" is inserted in the URL based on the taxonomy term of the node which has the content type "events")

Thanks

--

Edit: Managed to get it working using the code below:

if (arg(0) == 'node' && is_numeric(arg(1))) {
    $node = node_load(arg(1));

if (count($node->taxonomy) > 0)  {
  foreach ($node->taxonomy as $term) {
$term = $term->name;
  }
}

$term = strtolower($term); // for some reason needed in my case
}

else {
$term = arg(1);
$term = str_replace('-', ' ', $term); // for some reason needed in my case
}

return $term;

@mtz,

I think drupal_get_path_alias() may be your friend.

Possibly helpful reference on this topic is the discussion at and near this comment:

http://drupal.org/node/246742#comment-971334

I am trying to use the arg function to get the node id, however, it returns me the name of the function in which I am using the arg().

<?php
function firstName_lastName () {

drupal_set_message(arg(1), 'check', FALSE);

}

?>

This returns-> 'lastName'

Any ideas why it is not returning the node id?

Thanks

...just a guess, but does your path look something like:

http://www.your.site.com/drupal/lastName/1 ...?

Because, from your question, it seems like you're just grabbing the wrong part of the path.

Did you try:

function firstName_lastName () {

drupal_set_message(arg(2), 'check', FALSE);// note the "2" in arg()

}

Hi, what about this kind of argument "node/594#comment-60" . How can I read the #comment-60 from the url?

The part of the URL you're referring to is called the 'hash' or 'fragment', and I'm afraid you won't be able to access it from the server-side at all, as most browsers do not send this to the server.

You can, however, use JavaScript to get it on the client-side, using the value of location.hash, which returns everything after (and including) the # symbol in the requested URL.

<?php
$arg
= arg();
if (isset(
$arg[0]) && isset($arg[1]) && $arg[0] == 'node' && is_numeric($arg[1])) {
 
// Do stuff with the node id: $arg[1]
}
?>

You saved my life. I was stuck with isset(arg(0)).

These values are cached already for a single page load so using thing multiple times will not cause huge performance problems.

Thus, site.com/cool-page and site.com/Cool-Page will return a different result for arg(0). Make sure you strtolower(arg(0)) if this is not desired (probably should get this in core, as I think most people dont desire that).