diff --git a/.changelogs/naming-conventions.yml b/.changelogs/naming-conventions.yml new file mode 100644 index 0000000000..1d802d732c --- /dev/null +++ b/.changelogs/naming-conventions.yml @@ -0,0 +1,3 @@ +significance: patch +type: fixed +entry: "Fixed naming-convention warnings reported by WordPress.org Plugin Check. Renamed several internal helper functions (llms_get_course, llms_get_lesson, llms_get_section_data, llms_get_lesson_data, llms_get_product_query_var, llms_get_available_payment_options) and the internal admin meta-box field interface (LLMS_Metabox_Field_Interface). Public API functions, template variables, WordPress core hook names, and vendored libraries were not changed. Deprecated wrappers added for backward compatibility." diff --git a/includes/admin/post-types/meta-boxes/fields/llms.interface.meta.box.field.php b/includes/admin/post-types/meta-boxes/fields/class-llms-metabox-field-interface.php similarity index 53% rename from includes/admin/post-types/meta-boxes/fields/llms.interface.meta.box.field.php rename to includes/admin/post-types/meta-boxes/fields/class-llms-metabox-field-interface.php index 5cd1c4af3a..878415c972 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.interface.meta.box.field.php +++ b/includes/admin/post-types/meta-boxes/fields/class-llms-metabox-field-interface.php @@ -11,11 +11,12 @@ defined( 'ABSPATH' ) || exit; /** - * Meta_Box_Field_Interface interface + * LLMS_Metabox_Field_Interface interface * * @since Unknown + * @deprecated [version] The old interface name `Meta_Box_Field_Interface` is deprecated. Use `LLMS_Metabox_Field_Interface`. */ -interface Meta_Box_Field_Interface { +interface LLMS_Metabox_Field_Interface { public function output(); } diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.basic.editor.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.basic.editor.php index c5bd2820ba..658db5189a 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.basic.editor.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.basic.editor.php @@ -9,7 +9,7 @@ defined( 'ABSPATH' ) || exit; -class LLMS_Metabox_Basic_Editor_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Basic_Editor_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { public function __construct( $_field ) { diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.button.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.button.php index 9c9ce1f6b0..cba2681d75 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.button.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.button.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Button_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Button_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.checkbox.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.checkbox.php index 9f3747a669..13068e1bd9 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.checkbox.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.checkbox.php @@ -16,7 +16,7 @@ * @since Unknown * @since 4.0.0 Remove reliance on `LLMS_Svg` class. */ -class LLMS_Metabox_Checkbox_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Checkbox_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.color.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.color.php index 8e9434cc5a..ee59861a5e 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.color.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.color.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Color_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Color_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.custom.html.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.custom.html.php index 2842c08ba3..efc53e988a 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.custom.html.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.custom.html.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Custom_Html_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Custom_Html_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.date.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.date.php index 9f7367aedf..3b278b76a8 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.date.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.date.php @@ -17,7 +17,7 @@ * * @since Unknown */ -class LLMS_Metabox_Date_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Date_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.editor.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.editor.php index f693a86673..290ea3051d 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.editor.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.editor.php @@ -16,7 +16,7 @@ * @since Unknown * @since 3.30.3 Explicitly define class properties. */ -class LLMS_Metabox_Editor_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Editor_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Array of editor arguments. diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.hidden.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.hidden.php index 3271cedfd4..4af366f391 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.hidden.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.hidden.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Hidden_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Hidden_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor. diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.image.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.image.php index 9d5f9773de..378d0a0679 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.image.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.image.php @@ -16,7 +16,7 @@ * @since ?? * @since 3.24.0 Unknown. */ -class LLMS_Metabox_Image_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Image_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.number.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.number.php index 745db300b8..658619936e 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.number.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.number.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Number_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Number_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { public function __construct( $_field ) { diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.content.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.content.php index a831fc6d60..96764fff28 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.content.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.content.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Post_Content_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Post_Content_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.excerpt.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.excerpt.php index 686d5f3715..9b95a66f3c 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.excerpt.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.excerpt.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Post_Excerpt_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Post_Excerpt_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.repeater.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.repeater.php index 4e7f7cfd01..130e23b41b 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.repeater.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.repeater.php @@ -16,7 +16,7 @@ * @since 3.11.0 * @version 3.17.3 */ -class LLMS_Metabox_Repeater_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Repeater_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.search.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.search.php index 286f3a81e4..ae9159c854 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.search.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.search.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Search_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Search_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.select.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.select.php index f6cc2b18e6..1f85d98dad 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.select.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.select.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Select_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Select_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.table.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.table.php index 8f205af704..995162e273 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.table.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.table.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Table_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Table_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.text.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.text.php index 5724ae7e74..f72c6c7dd8 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.text.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.text.php @@ -16,7 +16,7 @@ * @since Unknown * @since 3.36.0 When outputting the field's value convert quotes (double and single) HTML entities back to characters. */ -class LLMS_Metabox_Text_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Text_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { public function __construct( $_field ) { diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.php index 82ef2af628..86a6fc37e7 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Textarea_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Textarea_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor diff --git a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.tags.php b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.tags.php index b725c86311..e43cbbeabc 100644 --- a/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.tags.php +++ b/includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.tags.php @@ -15,7 +15,7 @@ * * @since Unknown */ -class LLMS_Metabox_Textarea_W_Tags_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface { +class LLMS_Metabox_Textarea_W_Tags_Field extends LLMS_Metabox_Field implements LLMS_Metabox_Field_Interface { /** * Class constructor. diff --git a/includes/class-llms-loader.php b/includes/class-llms-loader.php index 5bf432ad26..4e4c737131 100644 --- a/includes/class-llms-loader.php +++ b/includes/class-llms-loader.php @@ -44,7 +44,7 @@ class LLMS_Loader { // Meta box fields. 'llms_metabox_field' => 'includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.fields.php', 'llms_metabox_textarea_w_tags_field' => 'includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.tags.php', - 'meta_box_field_interface' => 'includes/admin/post-types/meta-boxes/fields/llms.interface.meta.box.field.php', + 'llms_metabox_field_interface' => 'includes/admin/post-types/meta-boxes/fields/class-llms-metabox-field-interface.php', // Missing "Model" from class name. 'llms_access_plan' => 'includes/models/model.llms.access.plan.php', diff --git a/includes/functions/llms.functions.course.php b/includes/functions/llms.functions.course.php index ad7ab17f6a..d773480ca5 100644 --- a/includes/functions/llms.functions.course.php +++ b/includes/functions/llms.functions.course.php @@ -20,7 +20,7 @@ * @param array $args Arguments to pass to the LLMS_Course Constructor. * @return LLMS_Course */ -function get_course( $the_course = false, $args = array() ) { +function llms_get_course( $the_course = false, $args = array() ) { if ( ! $the_course ) { global $post; @@ -31,6 +31,19 @@ function get_course( $the_course = false, $args = array() ) { } +/** + * Get course object + * + * @deprecated [version] Use llms_get_course() instead. + * + * @param WP_Post|int|false $the_course Course post object or id. If `false` uses the global `$post` object. + * @param array $args Arguments to pass to the LLMS_Course Constructor. + * @return LLMS_Course + */ +function get_course( $the_course = false, $args = array() ) { + return llms_get_course( $the_course, $args ); +} + /** * Get lesson object * @@ -41,7 +54,7 @@ function get_course( $the_course = false, $args = array() ) { * @param array $args Arguments to pass to the LLMS_Lesson Constructor. * @return LLMS_Lesson */ -function get_lesson( $the_lesson = false, $args = array() ) { +function llms_get_lesson( $the_lesson = false, $args = array() ) { if ( ! $the_lesson ) { global $post; @@ -51,3 +64,16 @@ function get_lesson( $the_lesson = false, $args = array() ) { return new LLMS_Lesson( $the_lesson, $args ); } + +/** + * Get lesson object + * + * @deprecated [version] Use llms_get_lesson() instead. + * + * @param WP_Post|int|false $the_lesson Lesson post object or id. If `false` uses the global `$post` object. + * @param array $args Arguments to pass to the LLMS_Lesson Constructor. + * @return LLMS_Lesson + */ +function get_lesson( $the_lesson = false, $args = array() ) { + return llms_get_lesson( $the_lesson, $args ); +} diff --git a/includes/llms.template.functions.php b/includes/llms.template.functions.php index 633ce10f24..1b9e48fd4f 100644 --- a/includes/llms.template.functions.php +++ b/includes/llms.template.functions.php @@ -540,7 +540,7 @@ function llms_setup_lesson_data( $post ) { $parent_course = get_post( $courseid ); } - $GLOBALS['lesson'] = get_lesson( $post ); + $GLOBALS['lesson'] = llms_get_lesson( $post ); llms_setup_course_data( $parent_course ); @@ -556,7 +556,7 @@ function llms_setup_lesson_data( $post ) { * @param array * @return array */ -function get_section_data( $sections ) { +function llms_get_section_data( $sections ) { global $post; $html = ''; $args = array( @@ -584,13 +584,25 @@ function get_section_data( $sections ) { return $array; } +/** + * Returns post array of data for sections associated with a course + * + * @deprecated [version] Use llms_get_section_data() instead. + * + * @param array $sections Array of section IDs. + * @return array + */ +function get_section_data( $sections ) { + return llms_get_section_data( $sections ); +} + /** * Returns post array of data for lessons associated with a course * * @param array * @return array */ -function get_lesson_data( $lessons ) { +function llms_get_lesson_data( $lessons ) { global $post; $html = ''; $args = array( @@ -618,6 +630,18 @@ function get_lesson_data( $lessons ) { return $array; } +/** + * Returns post array of data for lessons associated with a course + * + * @deprecated [version] Use llms_get_lesson_data() instead. + * + * @param array $lessons Array of lesson IDs. + * @return array + */ +function get_lesson_data( $lessons ) { + return llms_get_lesson_data( $lessons ); +} + /** * Get Page Title * @@ -1019,11 +1043,23 @@ function llms_person_my_courses_url() { * @param array $vars [array of query variables] * @return array $vars [array of query variables] */ -function get_product_query_var( $vars ) { +function llms_get_product_query_var( $vars ) { $vars[] = 'product'; return $vars; } -add_filter( 'query_vars', 'get_product_query_var' ); +add_filter( 'query_vars', 'llms_get_product_query_var' ); + +/** + * Get Product Query Var + * + * @deprecated [version] Use llms_get_product_query_var() instead. + * + * @param array $vars [array of query variables] + * @return array $vars [array of query variables] + */ +function get_product_query_var( $vars ) { + return llms_get_product_query_var( $vars ); +} /** * Get available payment gateway options @@ -1031,7 +1067,7 @@ function get_product_query_var( $vars ) { * * @return void */ -function get_available_payment_options() { +function llms_get_available_payment_options() { $_available_options = array(); $option_prefix = 'lifterlms_gateway_enable_'; @@ -1054,6 +1090,17 @@ function get_available_payment_options() { } } +/** + * Get available payment gateway options + * + * @deprecated [version] Use llms_get_available_payment_options() instead. + * + * @return void + */ +function get_available_payment_options() { + return llms_get_available_payment_options(); +} + /** * Get Product Object * diff --git a/tests/phpunit/unit-tests/admin/post-types/meta-boxes/fields/class-llms-test-meta-box-textarea-tags.php b/tests/phpunit/unit-tests/admin/post-types/meta-boxes/fields/class-llms-test-meta-box-textarea-tags.php index f690c1ac61..87c31d5b34 100644 --- a/tests/phpunit/unit-tests/admin/post-types/meta-boxes/fields/class-llms-test-meta-box-textarea-tags.php +++ b/tests/phpunit/unit-tests/admin/post-types/meta-boxes/fields/class-llms-test-meta-box-textarea-tags.php @@ -26,7 +26,7 @@ public static function set_up_before_class() { parent::set_up_before_class(); - require_once LLMS_PLUGIN_DIR . 'includes/admin/post-types/meta-boxes/fields/llms.interface.meta.box.field.php'; + require_once LLMS_PLUGIN_DIR . 'includes/admin/post-types/meta-boxes/fields/class-llms-metabox-field-interface.php'; require_once LLMS_PLUGIN_DIR . 'includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.fields.php'; require_once LLMS_PLUGIN_DIR . 'includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.tags.php';