Passing parameters to a Bash function

by

There are two typical ways of declaring a function. I prefer the second approach.

function function_name {
   command...
}

or

function_name () {
   command...
}

To call a function with arguments:

function_name "$arg1" "$arg2"

The function refers to passed arguments by their position (not by name), that is $1, $2, and so forth. $0 is the name of the script itself.

Example:

function_name () {
   echo "Parameter #1 is $1"
}

Also, you need to call your function after it is declared.

#!/usr/bin/env sh

foo 1  # this will fail because foo has not been declared yet.

foo() {
    echo "Parameter #1 is $1"
}

foo 2 # this will work.

Output:

./myScript.sh: line 2: foo: command not found
Parameter #1 is 2

Reference: Advanced Bash-Scripting Guide.

Related Contents:

  1. Difference between terms: “option”, “argument”, and “parameter”?
  2. Here document as an argument to bash function
  3. Set a default parameter value for a JavaScript function
  4. How do I parse command line arguments in Bash?
  5. How to pass all arguments passed to my bash script to a function of mine? [duplicate]
  6. “Parameter” vs “Argument” [duplicate]
  7. How to write a bash script that takes optional input arguments?
  8. Difference between return and exit in Bash functions
  9. Return value in a Bash function
  10. Can bash show a function’s definition?
  11. What is $@ in Bash? [duplicate]
  12. if arguments is equal to this string, define a variable like this string
  13. How do I list the functions defined in my shell? [duplicate]
  14. find: missing argument to -exec
  15. Meaning of “[: too many arguments” error from if [] (square brackets)
  16. Determine if a function exists in bash
  17. Passing a string with spaces as a function argument in Bash
  18. How do I find the number of arguments passed to a Bash script?
  19. How to determine function name from inside a function
  20. Arguments or parameters? [duplicate]
  21. Default function arguments in Rust
  22. How to exit a function in bash
  23. What is the simplest way to remove a trailing slash from each parameter?
  24. How can I assign the output of a function to a variable using bash?
  25. Forward function declarations in a Bash or a Shell script?
  26. Bash: pass a function as parameter
  27. How to effectively abort the execution of a Bash script from a function
  28. Execute a shell function with timeout
  29. Is mixing getopts with positional parameters possible?
  30. How to show zsh function definition (like bash “type myfunc”)?
  31. What is the proper way to test a Bash function’s return value?
  32. How to get the nth positional argument in bash?
  33. How do you call a function defined in .bashrc from the shell? [duplicate]
  34. Extract parameters before last parameter in “$@”
  35. Optional args in MATLAB functions
  36. Using command line argument range in bash for loop prints brackets containing the arguments
  37. Using getopts inside a Bash function
  38. Pass bash script parameters to sub-process unchanged
  39. How to define a function on one line
  40. Is the behavior behind the Shellshock vulnerability in Bash documented or at all intentional?
  41. Passing a function with arguments as an argument?
  42. Functions in Makefile
  43. bash prompt and echoing colors inside a function
  44. Recursive function in bash
  45. How can I print each command before executing? [duplicate]
  46. Open and write data to text file using Bash?
  47. How to delete files older than X hours
  48. How to send control+c from a bash script?
  49. What does “|&” mean in Bash?
  50. BASH script: Downloading consecutive numbered files with wget

Leave a Comment