Releases: Getbeans/Beans
Version 1.5.1
This release fixes the following bugs:
- Fixed #305 - re-enabled displaying the image field upload button.
- Fixed #307 - added functionality to recompile when in development mode.
- Fixed #304 - changed the screenshot to a .png file
This release adds a new screenshot design too, just for fun!
Version 1.5.0
This release includes security, web accessibility, code quality improvements, performance improvements, and bug fixes. The entire framework is now WPCS compliant. The APIs are now fully and thoroughly well-tested. All found issues are resolved. New functionality is added.
Changelog
A full changelog is provided with the details provided below.
Improved
- Improved web accessibility by adding skip links, ARIA, labels, tabs, and more.
- Improved the performance of the APIs by reducing expensive processes, memory usage, and execution time.
- Improved the APIs by adding thorough unit and integration test suites.
- Improved the APIs by adding type hinting, reducing redundant code, and removing unused code.
- Improved Beans by making it WPCS compliant.
- Improved CSS compiler to have one block of declarations per line.
- Improved security by auditing and applying escaping and sanitizing best practices.
- Improved the Actions API by no longer storing actions in encoded strings.
- Improved code documentation and readability.
Updated
- Updated the language's tm-beans.pot file.
- Updated UIkit to version 2.27.5 (see UIkit changelog for more information).
Added
- Added
beans_str_ends_with()
to check if the given string ends with the given substring(s). - Added
beans_str_starts_with()
to check if the given string starts with the given substring(s). - Added
beans_multi_array_key_exists()
to check if a key or index exists in a multi-dimensional array. - Added
beans_join_arrays()
to join two arrays together. - Added
beans_array_unique()
to remove duplicate values and re-index the array. - Added
beans_join_arrays_clean()
to join two arrays, remove the duplicate values and empties, and provide an option to re-index the clean array. - Added
beans_scandir()
to scan the given directory path, list all the files and directories, and remove the.
and..
files. - Added
beans_uikit_get_all_components()
to check all of the UIkit components for the given type. - Added
beans_uikit_get_all_dependencies()
to check all of the UIkit dependencies for the given component(s). - Added
beans_get_widget_area_output()
to replacebeans_get_widget_area()
. - Added
beans_add_compiler_options_to_settings()
to instantiate_Beans_Compiler_Options
through a hook instead of on file load. - Added
beans_add_page_assets_compiler()
to instantiate__Beans_Page_Compiler
through a hook instead of on file load. - Added
beans_add_image_options_to_settings()
to instantiate___Beans_Image_Options
through a hook instead of on file load. - Added
beans_has_primary_sidebar()
to check if the given layout has a primary sidebar. - Added
beans_has_secondary_sidebar()
to check if the given layout has a secondary sidebar. - Added
beans_skip_links_list()
to filter the skip links. - Added
beans_output_skip_links()
to render the skip links. - Added
beans_accessibility_skip_link_fix()
to enqueue skip link fix script for IE 11. - Added many new private functions.
Changes
beans_add_action()
returnsfalse
when the action is not added viaadd_action
.beans_add_smart_action()
returnsfalse
when the action is not added viaadd_action
.beans_modify_action()
returnsfalse
when hook, callback, priority, and args are not given.beans_modify_action_hook()
returnsfalse
when the hook is empty or not a string.beans_modify_action_callback()
returnsfalse
when the callback is empty.beans_replace_action()
returnsfalse
when hook, callback, priority, and args are not given.beans_replace_action_hook()
returnsfalse
when the hook is empty or not a string.beans_replace_action_callback()
returnsfalse
when the callback is empty.beans_remove_action()
sets "removed" to the default when no current action exists.beans_reset_action()
bails out if the action does not need to be reset.- Unset the global variable in
beans_selfclose_markup()
to reduce memory usage. beans_wrap_markup()
bails out and returnsfalse
if the given$tag
is empty.beans_wrap_inner_markup()
bails out and returnsfalse
if the given$tag
is empty.beans_add_attribute()
returns an instance of_Beans_Attribute
.beans_replace_attribute()
replaces all values when thevalue
argument is empty.beans_replace_attribute()
returns an instance of_Beans_Attribute
.beans_remove_attribute()
returns an instance of_Beans_Attribute
.- Moved the API's HTML to view files to improve code quality.
- Changes to private functions and methods are not noted here.
Fixed
- Fixed
depedencies
typo in Compiler's configuration (nowdependencies
). Provided fallback. - Fixed Customizer Preview Tools.
- Fixed UIkit API bug when not returning all dependency components.
- Fixed Beans Image Editor for ARRAY_A.
- Fixed
beans_get_post_meta()
. - Fixed
beans_get_term_meta()
. - Fixed Compiler to recompile when a fragment changes and not in development mode.
- Fixed replacing action to remove from WordPress.
- Fixed Actions API to allow priority of 0 to be modified.
- Fixed Actions API double subhook calls.
- Fixed
beans_path_to_url()
to bail out when relative URL. - Fixed count for
beans_count_recursive()
. - Fixed removing tilde from
beans_url_to_path()
. - Fixed processing relative URLs in
beans_url_to_path()
. - Fixed altering of non-internal URLs in
beans_url_to_path()
. - Fixed
beans_get_layout_class()
not returning correct classes when secondary is no longer registered. - Fixed 'Next Post' icon close markup ID.
- Fixed 'Read More' icon markup IDs.
- Fixed
beans_get_widget_area()
to returnfalse
on fail. - Fixed
beans_get_widget()
to returnfalse
on fail. - Fixes to private functions and methods are not noted here.
Deprecated
- Deprecated
beans_count_recursive()
as it is unused in Beans. - Deprecated
beans_widget_area()
by replacing it with a renamed functionbeans_get_widget_area_output()
that better describes the expected behavior. - Deprecated the image toolbar's dashicons' class attributes.
Version 1.5.0-rc
This release candidate includes security, web accessibility, code quality improvements, performance improvements, and bug fixes. The entire framework is now WPCS compliant. The APIs are now fully and thoroughly well-tested. All found issues are resolved. New functionality is added.
RC Testing Instructions
If you'd like to help us test this release candidate, here are some instructions:
- Download
tm-beans.zip
file. You can install this through the WordPress'Appearance > Themes > Add Theme
interface or by unzipping the files into yourwp-content/themes
folder. - Test it on a non-production website. Try navigating. Try the skip links. Try different pieces of content.
If you find an issue, go to the Issues tab and open issue to report to the team. Please set the title like this:
v1.5.0-rc: Describe the issue
Using this issue naming us to quickly find all issues. We will reach out and discuss each with you. Then we can work together to solve each one.
Changelog
Read the 1.5.0-rc changelog carefully before updating as some changes slightly affects backwards compatibility.
Version 1.5.0-beta
This pre-release includes security, web accessibility, code quality improvements, performance improvements, and bug fixes. The entire framework is now WPCS compliant. The APIs are now fully and thoroughly well-tested. All found issues are resolved. New functionality is added.
Beta Testing Instructions
If you'd like to help us beta test this pre-release, here are some instructions:
- Download
tm-beans.zip
file. You can install this through the WordPress'Appearance > Themes > Add Theme
interface or by unzipping the files into yourwp-content/themes
folder. - Test it on a non-production website. Try navigating. Try the skip links. Try different pieces of content.
If you find an issue, go to the Issues tab and open issue to report to the team. Please set the title like this:
v1.5.0-beta: Describe the issue
Using this issue naming us to quickly find all issues. We will reach out and discuss each with you. Then we can work together to solve each one.
Changelog
A full changelog is provided with the details provided below.
Improved
- Improved web accessibility by adding skip links, ARIA, labels, tabs, and more.
- Improved the performance of the APIs by reducing expensive processes, memory usage, and execution time.
- Improved the APIs by adding thorough unit and integration test suites.
- Improved the APIs by adding type hinting, reducing redundant code, and removing unused code.
- Improved Beans by making it WPCS compliant.
- Improved CSS compiler to have one block of declarations per line.
- Improved security by auditing and applying escaping and sanitizing best practices.
- Improved the Actions API by no longer storing actions in encoded strings.
- Improved code documentation and readability.
Updated
- Updated the language's tm-beans.pot file.
- Updated UIkit to version 2.27.5 (see UIkit changelog for more information).
Added
- Added
beans_str_ends_with()
to check if the given string ends with the given substring(s). - Added
beans_str_starts_with()
to check if the given string starts with the given substring(s). - Added
beans_multi_array_key_exists()
to check if a key or index exists in a multi-dimensional array. - Added
beans_join_arrays()
to join two arrays together. - Added
beans_array_unique()
to remove duplicate values and re-index the array. - Added
beans_join_arrays_clean()
to join two arrays, remove the duplicate values and empties, and provide an option to re-index the clean array. - Added
beans_scandir()
to scan the given directory path, list all the files and directories, and remove the.
and..
files. - Added
beans_uikit_get_all_components()
to check all of the UIkit components for the given type. - Added
beans_uikit_get_all_dependencies()
to check all of the UIkit dependencies for the given component(s). - Added
beans_get_widget_area_output()
to replacebeans_get_widget_area()
. - Added
beans_add_compiler_options_to_settings()
to instantiate_Beans_Compiler_Options
through a hook instead of on file load. - Added
beans_add_page_assets_compiler()
to instantiate__Beans_Page_Compiler
through a hook instead of on file load. - Added
beans_add_image_options_to_settings()
to instantiate___Beans_Image_Options
through a hook instead of on file load. - Added
beans_has_primary_sidebar()
to check if the given layout has a primary sidebar. - Added
beans_has_secondary_sidebar()
to check if the given layout has a secondary sidebar. - Added
beans_skip_links_list()
to filter the skip links. - Added
beans_output_skip_links()
to render the skip links. - Added
beans_accessibility_skip_link_fix()
to enqueue skip link fix script for IE 11. - Added many new private functions.
Changes
beans_add_action()
returnsfalse
when the action is not added viaadd_action
.beans_add_smart_action()
returnsfalse
when the action is not added viaadd_action
.beans_modify_action()
returnsfalse
when hook, callback, priority, and args are not given.beans_modify_action_hook()
returnsfalse
when the hook is empty or not a string.beans_modify_action_callback()
returnsfalse
when the callback is empty.beans_replace_action()
returnsfalse
when hook, callback, priority, and args are not given.beans_replace_action_hook()
returnsfalse
when the hook is empty or not a string.beans_replace_action_callback()
returnsfalse
when the callback is empty.beans_remove_action()
sets "removed" to the default when no current action exists.beans_reset_action()
bails out if the action does not need to be reset.- Unset the global variable in
beans_selfclose_markup()
to reduce memory usage. beans_wrap_markup()
bails out and returnsfalse
if the given$tag
is empty.beans_wrap_inner_markup()
bails out and returnsfalse
if the given$tag
is empty.beans_add_attribute()
returns an instance of_Beans_Attribute
.beans_replace_attribute()
replaces all values when thevalue
argument is empty.beans_replace_attribute()
returns an instance of_Beans_Attribute
.beans_remove_attribute()
returns an instance of_Beans_Attribute
.- Moved the API's HTML to view files to improve code quality.
- Changes to private functions and methods are not noted here.
Fixed
- Fixed
depedencies
typo in Compiler's configuration (nowdependencies
). Provided fallback. - Fixed Customizer Preview Tools.
- Fixed UIkit API bug when not returning all dependency components.
- Fixed Beans Image Editor for ARRAY_A.
- Fixed
beans_get_post_meta()
. - Fixed
beans_get_term_meta()
. - Fixed Compiler to recompile when a fragment changes and not in development mode.
- Fixed replacing action to remove from WordPress.
- Fixed Actions API to allow priority of 0 to be modified.
- Fixed Actions API double subhook calls.
- Fixed
beans_path_to_url()
to bail out when relative URL. - Fixed count for
beans_count_recursive()
. - Fixed removing tilde from
beans_url_to_path()
. - Fixed processing relative URLs in
beans_url_to_path()
. - Fixed altering of non-internal URLs in
beans_url_to_path()
. - Fixed
beans_get_layout_class()
not returning correct classes when secondary is no longer registered. - Fixed 'Next Post' icon close markup ID.
- Fixed 'Read More' icon markup IDs.
- Fixed
beans_get_widget_area()
to returnfalse
on fail. - Fixed
beans_get_widget()
to returnfalse
on fail. - Fixes to private functions and methods are not noted here.
Deprecated
- Deprecated
beans_count_recursive()
as it is unused in Beans. - Deprecated
beans_widget_area()
by replacing it with a renamed functionbeans_get_widget_area_output()
that better describes the expected behavior. - Deprecated the image toolbar's dashicons' class attributes.
Version 1.4.0
This release is a security and improvement update. A significant part of this update is code quality improvement according to WPCS. Read the changelog below carefully before updating as some changes slightly affects backwards compatibility.
- Important: Added archive page title (backwards compatibility affected).
- Important: Fixed post author meta prefix (backwards compatibility affected).
- Important: Modified WP Customizer fields transport default to
refresh
(backwards compatibility affected). - Added output filter to breadcrumb items text.
- Added HTML API echoing functions.
- Improved the default menu registration to prevent conflicts (this prevents the PHP warning when using WPML).
- Updated UIkit to version 2.27.1 (see UIkit changelog for more info).
- Modified comment form name to required (appended an asterisk to the label).
- Improved post and navigation microdata.
- Improved admin editor styling using UIkit base style.
- Improved fields HTML using the new HTML API functions.
- Improved global escaping.
- Improved HTML using the new HTML API functions.
- Improved code globally according to WPCS (major code quality improvement).
- Fixed
beans_comment_content_output
filter. - Fixed settings select PHP notice.
- Fixed PHP warning do to WP comments_open() function lack of isset check.
- Fixed comment form reply link output.
- Fixed child theme favicon overwrite.
- Fixed subfilters applied twice in rare cases.
- Fixed footer credit typography mistake.
- Fixed rare layout issue if no posts page is assigned.
- Removed gzip processor unused since version 1.0.0 (backwards compatibility not affected since it was not for public usage).
Happy coding!
Version 1.4.0-rc
This release is a security and improvement update. A significant part of this update is code quality improvement according to WPCS. Read the 1.4.0-beta changelog carefully before updating as some changes slightly affects backwards compatibility.
Version 1.4.0-beta
This release is a security and improvement update. A significant part of this update is code quality improvement according to WPCS. Read the changelog below carefully before updating as some changes slightly affects backwards compatibility.
- Important: Added archive page title (backwards compatibility affected).
- Important: Fixed post author meta prefix (backwards compatibility affected).
- Important: Modified WP Customizer fields transport default to
refresh
(backwards compatibility affected). - Added output filter to breadcrumb items text.
- Added HTML API echoing functions.
- Improved the default menu registration to prevent conflicts (this prevents the PHP warning when using WPML).
- Updated UIkit to version 2.27.1 (see UIkit changelog for more info).
- Modified comment form name to required (appended an asterisk to the label).
- Improved post and navigation microdata.
- Improved admin editor styling using UIkit base style.
- Improved fields HTML using the new HTML API functions.
- Improved global escaping.
- Improved HTML using the new HTML API functions.
- Improved code globally according to WPCS (major code quality improvement).
- Fixed
beans_comment_content_output
filter. - Fixed settings select PHP notice.
- Fixed PHP warning do to WP comments_open() function lack of isset check.
- Fixed comment form reply link output.
- Fixed child theme favicon overwrite.
- Fixed subfilters applied twice in rare cases.
- Fixed footer credit typography mistake.
- Fixed rare layout issue if no posts page is assigned.
- Removed gzip processor unused since version 1.0.0 (backwards compatibility not affected since it was not for public usage).
Happy coding!
Version 1.3.1
This release is a security and improvement update. Read the changelog below carefully before updating as some changes slightly affects backwards compatibility.
- Important: removed no comment notice when comments are closed and empty (backwards compatibility affected).
- Important: removed irritating #more-{$post->ID} anchor no longer added in WP core themes (backwards compatibility affected).
- Important: removed article panel box negative margins on mobile (backwards compatibility affected).
- Important: removed logo image alt output filter (backwards compatibility affected). Removed since the image alt text can be modified using Beans HTML API.
- Added automatic escaping to tighten security.
- Added comment form fields dynamic grid columns.
- Added beans_reset_markup and beans_reset_attributes functions.
- Added submenu type and location subfilters.
- Improved API fields escaping and HTML format to tighten security.
- Improved global code formatting.
- Improved global PHP inline documentation.
- Modified beans_sanatize_attributes function to beans_esc_attributes (backwards compatibility applies).
- Fixed global assets compiling enqueued flag which was causing jQuery (and sometime other files) conflicts with some plugins when the Compile all WordPress scripts is enabled and set to Agressive.
- Fixed comment fields responsive grid spacing.
- Fixed off-canvas navigation spacing.
- Fixed post meta conditions string support.
- Fixed post meta not displaying on new posts (the issue only occurred on the 'post' post type).
- Fixed incorrect text-domain.
- Removed unnecessary javascript semicolon separator.
Please make sure to clear the assets caching under Appearance->Settings for the CSS off-canvas fix to be applied.
Version 1.3.1-rc2
This release is a security and improvement update. Read the 1.3.1-beta changelog carefully before updating as some changes slightly affects backwards compatibility.
- Modified beans_sanitize_attributes function to beans_esc_attributes. No backwards compatibility added because
beans_sanitize_attributes
was introduced in 1.3.1-beta and never in a stable version. - Removed logo image alt output filter (backwards compatibility affected). Removed since the image alt text can be modified using Beans HTML API.
Version 1.3.1-rc
This release is a security and improvement update. Read the 1.3.1-beta changelog carefully before updating as some changes slightly affects backwards compatibility.