From 396c1a763e581fa9fcac28fc0ffa2dc2fbc752af Mon Sep 17 00:00:00 2001 From: Paul Kevan Date: Mon, 10 Mar 2025 14:41:58 +0000 Subject: [PATCH 1/2] fix typos in misc files --- docs/code-reference/META.md | 2 +- .../acf-field-group-functions-file.md | 4 +-- .../acf-helper-functions-file.md | 12 +++---- docs/code-reference/api/api-helpers-file.md | 32 +++++++++---------- docs/code-reference/api/api-template-file.md | 4 +-- docs/code-reference/fields-file.md | 2 +- docs/code-reference/upgrades-file.md | 2 +- docs/code-reference/validation-file.md | 4 +-- 8 files changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/code-reference/META.md b/docs/code-reference/META.md index 16dbdb6b..b9d58454 100644 --- a/docs/code-reference/META.md +++ b/docs/code-reference/META.md @@ -573,7 +573,7 @@ This file tracks code elements that need documentation. ## rest-api/class-acf-rest-api.php -### Classs +### Classes - `ACF_Rest_Api` diff --git a/docs/code-reference/acf-field-group-functions-file.md b/docs/code-reference/acf-field-group-functions-file.md index f8a9a701..477834fc 100644 --- a/docs/code-reference/acf-field-group-functions-file.md +++ b/docs/code-reference/acf-field-group-functions-file.md @@ -92,7 +92,7 @@ acf_get_raw_field_groups acf_filter_field_groups -* Returns a filtered aray of field groups based on the given $args. +* Returns a filtered array of field groups based on the given $args. * @date 29/11/2013 * @since ACF 5.0.0 * @param array $field_groups An array of field groups. @@ -259,7 +259,7 @@ acf_prepare_field_group_for_import acf_import_field_group -* Imports a field group into the databse. +* Imports a field group into the database. * @date 11/03/2014 * @since ACF 5.0.0 * @param array $field_group The field group array. diff --git a/docs/code-reference/acf-helper-functions-file.md b/docs/code-reference/acf-helper-functions-file.md index e5158c40..bba39ca7 100644 --- a/docs/code-reference/acf-helper-functions-file.md +++ b/docs/code-reference/acf-helper-functions-file.md @@ -74,7 +74,7 @@ acf_enable_filter * Enables a filter with the given name. * @date 14/7/16 * @since ACF 5.4.0 -* @param string name The modifer name. +* @param string name The modifier name. * @return void ## `acf_disable_filter()` @@ -84,7 +84,7 @@ acf_disable_filter * Disables a filter with the given name. * @date 14/7/16 * @since ACF 5.4.0 -* @param string name The modifer name. +* @param string name The modifier name. * @return void ## `acf_is_filter_enabled()` @@ -94,7 +94,7 @@ acf_is_filter_enabled * Returns the state of a filter for the given name. * @date 14/7/16 * @since ACF 5.4.0 -* @param string name The modifer name. +* @param string name The modifier name. * @return array ## `acf_get_filters()` @@ -113,7 +113,7 @@ acf_set_filters * Sets an array of filter states. * @date 14/7/16 * @since ACF 5.4.0 -* @param array $filters An Array of modifers +* @param array $filters An Array of modifiers * @return array ## `acf_disable_filters()` @@ -132,7 +132,7 @@ acf_enable_filters * Enables all or an array of specific filters and returns the previous state. * @date 14/7/16 * @since ACF 5.4.0 -* @param array $filters An Array of modifers +* @param array $filters An Array of modifiers * @return array ## `acf_idval()` @@ -221,7 +221,7 @@ Returns the length of a string that has been submitted via $_POST. 1. Unslash the string because posted values will be slashed. 2. Decode special characters because wp_kses() will normalize entities. 3. Treat line-breaks as a single character instead of two. -4. Use mb_strlen() to accomodate special characters. +4. Use mb_strlen() to accommodate special characters. * @date 04/06/2020 * @since ACF 5.9.0 diff --git a/docs/code-reference/api/api-helpers-file.md b/docs/code-reference/api/api-helpers-file.md index 33af2f56..4cb21940 100644 --- a/docs/code-reference/api/api-helpers-file.md +++ b/docs/code-reference/api/api-helpers-file.md @@ -395,7 +395,7 @@ acf_get_posts _acf_query_remove_post_type * This function will remove the 'wp_posts.post_type' WHERE clause completely -When using 'post__in', this clause is unneccessary and slow. +When using 'post__in', this clause is unnecessary and slow. * @since ACF 5.1.5 * @param $sql (string) * @return $sql @@ -494,8 +494,8 @@ acf_encode_choices acf_str_replace * This function will replace an array of strings much like str_replace -The difference is the extra logic to avoid replacing a string that has alread been replaced -This is very useful for replacing date characters as they overlap with eachother +The difference is the extra logic to avoid replacing a string that has already been replaced +This is very useful for replacing date characters as they overlap with each other * @since ACF 5.3.8 * @param $post_id (int) * @return $post_id (int) @@ -504,7 +504,7 @@ This is very useful for replacing date characters as they overlap with eachother acf_split_date_time -* This function will split a format string into seperate date and time +* This function will split a format string into separate date and time * @since ACF 5.3.8 * @param $date_time (string) * @return $formats (array) @@ -513,7 +513,7 @@ acf_split_date_time acf_convert_date_to_php -* This fucntion converts a date format string from JS to PHP +* This function converts a date format string from JS to PHP * @since ACF 5.0.0 * @param $date (string) * @return (string) @@ -522,7 +522,7 @@ acf_convert_date_to_php acf_convert_date_to_js -* This fucntion converts a date format string from PHP to JS +* This function converts a date format string from PHP to JS * @since ACF 5.0.0 * @param $date (string) * @return (string) @@ -531,7 +531,7 @@ acf_convert_date_to_js acf_convert_time_to_php -* This fucntion converts a time format string from JS to PHP +* This function converts a time format string from JS to PHP * @since ACF 5.0.0 * @param $time (string) * @return (string) @@ -540,7 +540,7 @@ acf_convert_time_to_php acf_convert_time_to_js -* This fucntion converts a date format string from PHP to JS +* This function converts a date format string from PHP to JS * @since ACF 5.0.0 * @param $time (string) * @return (string) @@ -611,7 +611,7 @@ This function will walk through the $_FILES data and upload each found. acf_upload_file -* This function will uploade a $_FILE +* This function will upload a $_FILE * @since ACF 5.0.9 * @param $uploaded_file (array) array found from $_FILE data * @return $id (int) new attachment ID @@ -734,7 +734,7 @@ acf_translate * This function will translate a string using the new 'l10n_textdomain' setting Also works for arrays which is great for fields - select -> choices * @since ACF 5.3.2 -* @param $string (mixed) string or array containins strings to be translated +* @param $string (mixed) string or array containing strings to be translated * @return $string ## `acf_maybe_add_action()` @@ -769,7 +769,7 @@ Return an image tag for the provided attachment ID acf_get_post_thumbnail -* This function will return a thumbail image url for a given post +* This function will return a thumbnail image url for a given post * @since ACF 5.3.8 * @param $post (obj) * @param $size (mixed) @@ -787,7 +787,7 @@ acf_get_browser acf_is_ajax -* This function will reutrn true if performing a wp ajax call +* This function will return true if performing a wp ajax call * @since ACF 5.3.8 * @param n/a * @return (boolean) @@ -910,8 +910,8 @@ Useful to preserve numeric keys when performing array_multisort ## `acf_connect_attachment_to_post()` -This function will connect an attacment (image etc) to the post -Used to connect attachements uploaded directly to media that have not been attaced to a post +This function will connect an attachment (image etc) to the post +Used to connect attachments uploaded directly to media that have not been attached to a post * @since ACF 5.8.0 Added filter to prevent connection. * @since ACF 5.5.4 @@ -970,7 +970,7 @@ acf_convert_rules_to_groups acf_register_ajax -* Regsiters an ajax callback. +* Registers an ajax callback. * @since ACF 5.7.7 * @param string $name The ajax action name. * @param array $callback The callback function or array. @@ -991,7 +991,7 @@ Thanks to label" grouped by category +Returns an multi-dimensional array of field types "name => label" grouped by category * @since ACF 5.0.0 * @return array diff --git a/docs/code-reference/upgrades-file.md b/docs/code-reference/upgrades-file.md index 2b042a48..87805905 100644 --- a/docs/code-reference/upgrades-file.md +++ b/docs/code-reference/upgrades-file.md @@ -4,7 +4,7 @@ acf_has_upgrade -* Returns true if this site has an upgrade avaialble. +* Returns true if this site has an upgrade available. * @date 24/8/18 * @since ACF 5.7.4 * @return boolean diff --git a/docs/code-reference/validation-file.md b/docs/code-reference/validation-file.md index dbead703..77d8cdc6 100644 --- a/docs/code-reference/validation-file.md +++ b/docs/code-reference/validation-file.md @@ -8,7 +8,7 @@ Add validation error. * @type function * @date 6/10/13 * @since ACF 5.0.0 -* @param string $input name attribute of DOM elmenet. +* @param string $input name attribute of DOM element. * @param string $message error message. * @return void @@ -31,7 +31,7 @@ Get the validation error. * @date 6/10/13 * @since ACF 5.0.0 * @since 6.4.1 Added the $input parameter, which is required in the get_error method. -* @param string $input name attribute of DOM elmenet. +* @param string $input name attribute of DOM element. * @return string|bool ## `acf_reset_validation_errors()` From de86a3f0f111228ea2d578276d6f5ab95d03aa50 Mon Sep 17 00:00:00 2001 From: Paul Kevan <2290623+pkevan@users.noreply.github.com> Date: Tue, 11 Mar 2025 08:03:47 +0000 Subject: [PATCH 2/2] Make class plural manually Since the plural of `class` is `classes` we need to manually intervene. --- docs/bin/generate-parsed-md.php | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/bin/generate-parsed-md.php b/docs/bin/generate-parsed-md.php index c080f0b3..3731dd38 100644 --- a/docs/bin/generate-parsed-md.php +++ b/docs/bin/generate-parsed-md.php @@ -540,7 +540,12 @@ function ( $count ) { ksort( $types ); foreach ( $types as $type => $elements ) { - $markdown .= '### ' . ucfirst( $type ) . "s\n\n"; + // Make `class` plural manually. + if ( 'class' === strtolower( $type ) ) { + $markdown .= '### ' . ucfirst( 'classes' ) . "\n\n"; + } else { + $markdown .= '### ' . ucfirst( $type ) . "s\n\n"; + } // Sort elements alphabetically sort( $elements );