Skip to content

Commit 75400f5

Browse files
committed
Update docs, see WordPress#77
1 parent 497ae01 commit 75400f5

7 files changed

+31
-31
lines changed

docs/code-reference/acf-field-group-functions-file.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ acf_get_raw_field_groups
9292

9393
acf_filter_field_groups
9494

95-
* Returns a filtered aray of field groups based on the given $args.
95+
* Returns a filtered array of field groups based on the given $args.
9696
* @date 29/11/2013
9797
* @since ACF 5.0.0
9898
* @param array $field_groups An array of field groups.
@@ -259,7 +259,7 @@ acf_prepare_field_group_for_import
259259

260260
acf_import_field_group
261261

262-
* Imports a field group into the databse.
262+
* Imports a field group into the database.
263263
* @date 11/03/2014
264264
* @since ACF 5.0.0
265265
* @param array $field_group The field group array.

docs/code-reference/acf-helper-functions-file.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ acf_enable_filter
7474
* Enables a filter with the given name.
7575
* @date 14/7/16
7676
* @since ACF 5.4.0
77-
* @param string name The modifer name.
77+
* @param string $name The modifier name.
7878
* @return void
7979

8080
## `acf_disable_filter()`
@@ -84,7 +84,7 @@ acf_disable_filter
8484
* Disables a filter with the given name.
8585
* @date 14/7/16
8686
* @since ACF 5.4.0
87-
* @param string name The modifer name.
87+
* @param string $name The modifier name.
8888
* @return void
8989

9090
## `acf_is_filter_enabled()`
@@ -94,7 +94,7 @@ acf_is_filter_enabled
9494
* Returns the state of a filter for the given name.
9595
* @date 14/7/16
9696
* @since ACF 5.4.0
97-
* @param string name The modifer name.
97+
* @param string $name The modifier name.
9898
* @return array
9999

100100
## `acf_get_filters()`
@@ -113,7 +113,7 @@ acf_set_filters
113113
* Sets an array of filter states.
114114
* @date 14/7/16
115115
* @since ACF 5.4.0
116-
* @param array $filters An Array of modifers
116+
* @param array $filters An Array of modifiers.
117117
* @return array
118118

119119
## `acf_disable_filters()`
@@ -132,7 +132,7 @@ acf_enable_filters
132132
* Enables all or an array of specific filters and returns the previous state.
133133
* @date 14/7/16
134134
* @since ACF 5.4.0
135-
* @param array $filters An Array of modifers
135+
* @param array $filters An Array of modifiers.
136136
* @return array
137137

138138
## `acf_idval()`
@@ -221,7 +221,7 @@ Returns the length of a string that has been submitted via $_POST.
221221
1. Unslash the string because posted values will be slashed.
222222
2. Decode special characters because wp_kses() will normalize entities.
223223
3. Treat line-breaks as a single character instead of two.
224-
4. Use mb_strlen() to accomodate special characters.
224+
4. Use mb_strlen() to accommodate special characters.
225225

226226
* @date 04/06/2020
227227
* @since ACF 5.9.0

docs/code-reference/api/api-helpers-file.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ acf_get_posts
395395
_acf_query_remove_post_type
396396

397397
* This function will remove the 'wp_posts.post_type' WHERE clause completely
398-
When using 'post__in', this clause is unneccessary and slow.
398+
When using 'post__in', this clause is unnecessary and slow.
399399
* @since ACF 5.1.5
400400
* @param $sql (string)
401401
* @return $sql
@@ -494,8 +494,8 @@ acf_encode_choices
494494
acf_str_replace
495495

496496
* This function will replace an array of strings much like str_replace
497-
The difference is the extra logic to avoid replacing a string that has alread been replaced
498-
This is very useful for replacing date characters as they overlap with eachother
497+
The difference is the extra logic to avoid replacing a string that has already been replaced
498+
This is very useful for replacing date characters as they overlap with each other
499499
* @since ACF 5.3.8
500500
* @param $post_id (int)
501501
* @return $post_id (int)
@@ -504,7 +504,7 @@ This is very useful for replacing date characters as they overlap with eachother
504504

505505
acf_split_date_time
506506

507-
* This function will split a format string into seperate date and time
507+
* This function will split a format string into separate date and time
508508
* @since ACF 5.3.8
509509
* @param $date_time (string)
510510
* @return $formats (array)
@@ -513,7 +513,7 @@ acf_split_date_time
513513

514514
acf_convert_date_to_php
515515

516-
* This fucntion converts a date format string from JS to PHP
516+
* This function converts a date format string from JS to PHP
517517
* @since ACF 5.0.0
518518
* @param $date (string)
519519
* @return (string)
@@ -522,7 +522,7 @@ acf_convert_date_to_php
522522

523523
acf_convert_date_to_js
524524

525-
* This fucntion converts a date format string from PHP to JS
525+
* This function converts a date format string from PHP to JS
526526
* @since ACF 5.0.0
527527
* @param $date (string)
528528
* @return (string)
@@ -531,7 +531,7 @@ acf_convert_date_to_js
531531

532532
acf_convert_time_to_php
533533

534-
* This fucntion converts a time format string from JS to PHP
534+
* This function converts a time format string from JS to PHP
535535
* @since ACF 5.0.0
536536
* @param $time (string)
537537
* @return (string)
@@ -540,7 +540,7 @@ acf_convert_time_to_php
540540

541541
acf_convert_time_to_js
542542

543-
* This fucntion converts a date format string from PHP to JS
543+
* This function converts a date format string from PHP to JS
544544
* @since ACF 5.0.0
545545
* @param $time (string)
546546
* @return (string)
@@ -611,7 +611,7 @@ This function will walk through the $_FILES data and upload each found.
611611

612612
acf_upload_file
613613

614-
* This function will uploade a $_FILE
614+
* This function will upload a $_FILE
615615
* @since ACF 5.0.9
616616
* @param $uploaded_file (array) array found from $_FILE data
617617
* @return $id (int) new attachment ID
@@ -734,8 +734,8 @@ acf_translate
734734
* This function will translate a string using the new 'l10n_textdomain' setting
735735
Also works for arrays which is great for fields - select -> choices
736736
* @since ACF 5.3.2
737-
* @param $string (mixed) string or array containins strings to be translated
738-
* @return $string
737+
* @param mixed $string String or array containing strings to be translated.
738+
* @return mixed
739739

740740
## `acf_maybe_add_action()`
741741

@@ -769,7 +769,7 @@ Return an image tag for the provided attachment ID
769769

770770
acf_get_post_thumbnail
771771

772-
* This function will return a thumbail image url for a given post
772+
* This function will return a thumbnail image url for a given post
773773
* @since ACF 5.3.8
774774
* @param $post (obj)
775775
* @param $size (mixed)
@@ -787,7 +787,7 @@ acf_get_browser
787787

788788
acf_is_ajax
789789

790-
* This function will reutrn true if performing a wp ajax call
790+
* This function will return true if performing a wp ajax call
791791
* @since ACF 5.3.8
792792
* @param n/a
793793
* @return (boolean)
@@ -910,8 +910,8 @@ Useful to preserve numeric keys when performing array_multisort
910910

911911
## `acf_connect_attachment_to_post()`
912912

913-
This function will connect an attacment (image etc) to the post
914-
Used to connect attachements uploaded directly to media that have not been attaced to a post
913+
This function will connect an attachment (image etc) to the post
914+
Used to connect attachments uploaded directly to media that have not been attached to a post
915915

916916
* @since ACF 5.8.0 Added filter to prevent connection.
917917
* @since ACF 5.5.4
@@ -970,7 +970,7 @@ acf_convert_rules_to_groups
970970

971971
acf_register_ajax
972972

973-
* Regsiters an ajax callback.
973+
* Registers an ajax callback.
974974
* @since ACF 5.7.7
975975
* @param string $name The ajax action name.
976976
* @param array $callback The callback function or array.
@@ -991,7 +991,7 @@ Thanks to <https://stackoverflow.com/questions/31274782/convert-array-keys-from-
991991

992992
acf_array_camel_case
993993

994-
* Converts all aray keys to camelCase.
994+
* Converts all array keys to camelCase.
995995
* @since ACF 5.8.0
996996
* @param array $array The array to convert.
997997
* @return array

docs/code-reference/api/api-template-file.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## `get_field()`
44

55
This function will return a custom field value for a specific field name/key + post_id.
6-
There is a 3rd parameter to turn on/off formating. This means that an image field will not use
6+
There is a 3rd parameter to turn on/off formatting. This means that an image field will not use
77
its 'return option' to format the value but return only what was saved in the database
88

99
* @since ACF 3.6
@@ -317,7 +317,7 @@ This function will add a row of data to a field
317317

318318
## `create_field()`
319319

320-
Depreceated Functions
320+
Deprecated Functions
321321

322322
* These functions are outdated
323323
* @since ACF 1.0.0

docs/code-reference/fields-file.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Returns an array of localised field categories.
109109

110110
## `acf_get_grouped_field_types()`
111111

112-
Returns an multi-dimentional array of field types "name => label" grouped by category
112+
Returns an multi-dimensional array of field types "name => label" grouped by category
113113

114114
* @since ACF 5.0.0
115115
* @return array

docs/code-reference/upgrades-file.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
acf_has_upgrade
66

7-
* Returns true if this site has an upgrade avaialble.
7+
* Returns true if this site has an upgrade available.
88
* @date 24/8/18
99
* @since ACF 5.7.4
1010
* @return boolean

docs/code-reference/validation-file.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Add validation error.
88
* @type function
99
* @date 6/10/13
1010
* @since ACF 5.0.0
11-
* @param string $input name attribute of DOM elmenet.
11+
* @param string $input name attribute of DOM element.
1212
* @param string $message error message.
1313
* @return void
1414

@@ -31,7 +31,7 @@ Get the validation error.
3131
* @date 6/10/13
3232
* @since ACF 5.0.0
3333
* @since 6.4.1 Added the $input parameter, which is required in the get_error method.
34-
* @param string $input name attribute of DOM elmenet.
34+
* @param string $input name attribute of DOM element.
3535
* @return string|bool
3636

3737
## `acf_reset_validation_errors()`

0 commit comments

Comments
 (0)