diff --git a/reference/strings/functions/str-word-count.xml b/reference/strings/functions/str-word-count.xml index de3c426d6a..013364a11b 100644 --- a/reference/strings/functions/str-word-count.xml +++ b/reference/strings/functions/str-word-count.xml @@ -1,5 +1,5 @@ - + str_word_count @@ -7,12 +7,13 @@ Return information about words used in a string - - Description + + &reftitle.description; mixedstr_word_count stringstring intformat + stringcharlist Counts the number of words inside string. @@ -22,83 +23,172 @@ value will be an array, content of which is dependent on the format. The possible value for the format and the resultant outputs are listed below. - - - - 1 - returns an array containing all the words found inside the - string. - - - - - 2 - returns an associative array, where the key is the numeric - position of the word inside the string and - the value is the actual word itself. - - - For the purpose of this function, 'word' is defined as a locale dependent string containing alphabetic characters, which also may contain, but not start with "'" and "-" characters. + + + + &reftitle.parameters; + + + + string + + + The string + + + + + format + + + Specify the return value of this function. The current supported values + are: + + + + 0 - returns the number of words found + + + + + 1 - returns an array containing all the words found inside the + string + + + + + 2 - returns an associative array, where the key is the numeric + position of the word inside the string and + the value is the actual word itself + + + + + + + + charlist + + + A list of additional characters which will be considered as 'word' + + + + + + + + + &reftitle.returnvalues; + + Returns an array or an integer, depending on the + format chosen. + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 5.1.0 + + Added the charlist parameter + + + + + + + + + + &reftitle.examples; - Example uses for <function>str_word_count</function> + A <function>str_word_count</function> example ]]> &example.outputs; Hello - [1] => friend - [2] => you're - [3] => looking - [4] => good - [5] => today + [1] => fri + [2] => nd + [3] => you're + [4] => looking + [5] => good + [6] => today ) Array ( [0] => Hello - [6] => friend + [6] => fri + [10] => nd [14] => you're [29] => looking [46] => good [51] => today ) -6 +Array +( + [0] => Hello + [1] => fri3nd + [2] => you're + [3] => looking + [4] => good + [5] => today +) +7 ]]> + + + + &reftitle.seealso; - See also explode, - preg_split, - split, - count_chars, and - substr_count. + + explode + preg_split + split + count_chars + substr_count +