Skip to content

Specify the version refers to SCF in @since annotations #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion assets/src/js/_acf-validation.js
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@
*
* @since ACF 5.7.5
*
* @param {string} [location=before] - The location to add the error, before or after the input. Default before. Since 6.3.
* @param {string} [location=before] - The location to add the error, before or after the input. Default before. Since ACF 6.3.
* @return void
*/
showErrors: function ( location = 'before' ) {
Expand Down
4 changes: 2 additions & 2 deletions docs/code-reference/admin/admin-notices-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Creates and returns a new notice.
* @since ACF 5.0.0
* @param string $text The admin notice text.
* @param string $type The type of notice (warning, error, success, info).
* @param boolean $dismissible Is this notification dismissible (default true) (since 5.11.0).
* @param boolean $persisted Store once a notice has been dismissed per user and prevent showing it again. (since 6.1.0).
* @param boolean $dismissible Is this notification dismissible (default true) (since ACF 5.11.0).
* @param boolean $persisted Store once a notice has been dismissed per user and prevent showing it again. (since ACF 6.1.0).
* @return ACF_Admin_Notice

---
2 changes: 1 addition & 1 deletion docs/code-reference/api/api-template-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Updates the array of instances where HTML was altered due to escaping in the_fie
## `_acf_delete_escaped_html_log()`

Deletes the array of instances where HTML was altered due to escaping in the_field or a shortcode.
Since 6.2.7, also clears the legacy `acf_will_escape_html_log` option to clean up.
Since ACF 6.2.7, also clears the legacy `acf_will_escape_html_log` option to clean up.

* @since ACF 6.2.5
* @return boolean True on success, or false on failure.
Expand Down
2 changes: 1 addition & 1 deletion docs/code-reference/validation-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Get the validation error.
* @type function
* @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.
* @since SCF 6.4.1 Added the $input parameter, which is required in the get_error method.
* @param string $input name attribute of DOM element.
* @return string|bool

Expand Down
2 changes: 1 addition & 1 deletion includes/admin/admin-notices.php
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ function acf_render_admin_notices() {
* @param string $text The admin notice text.
* @param string $type The type of notice (warning, error, success, info).
* @param boolean $dismissible Is this notification dismissible (default true) (since 5.11.0).
* @param boolean $persisted Store once a notice has been dismissed per user and prevent showing it again. (since 6.1.0).
* @param boolean $persisted Store once a notice has been dismissed per user and prevent showing it again. (since ACF 6.1.0).
* @return ACF_Admin_Notice
*/
function acf_add_admin_notice( $text = '', $type = 'info', $dismissible = true, $persisted = false ) {
Expand Down
2 changes: 1 addition & 1 deletion includes/admin/beta-features.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* This file contains the admin beta features functionality for Secure Custom Fields.
*
* @package Secure Custom Fields
* @since 6.5.0
* @since SCF 6.5.0
*/

if ( ! defined( 'ABSPATH' ) ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* This beta feature allows moving field group elements to the editor sidebar.
*
* @package Secure Custom Fields
* @since 6.5.0
* @since SCF 6.5.0
*/

if ( ! defined( 'ABSPATH' ) ) {
Expand All @@ -20,7 +20,7 @@
* for a cleaner interface.
*
* @package Secure Custom Fields
* @since 6.5.0
* @since SCF 6.5.0
*/
class SCF_Admin_Beta_Feature_Editor_Sidebar extends SCF_Admin_Beta_Feature {

Expand Down
4 changes: 2 additions & 2 deletions includes/admin/beta-features/class-scf-beta-feature.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* This class serves as the base for all beta features in Secure Custom Fields.
*
* @package Secure Custom Fields
* @since 6.5.0
* @since SCF 6.5.0
*/

if ( ! defined( 'ABSPATH' ) ) {
Expand All @@ -20,7 +20,7 @@
* for managing beta feature settings and UI.
*
* @package Secure Custom Fields
* @since 6.5.0
* @since SCF 6.5.0
*/
class SCF_Admin_Beta_Feature {

Expand Down
2 changes: 1 addition & 1 deletion includes/admin/views/beta-features/beta-features.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Admin Beta Features View
*
* @package Secure Custom Fields
* @since 6.5.0
* @since SCF 6.5.0
*/

if ( ! defined( 'ABSPATH' ) ) {
Expand Down
2 changes: 1 addition & 1 deletion includes/api/api-template.php
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ function _acf_update_escaped_html_log( $escaped = array() ) {

/**
* Deletes the array of instances where HTML was altered due to escaping in the_field or a shortcode.
* Since 6.2.7, also clears the legacy `acf_will_escape_html_log` option to clean up.
* Since ACF 6.2.7, also clears the legacy `acf_will_escape_html_log` option to clean up.
*
* @since ACF 6.2.5
*
Expand Down
4 changes: 2 additions & 2 deletions includes/fields/class-acf-field-clone.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* This class handles the clone field type, which allows users to select and display existing fields.
*
* @package wordpress/secure-custom-fields
* @since 5.0.0
* @since ACF 5.0.0
*/

// phpcs:disable PEAR.NamingConventions.ValidClassName
Expand All @@ -15,7 +15,7 @@
*
* Handles the functionality for the clone field type.
*
* @since 5.0.0
* @since ACF 5.0.0
*/
class acf_field_clone extends acf_field {

Expand Down
4 changes: 2 additions & 2 deletions includes/fields/class-acf-field-nav-menu.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* This is a PHP file containing the code for the acf_field_nav_menu class.
*
* @package wordpress/secure-custom-fields
* @since 6.5.0
* @since SCF 6.5.0
*/

if ( ! class_exists( 'Acf_Field_Nav_Menu' ) ) :
Expand All @@ -17,7 +17,7 @@ class Acf_Field_Nav_Menu extends acf_field {
*
* @type function
* @date 5/03/2014
* @since 6.5.0
* @since SCF 6.5.0
*/
public function initialize() {

Expand Down
2 changes: 1 addition & 1 deletion includes/fields/class-acf-field-output.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public function initialize() {
*/
public function render_field( $field ) {

// Deprecated since 6.3.2 and will be removed in a future release.
// Deprecated since ACF 6.3.2 and will be removed in a future release.
_deprecated_function( __FUNCTION__, '6.3.2' );
return false;
}
Expand Down
6 changes: 3 additions & 3 deletions includes/locations.php
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ function acf_validate_location_rule( $rule = array() ) {
function acf_get_location_rule_operators( $rule ) {
$operators = ACF_Location::get_operators( $rule );

// Get operators from location type since 5.9.
// Get operators from location type since ACF 5.9.
$location_type = acf_get_location_type( $rule['param'] );
if ( $location_type ) {
$operators = $location_type->get_operators( $rule );
Expand Down Expand Up @@ -213,7 +213,7 @@ function acf_get_location_rule_operators( $rule ) {
function acf_get_location_rule_values( $rule ) {
$values = array();

// Get values from location type since 5.9.
// Get values from location type since ACF 5.9.
$location_type = acf_get_location_type( $rule['param'] );
if ( $location_type ) {
$values = $location_type->get_values( $rule );
Expand Down Expand Up @@ -248,7 +248,7 @@ function acf_get_location_rule_values( $rule ) {
function acf_match_location_rule( $rule, $screen, $field_group ) {
$result = false;

// Get result from location type since 5.9.
// Get result from location type since ACF 5.9.
$location_type = acf_get_location_type( $rule['param'] );
if ( $location_type ) {
$result = $location_type->match( $rule, $screen, $field_group );
Expand Down
2 changes: 1 addition & 1 deletion includes/rest-api.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* REST API
*
* @package Secure Custom Fields
* @since 6.4.0
* @since ACF 6.4.0
*/

// Exit if accessed directly.
Expand Down
10 changes: 5 additions & 5 deletions includes/rest-api/class-acf-rest-types-endpoint.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@
*
* Extends the /wp/v2/types endpoint to include SCF fields.
*
* @since 6.5.0
* @since SCF 6.5.0
*/
class SCF_Rest_Types_Endpoint {

/**
* Initialize the class.
*
* @since 6.5.0
* @since SCF 6.5.0
*/
public function __construct() {
add_action( 'rest_api_init', array( $this, 'register_extra_fields' ) );
Expand All @@ -32,7 +32,7 @@ public function __construct() {
/**
* Register extra SCF fields for the post types endpoint.
*
* @since 6.5.0
* @since SCF 6.5.0
*
* @return void
*/
Expand All @@ -53,7 +53,7 @@ public function register_extra_fields() {
/**
* Get SCF fields for a post type.
*
* @since 6.5.0
* @since SCF 6.5.0
*
* @param array $post_type_object The post type object.
* @return array Array of field data.
Expand Down Expand Up @@ -86,7 +86,7 @@ public function get_scf_fields( $post_type_object ) {
/**
* Get the schema for the SCF fields.
*
* @since 6.5.0
* @since SCF 6.5.0
*
* @return array The schema for the SCF fields.
*/
Expand Down
2 changes: 1 addition & 1 deletion includes/validation.php
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ function acf_get_validation_errors() {
* @type function
* @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.
* @since SCF 6.4.1 Added the $input parameter, which is required in the get_error method.
*
* @param string $input name attribute of DOM element.
*
Expand Down
2 changes: 1 addition & 1 deletion secure-custom-fields.php
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ public function init() {
*/
do_action( 'acf/include_options_pages', ACF_MAJOR_VERSION );

// If we're on WP 6.5 or newer, load block bindings. This will move to an autoloader in SCF 6.3.
// If we're on WP 6.5 or newer, load block bindings. This will move to an autoloader in ACF 6.3.
if ( version_compare( get_bloginfo( 'version' ), '6.5-beta1', '>=' ) ) {
acf_include( 'includes/Blocks/Bindings.php' );
new ACF\Blocks\Bindings();
Expand Down
Loading