diff options
Diffstat (limited to 'plugins/jetpack/modules/custom-post-types/nova.php')
| -rw-r--r-- | plugins/jetpack/modules/custom-post-types/nova.php | 1428 |
1 files changed, 917 insertions, 511 deletions
diff --git a/plugins/jetpack/modules/custom-post-types/nova.php b/plugins/jetpack/modules/custom-post-types/nova.php index e4d7f00b..78d7fa5b 100644 --- a/plugins/jetpack/modules/custom-post-types/nova.php +++ b/plugins/jetpack/modules/custom-post-types/nova.php @@ -1,36 +1,39 @@ -<?php - -use Automattic\Jetpack\Assets; - -/* +<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName +/** + * Manage restaurant menus from your WordPress site, + * via a new "nova" CPT. + * * Put the following code in your theme's Food Menu Page Template to customize the markup of the menu. + * + * if ( class_exists( 'Nova_Restaurant' ) ) { + * Nova_Restaurant::init( array( + * 'menu_tag' => 'section', + * 'menu_class' => 'menu-items', + * 'menu_header_tag' => 'header', + * 'menu_header_class' => 'menu-group-header', + * 'menu_title_tag' => 'h1', + * 'menu_title_class' => 'menu-group-title', + * 'menu_description_tag' => 'div', + * 'menu_description_class' => 'menu-group-description', + * ) ); + * } + * + * @todo + * - Bulk/Quick edit response of Menu Item rows is broken. + * - Drag and Drop reordering. + * + * @package automattic/jetpack + */ -if ( class_exists( 'Nova_Restaurant' ) ) { - Nova_Restaurant::init( array( - 'menu_tag' => 'section', - 'menu_class' => 'menu-items', - 'menu_header_tag' => 'header', - 'menu_header_class' => 'menu-group-header', - 'menu_title_tag' => 'h1', - 'menu_title_class' => 'menu-group-title', - 'menu_description_tag' => 'div', - 'menu_description_class' => 'menu-group-description', - ) ); -} - -*/ - -/* @todo - -Bulk/Quick edit response of Menu Item rows is broken. - -Drag and Drop reordering. -*/ +use Automattic\Jetpack\Assets; +/** + * Create the new Nova CPT. + */ class Nova_Restaurant { const MENU_ITEM_POST_TYPE = 'nova_menu_item'; const MENU_ITEM_LABEL_TAX = 'nova_menu_item_label'; - const MENU_TAX = 'nova_menu'; + const MENU_TAX = 'nova_menu'; /** * Version number used when enqueuing all resources (css and js). @@ -39,6 +42,11 @@ class Nova_Restaurant { */ public $version = '20210303'; + /** + * Default markup for the menu items. + * + * @var array + */ protected $default_menu_item_loop_markup = array( 'menu_tag' => 'section', 'menu_class' => 'menu-items', @@ -50,14 +58,38 @@ class Nova_Restaurant { 'menu_description_class' => 'menu-group-description', ); + /** + * Array of markup for the menu items. + * + * @var array + */ protected $menu_item_loop_markup = array(); + + /** + * Last term ID of a loop of menu items. + * + * @var bool|int + */ protected $menu_item_loop_last_term_id = false; + + /** + * Current term ID of a loop of menu items. + * + * @var bool|int + */ protected $menu_item_loop_current_term = false; - static function init( $menu_item_loop_markup = array() ) { + /** + * Initialize class. + * + * @param array $menu_item_loop_markup Array of markup for the menu items. + * + * @return self + */ + public static function init( $menu_item_loop_markup = array() ) { static $instance = false; - if ( !$instance ) { + if ( ! $instance ) { $instance = new Nova_Restaurant(); } @@ -68,18 +100,23 @@ class Nova_Restaurant { return $instance; } - function __construct() { - if ( ! $this->site_supports_nova() ) + /** + * Constructor. + * Hook into WordPress to create CPT and utilities if needed. + */ + public function __construct() { + if ( ! $this->site_supports_nova() ) { return; + } $this->register_taxonomies(); $this->register_post_types(); - add_action( 'admin_menu', array( $this, 'add_admin_menus' ) ); - add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_nova_styles' ) ); - add_action( 'admin_head', array( $this, 'set_custom_font_icon' ) ); + add_action( 'admin_menu', array( $this, 'add_admin_menus' ) ); + add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_nova_styles' ) ); + add_action( 'admin_head', array( $this, 'set_custom_font_icon' ) ); // Always sort menu items correctly - add_action( 'parse_query', array( $this, 'sort_menu_item_queries_by_menu_order' ) ); + add_action( 'parse_query', array( $this, 'sort_menu_item_queries_by_menu_order' ) ); add_filter( 'posts_results', array( $this, 'sort_menu_item_queries_by_menu_taxonomy' ), 10, 2 ); add_action( 'wp_insert_post', array( $this, 'add_post_meta' ) ); @@ -89,22 +126,26 @@ class Nova_Restaurant { // Only output our Menu Item Loop Markup on a real blog view. Not feeds, XML-RPC, admin, etc. add_filter( 'template_include', array( $this, 'setup_menu_item_loop_markup__in_filter' ) ); - add_filter( 'enter_title_here', array( $this, 'change_default_title' ) ); - add_filter( 'post_updated_messages', array( $this, 'updated_messages' ) ); - add_filter( 'dashboard_glance_items', array( $this, 'add_to_dashboard' ) ); + add_filter( 'enter_title_here', array( $this, 'change_default_title' ) ); + add_filter( 'post_updated_messages', array( $this, 'updated_messages' ) ); + add_filter( 'dashboard_glance_items', array( $this, 'add_to_dashboard' ) ); } /** - * Should this Custom Post Type be made available? - */ - function site_supports_nova() { + * Should this Custom Post Type be made available? + * + * @return bool + */ + private function site_supports_nova() { // If we're on WordPress.com, and it has the menu site vertical. - if ( function_exists( 'site_vertical' ) && 'nova_menu' == site_vertical() ) + if ( function_exists( 'site_vertical' ) && 'nova_menu' === site_vertical() ) { return true; + } // Else, if the current theme requests it. - if ( current_theme_supports( self::MENU_ITEM_POST_TYPE ) ) + if ( current_theme_supports( self::MENU_ITEM_POST_TYPE ) ) { return true; + } // Otherwise, say no unless something wants to filter us to say yes. /** @@ -120,201 +161,244 @@ class Nova_Restaurant { return (bool) apply_filters( 'jetpack_enable_cpt', false, self::MENU_ITEM_POST_TYPE ); } -/* Setup */ + /* Setup */ /** * Register Taxonomies and Post Type */ - function register_taxonomies() { + private function register_taxonomies() { if ( ! taxonomy_exists( self::MENU_ITEM_LABEL_TAX ) ) { - register_taxonomy( self::MENU_ITEM_LABEL_TAX, self::MENU_ITEM_POST_TYPE, array( - 'labels' => array( - /* translators: this is about a food menu */ - 'name' => __( 'Menu Item Labels', 'jetpack' ), - /* translators: this is about a food menu */ - 'singular_name' => __( 'Menu Item Label', 'jetpack' ), - /* translators: this is about a food menu */ - 'search_items' => __( 'Search Menu Item Labels', 'jetpack' ), - 'popular_items' => __( 'Popular Labels', 'jetpack' ), - /* translators: this is about a food menu */ - 'all_items' => __( 'All Menu Item Labels', 'jetpack' ), - /* translators: this is about a food menu */ - 'edit_item' => __( 'Edit Menu Item Label', 'jetpack' ), - /* translators: this is about a food menu */ - 'view_item' => __( 'View Menu Item Label', 'jetpack' ), - /* translators: this is about a food menu */ - 'update_item' => __( 'Update Menu Item Label', 'jetpack' ), - /* translators: this is about a food menu */ - 'add_new_item' => __( 'Add New Menu Item Label', 'jetpack' ), - /* translators: this is about a food menu */ - 'new_item_name' => __( 'New Menu Item Label Name', 'jetpack' ), - 'separate_items_with_commas' => __( 'For example, spicy, favorite, etc. <br /> Separate Labels with commas', 'jetpack' ), - 'add_or_remove_items' => __( 'Add or remove Labels', 'jetpack' ), - 'choose_from_most_used' => __( 'Choose from the most used Labels', 'jetpack' ), - 'items_list_navigation' => __( 'Menu item label list navigation', 'jetpack' ), - 'items_list' => __( 'Menu item labels list', 'jetpack' ), - ), - 'no_tagcloud' => __( 'No Labels found', 'jetpack' ), - 'hierarchical' => false, - ) ); + register_taxonomy( + self::MENU_ITEM_LABEL_TAX, + self::MENU_ITEM_POST_TYPE, + array( + 'labels' => array( + /* translators: this is about a food menu */ + 'name' => __( 'Menu Item Labels', 'jetpack' ), + /* translators: this is about a food menu */ + 'singular_name' => __( 'Menu Item Label', 'jetpack' ), + /* translators: this is about a food menu */ + 'search_items' => __( 'Search Menu Item Labels', 'jetpack' ), + 'popular_items' => __( 'Popular Labels', 'jetpack' ), + /* translators: this is about a food menu */ + 'all_items' => __( 'All Menu Item Labels', 'jetpack' ), + /* translators: this is about a food menu */ + 'edit_item' => __( 'Edit Menu Item Label', 'jetpack' ), + /* translators: this is about a food menu */ + 'view_item' => __( 'View Menu Item Label', 'jetpack' ), + /* translators: this is about a food menu */ + 'update_item' => __( 'Update Menu Item Label', 'jetpack' ), + /* translators: this is about a food menu */ + 'add_new_item' => __( 'Add New Menu Item Label', 'jetpack' ), + /* translators: this is about a food menu */ + 'new_item_name' => __( 'New Menu Item Label Name', 'jetpack' ), + 'separate_items_with_commas' => __( 'For example, spicy, favorite, etc. <br /> Separate Labels with commas', 'jetpack' ), + 'add_or_remove_items' => __( 'Add or remove Labels', 'jetpack' ), + 'choose_from_most_used' => __( 'Choose from the most used Labels', 'jetpack' ), + 'items_list_navigation' => __( 'Menu item label list navigation', 'jetpack' ), + 'items_list' => __( 'Menu item labels list', 'jetpack' ), + ), + 'no_tagcloud' => __( 'No Labels found', 'jetpack' ), + 'hierarchical' => false, + ) + ); } if ( ! taxonomy_exists( self::MENU_TAX ) ) { - register_taxonomy( self::MENU_TAX, self::MENU_ITEM_POST_TYPE, array( - 'labels' => array( + register_taxonomy( + self::MENU_TAX, + self::MENU_ITEM_POST_TYPE, + array( + 'labels' => array( + /* translators: this is about a food menu */ + 'name' => __( 'Menu Sections', 'jetpack' ), + /* translators: this is about a food menu */ + 'singular_name' => __( 'Menu Section', 'jetpack' ), + /* translators: this is about a food menu */ + 'search_items' => __( 'Search Menu Sections', 'jetpack' ), + /* translators: this is about a food menu */ + 'all_items' => __( 'All Menu Sections', 'jetpack' ), + /* translators: this is about a food menu */ + 'parent_item' => __( 'Parent Menu Section', 'jetpack' ), + /* translators: this is about a food menu */ + 'parent_item_colon' => __( 'Parent Menu Section:', 'jetpack' ), + /* translators: this is about a food menu */ + 'edit_item' => __( 'Edit Menu Section', 'jetpack' ), + /* translators: this is about a food menu */ + 'view_item' => __( 'View Menu Section', 'jetpack' ), + /* translators: this is about a food menu */ + 'update_item' => __( 'Update Menu Section', 'jetpack' ), + /* translators: this is about a food menu */ + 'add_new_item' => __( 'Add New Menu Section', 'jetpack' ), + /* translators: this is about a food menu */ + 'new_item_name' => __( 'New Menu Sections Name', 'jetpack' ), + 'items_list_navigation' => __( 'Menu section list navigation', 'jetpack' ), + 'items_list' => __( 'Menu section list', 'jetpack' ), + ), + 'rewrite' => array( + 'slug' => 'menu', + 'with_front' => false, + 'hierarchical' => true, + ), + 'hierarchical' => true, + 'show_tagcloud' => false, + 'query_var' => 'menu', + ) + ); + } + } + + /** + * Register our Post Type. + */ + private function register_post_types() { + if ( post_type_exists( self::MENU_ITEM_POST_TYPE ) ) { + return; + } + + register_post_type( + self::MENU_ITEM_POST_TYPE, + array( + 'description' => __( "Items on your restaurant's menu", 'jetpack' ), + + 'labels' => array( /* translators: this is about a food menu */ - 'name' => __( 'Menu Sections', 'jetpack' ), + 'name' => __( 'Menu Items', 'jetpack' ), /* translators: this is about a food menu */ - 'singular_name' => __( 'Menu Section', 'jetpack' ), + 'singular_name' => __( 'Menu Item', 'jetpack' ), /* translators: this is about a food menu */ - 'search_items' => __( 'Search Menu Sections', 'jetpack' ), + 'menu_name' => __( 'Food Menus', 'jetpack' ), /* translators: this is about a food menu */ - 'all_items' => __( 'All Menu Sections', 'jetpack' ), + 'all_items' => __( 'Menu Items', 'jetpack' ), /* translators: this is about a food menu */ - 'parent_item' => __( 'Parent Menu Section', 'jetpack' ), + 'add_new' => __( 'Add One Item', 'jetpack' ), /* translators: this is about a food menu */ - 'parent_item_colon' => __( 'Parent Menu Section:', 'jetpack' ), + 'add_new_item' => __( 'Add Menu Item', 'jetpack' ), /* translators: this is about a food menu */ - 'edit_item' => __( 'Edit Menu Section', 'jetpack' ), + 'edit_item' => __( 'Edit Menu Item', 'jetpack' ), /* translators: this is about a food menu */ - 'view_item' => __( 'View Menu Section', 'jetpack' ), + 'new_item' => __( 'New Menu Item', 'jetpack' ), /* translators: this is about a food menu */ - 'update_item' => __( 'Update Menu Section', 'jetpack' ), + 'view_item' => __( 'View Menu Item', 'jetpack' ), /* translators: this is about a food menu */ - 'add_new_item' => __( 'Add New Menu Section', 'jetpack' ), + 'search_items' => __( 'Search Menu Items', 'jetpack' ), /* translators: this is about a food menu */ - 'new_item_name' => __( 'New Menu Sections Name', 'jetpack' ), - 'items_list_navigation' => __( 'Menu section list navigation', 'jetpack' ), - 'items_list' => __( 'Menu section list', 'jetpack' ), + 'not_found' => __( 'No Menu Items found', 'jetpack' ), + /* translators: this is about a food menu */ + 'not_found_in_trash' => __( 'No Menu Items found in Trash', 'jetpack' ), + 'filter_items_list' => __( 'Filter menu items list', 'jetpack' ), + 'items_list_navigation' => __( 'Menu item list navigation', 'jetpack' ), + 'items_list' => __( 'Menu items list', 'jetpack' ), ), - 'rewrite' => array( - 'slug' => 'menu', - 'with_front' => false, - 'hierarchical' => true, + 'supports' => array( + 'title', + 'editor', + 'thumbnail', + 'excerpt', ), - 'hierarchical' => true, - 'show_tagcloud' => false, - 'query_var' => 'menu', - ) ); - } - } - - function register_post_types() { - if ( post_type_exists( self::MENU_ITEM_POST_TYPE ) ) { - return; - } - - register_post_type( self::MENU_ITEM_POST_TYPE, array( - 'description' => __( "Items on your restaurant's menu", 'jetpack' ), - - 'labels' => array( - /* translators: this is about a food menu */ - 'name' => __( 'Menu Items', 'jetpack' ), - /* translators: this is about a food menu */ - 'singular_name' => __( 'Menu Item', 'jetpack' ), - /* translators: this is about a food menu */ - 'menu_name' => __( 'Food Menus', 'jetpack' ), - /* translators: this is about a food menu */ - 'all_items' => __( 'Menu Items', 'jetpack' ), - /* translators: this is about a food menu */ - 'add_new' => __( 'Add One Item', 'jetpack' ), - /* translators: this is about a food menu */ - 'add_new_item' => __( 'Add Menu Item', 'jetpack' ), - /* translators: this is about a food menu */ - 'edit_item' => __( 'Edit Menu Item', 'jetpack' ), - /* translators: this is about a food menu */ - 'new_item' => __( 'New Menu Item', 'jetpack' ), - /* translators: this is about a food menu */ - 'view_item' => __( 'View Menu Item', 'jetpack' ), - /* translators: this is about a food menu */ - 'search_items' => __( 'Search Menu Items', 'jetpack' ), - /* translators: this is about a food menu */ - 'not_found' => __( 'No Menu Items found', 'jetpack' ), - /* translators: this is about a food menu */ - 'not_found_in_trash' => __( 'No Menu Items found in Trash', 'jetpack' ), - 'filter_items_list' => __( 'Filter menu items list', 'jetpack' ), - 'items_list_navigation' => __( 'Menu item list navigation', 'jetpack' ), - 'items_list' => __( 'Menu items list', 'jetpack' ), - ), - 'supports' => array( - 'title', - 'editor', - 'thumbnail', - 'excerpt', - ), - 'rewrite' => array( - 'slug' => 'item', - 'with_front' => false, - 'feeds' => false, - 'pages' => false, - ), - 'register_meta_box_cb' => array( $this, 'register_menu_item_meta_boxes' ), - - 'public' => true, - 'show_ui' => true, // set to false to replace with custom UI - 'menu_position' => 20, // below Pages - 'capability_type' => 'page', - 'map_meta_cap' => true, - 'has_archive' => false, - 'query_var' => 'item', - ) ); + 'rewrite' => array( + 'slug' => 'item', + 'with_front' => false, + 'feeds' => false, + 'pages' => false, + ), + 'register_meta_box_cb' => array( $this, 'register_menu_item_meta_boxes' ), + + 'public' => true, + 'show_ui' => true, // set to false to replace with custom UI + 'menu_position' => 20, // below Pages + 'capability_type' => 'page', + 'map_meta_cap' => true, + 'has_archive' => false, + 'query_var' => 'item', + ) + ); } - /** * Update messages for the Menu Item admin. + * + * @param array $messages Existing post update messages. + * + * @return array $messages Updated post update messages. */ - function updated_messages( $messages ) { + public function updated_messages( $messages ) { global $post; - $messages[self::MENU_ITEM_POST_TYPE] = array( + $messages[ self::MENU_ITEM_POST_TYPE ] = array( 0 => '', // Unused. Messages start at index 1. - /* translators: this is about a food menu */ - 1 => sprintf( __( 'Menu item updated. <a href="%s">View item</a>', 'jetpack' ), esc_url( get_permalink( $post->ID ) ) ), + 1 => sprintf( + /* translators: this is about a food menu. Placeholder is a link to the food menu. */ + __( 'Menu item updated. <a href="%s">View item</a>', 'jetpack' ), + esc_url( get_permalink( $post->ID ) ) + ), 2 => esc_html__( 'Custom field updated.', 'jetpack' ), 3 => esc_html__( 'Custom field deleted.', 'jetpack' ), /* translators: this is about a food menu */ 4 => esc_html__( 'Menu item updated.', 'jetpack' ), - /* translators: %s: date and time of the revision */ - 5 => isset( $_GET['revision'] ) ? sprintf( esc_html__( 'Menu item restored to revision from %s', 'jetpack' ), wp_post_revision_title( (int) $_GET['revision'], false ) ) : false, - /* translators: this is about a food menu */ - 6 => sprintf( __( 'Menu item published. <a href="%s">View item</a>', 'jetpack' ), esc_url( get_permalink( $post->ID ) ) ), + 5 => isset( $_GET['revision'] ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Copying core message handling. + ? sprintf( + /* translators: %s: date and time of the revision */ + esc_html__( 'Menu item restored to revision from %s', 'jetpack' ), + wp_post_revision_title( (int) $_GET['revision'], false ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Copying core message handling. + ) + : false, + 6 => sprintf( + /* translators: this is about a food menu. Placeholder is a link to the food menu. */ + __( 'Menu item published. <a href="%s">View item</a>', 'jetpack' ), + esc_url( get_permalink( $post->ID ) ) + ), /* translators: this is about a food menu */ 7 => esc_html__( 'Menu item saved.', 'jetpack' ), - /* translators: this is about a food menu */ - 8 => sprintf( __( 'Menu item submitted. <a target="_blank" href="%s">Preview item</a>', 'jetpack' ), esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) ), - /* translators: this is about a food menu */ - 9 => sprintf( __( 'Menu item scheduled for: <strong>%1$s</strong>. <a target="_blank" href="%2$s">Preview item</a>', 'jetpack' ), - // translators: Publish box date format, see https://php.net/date - date_i18n( __( 'M j, Y @ G:i', 'jetpack' ), strtotime( $post->post_date ) ), esc_url( get_permalink($post->ID) ) ), - /* translators: this is about a food menu */ - 10 => sprintf( __( 'Menu item draft updated. <a target="_blank" href="%s">Preview item</a>', 'jetpack' ), esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) ), + 8 => sprintf( + /* translators: this is about a food menu */ + __( 'Menu item submitted. <a target="_blank" href="%s">Preview item</a>', 'jetpack' ), + esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) + ), + 9 => sprintf( + /* translators: this is about a food menu. 1. Publish box date format, see https://php.net/date 2. link to the food menu. */ + __( 'Menu item scheduled for: <strong>%1$s</strong>. <a target="_blank" href="%2$s">Preview item</a>', 'jetpack' ), + /* translators: Publish box date format, see https://php.net/date */ + date_i18n( __( 'M j, Y @ G:i', 'jetpack' ), strtotime( $post->post_date ) ), + esc_url( get_permalink( $post->ID ) ) + ), + 10 => sprintf( + /* translators: this is about a food menu. Placeholder is a link to the food menu. */ + __( 'Menu item draft updated. <a target="_blank" href="%s">Preview item</a>', 'jetpack' ), + esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) + ), ); return $messages; } - /** - * Nova Styles and Scripts + * Nova styles and scripts. + * + * @param string $hook Page hook. + * + * @return void */ - function enqueue_nova_styles( $hook ) { + public function enqueue_nova_styles( $hook ) { global $post_type; $pages = array( 'edit.php', 'post.php', 'post-new.php' ); - if ( in_array( $hook, $pages ) && $post_type == self::MENU_ITEM_POST_TYPE ) { - wp_enqueue_style( 'nova-style', plugins_url( 'css/nova.css', __FILE__ ), array(), $this->version ); + if ( in_array( $hook, $pages, true ) && $post_type === self::MENU_ITEM_POST_TYPE ) { + wp_enqueue_style( 'nova-style', plugins_url( 'css/nova.css', __FILE__ ), array(), $this->version ); } - wp_enqueue_style( 'nova-font', plugins_url( 'css/nova-font.css', __FILE__ ), array(), $this->version ); + wp_enqueue_style( 'nova-font', plugins_url( 'css/nova-font.css', __FILE__ ), array(), $this->version ); } - /** * Change ‘Enter Title Here’ text for the Menu Item. + * + * @param string $title Default title placeholder text. + * + * @return string */ - function change_default_title( $title ) { - if ( self::MENU_ITEM_POST_TYPE == get_post_type() ) { + public function change_default_title( $title ) { + if ( self::MENU_ITEM_POST_TYPE === get_post_type() ) { /* translators: this is about a food menu */ $title = esc_html__( "Enter the menu item's name here", 'jetpack' ); } @@ -322,11 +406,12 @@ class Nova_Restaurant { return $title; } - /** * Add to Dashboard At A Glance + * + * @return void */ - function add_to_dashboard() { + public function add_to_dashboard() { $number_menu_items = wp_count_posts( self::MENU_ITEM_POST_TYPE ); if ( current_user_can( 'administrator' ) ) { @@ -365,18 +450,21 @@ class Nova_Restaurant { ); } - echo '<li class="nova-menu-count">' . $number_menu_items_published . '</li>'; + echo '<li class="nova-menu-count">' . $number_menu_items_published . '</li>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- we escape things above. } - /** - * Query + * If the WP query for our menu items. + * + * @param WP_Query $query WP Query. + * + * @return bool */ - function is_menu_item_query( $query ) { + private function is_menu_item_query( $query ) { if ( - ( isset( $query->query_vars['taxonomy'] ) && self::MENU_TAX == $query->query_vars['taxonomy'] ) + ( isset( $query->query_vars['taxonomy'] ) && self::MENU_TAX === $query->query_vars['taxonomy'] ) || - ( isset( $query->query_vars['post_type'] ) && self::MENU_ITEM_POST_TYPE == $query->query_vars['post_type'] ) + ( isset( $query->query_vars['post_type'] ) && self::MENU_ITEM_POST_TYPE === $query->query_vars['post_type'] ) ) { return true; } @@ -384,25 +472,40 @@ class Nova_Restaurant { return false; } - function sort_menu_item_queries_by_menu_order( $query ) { + /** + * Custom sort the menu item queries by menu order. + * + * @param WP_Query $query WP Query. + * + * @return void + */ + public function sort_menu_item_queries_by_menu_order( $query ) { if ( ! $this->is_menu_item_query( $query ) ) { return; } $query->query_vars['orderby'] = 'menu_order'; - $query->query_vars['order'] = 'ASC'; + $query->query_vars['order'] = 'ASC'; // For now, just turn off paging so we can sort by taxonmy later // If we want paging in the future, we'll need to add the taxonomy sort here (or at least before the DB query is made) $query->query_vars['posts_per_page'] = -1; } - function sort_menu_item_queries_by_menu_taxonomy( $posts, $query ) { - if ( !$posts ) { + /** + * Custom sort the menu item queries by menu taxonomies. + * + * @param WP_Post[] $posts Array of post objects. + * @param WP_Query $query The WP_Query instance. + * + * @return WP_Post[] + */ + public function sort_menu_item_queries_by_menu_taxonomy( $posts, $query ) { + if ( ! $posts ) { return $posts; } - if ( !$this->is_menu_item_query( $query ) ) { + if ( ! $this->is_menu_item_query( $query ) ) { return $posts; } @@ -410,26 +513,26 @@ class Nova_Restaurant { foreach ( $posts as $post ) { $term = $this->get_menu_item_menu_leaf( $post->ID ); - if ( !$term || is_wp_error( $term ) ) { + if ( ! $term || is_wp_error( $term ) ) { $term_id = 0; } else { $term_id = $term->term_id; } - if ( !isset( $grouped_by_term["$term_id"] ) ) { - $grouped_by_term["$term_id"] = array(); + if ( ! isset( $grouped_by_term[ "$term_id" ] ) ) { + $grouped_by_term[ "$term_id" ] = array(); } - $grouped_by_term["$term_id"][] = $post; + $grouped_by_term[ "$term_id" ][] = $post; } $term_order = get_option( 'nova_menu_order', array() ); $return = array(); foreach ( $term_order as $term_id ) { - if ( isset( $grouped_by_term["$term_id"] ) ) { - $return = array_merge( $return, $grouped_by_term["$term_id"] ); - unset( $grouped_by_term["$term_id"] ); + if ( isset( $grouped_by_term[ "$term_id" ] ) ) { + $return = array_merge( $return, $grouped_by_term[ "$term_id" ] ); + unset( $grouped_by_term[ "$term_id" ] ); } } @@ -440,11 +543,12 @@ class Nova_Restaurant { return $return; } - /** - * Add Many Items + * Add new "Add many items" submenu, custom colunmns, and custom bulk actions. + * + * @return void */ - function add_admin_menus() { + public function add_admin_menus() { $hook = add_submenu_page( 'edit.php?post_type=' . self::MENU_ITEM_POST_TYPE, __( 'Add Many Items', 'jetpack' ), @@ -454,17 +558,21 @@ class Nova_Restaurant { array( $this, 'add_many_new_items_page' ) ); - add_action( "load-$hook", array( $this, 'add_many_new_items_page_load' ) ); + add_action( "load-$hook", array( $this, 'add_many_new_items_page_load' ) ); add_action( 'current_screen', array( $this, 'current_screen_load' ) ); - //Adjust 'Add Many Items' submenu position - if ( isset( $GLOBALS['submenu']['edit.php?post_type=' . self::MENU_ITEM_POST_TYPE] ) ) { - $submenu_item = array_pop( $GLOBALS['submenu']['edit.php?post_type=' . self::MENU_ITEM_POST_TYPE] ); - $GLOBALS['submenu']['edit.php?post_type=' . self::MENU_ITEM_POST_TYPE][11] = $submenu_item; - ksort( $GLOBALS['submenu']['edit.php?post_type=' . self::MENU_ITEM_POST_TYPE] ); + /* + * Adjust 'Add Many Items' submenu position + * We're making changes to the menu global, but no other choice unfortunately. + * phpcs:disable WordPress.WP.GlobalVariablesOverride.Prohibited + */ + if ( isset( $GLOBALS['submenu'][ 'edit.php?post_type=' . self::MENU_ITEM_POST_TYPE ] ) ) { + $submenu_item = array_pop( $GLOBALS['submenu'][ 'edit.php?post_type=' . self::MENU_ITEM_POST_TYPE ] ); + $GLOBALS['submenu'][ 'edit.php?post_type=' . self::MENU_ITEM_POST_TYPE ][11] = $submenu_item; + ksort( $GLOBALS['submenu'][ 'edit.php?post_type=' . self::MENU_ITEM_POST_TYPE ] ); } - + // phpcs:enable WordPress.WP.GlobalVariablesOverride.Prohibited $this->setup_menu_item_columns(); @@ -480,22 +588,28 @@ class Nova_Restaurant { ); } - /** * Custom Nova Icon CSS + * + * @return void */ - function set_custom_font_icon() { - ?> + public function set_custom_font_icon() { + ?> <style type="text/css"> #menu-posts-nova_menu_item .wp-menu-image:before { font-family: 'nova-font' !important; content: '\e603' !important; } </style> - <?php + <?php } - function current_screen_load() { + /** + * Load Nova menu management tools on the CPT admin screen. + * + * @return void + */ + public function current_screen_load() { $screen = get_current_screen(); if ( 'edit-nova_menu_item' !== $screen->id ) { return; @@ -505,90 +619,143 @@ class Nova_Restaurant { add_filter( 'admin_notices', array( $this, 'admin_notices' ) ); } -/* Edit Items List */ + /* Edit Items List */ - function admin_notices() { - if ( isset( $_GET['nova_reordered'] ) ) - /* translators: this is about a food menu */ - printf( '<div class="updated"><p>%s</p></div>', __( 'Menu Items re-ordered.', 'jetpack' ) ); + /** + * Display a notice in wp-admin after items have been changed. + * + * @return void + */ + public function admin_notices() { + if ( isset( $_GET['nova_reordered'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- this is only displaying a message with no dynamic values. + printf( + '<div class="updated"><p>%s</p></div>', + /* translators: this is about a food menu */ + esc_html__( 'Menu Items re-ordered.', 'jetpack' ) + ); + } } - function no_title_sorting( $columns ) { - if ( isset( $columns['title'] ) ) + /** + * Do not allow sorting by title. + * + * @param array $columns An array of sortable columns. + * + * @return array $columns. + */ + public function no_title_sorting( $columns ) { + if ( isset( $columns['title'] ) ) { unset( $columns['title'] ); + } return $columns; } - function setup_menu_item_columns() { + /** + * Set up custom columns for our Nova menu. + * + * @return void + */ + private function setup_menu_item_columns() { add_filter( sprintf( 'manage_edit-%s_sortable_columns', self::MENU_ITEM_POST_TYPE ), array( $this, 'no_title_sorting' ) ); add_filter( sprintf( 'manage_%s_posts_columns', self::MENU_ITEM_POST_TYPE ), array( $this, 'menu_item_columns' ) ); add_action( sprintf( 'manage_%s_posts_custom_column', self::MENU_ITEM_POST_TYPE ), array( $this, 'menu_item_column_callback' ), 10, 2 ); } - function menu_item_columns( $columns ) { + /** + * Add custom columns to the Nova menu item list. + * + * @param array $columns An array of columns. + * + * @return array $columns. + */ + public function menu_item_columns( $columns ) { unset( $columns['date'], $columns['likes'] ); $columns['thumbnail'] = __( 'Thumbnail', 'jetpack' ); - $columns['labels'] = __( 'Labels', 'jetpack' ); - $columns['price'] = __( 'Price', 'jetpack' ); - $columns['order'] = __( 'Order', 'jetpack' ); + $columns['labels'] = __( 'Labels', 'jetpack' ); + $columns['price'] = __( 'Price', 'jetpack' ); + $columns['order'] = __( 'Order', 'jetpack' ); return $columns; } - function menu_item_column_callback( $column, $post_id ) { + /** + * Display custom data in each new custom column we created. + * + * @param string $column The name of the column to display. + * @param int $post_id The current post ID. + * + * @return void + */ + public function menu_item_column_callback( $column, $post_id ) { $screen = get_current_screen(); switch ( $column ) { case 'thumbnail': echo get_the_post_thumbnail( $post_id, array( 50, 50 ) ); break; - case 'labels' : + case 'labels': $this->list_admin_labels( $post_id ); break; - case 'price' : + case 'price': $this->display_price( $post_id ); break; - case 'order' : + case 'order': $url = admin_url( $screen->parent_file ); - $up_url = add_query_arg( array( - 'action' => 'move-item-up', - 'post_id' => (int) $post_id, - ), wp_nonce_url( $url, 'nova_move_item_up_' . $post_id ) ); + $up_url = add_query_arg( + array( + 'action' => 'move-item-up', + 'post_id' => (int) $post_id, + ), + wp_nonce_url( $url, 'nova_move_item_up_' . $post_id ) + ); - $down_url = add_query_arg( array( - 'action' => 'move-item-down', - 'post_id' => (int) $post_id, - ), wp_nonce_url( $url, 'nova_move_item_down_' . $post_id ) ); - $menu_item = get_post($post_id); + $down_url = add_query_arg( + array( + 'action' => 'move-item-down', + 'post_id' => (int) $post_id, + ), + wp_nonce_url( $url, 'nova_move_item_down_' . $post_id ) + ); + $menu_item = get_post( $post_id ); $this->get_menu_by_post_id( $post_id ); - if ( $term_id = $this->get_menu_by_post_id( $post_id ) ) { + $term_id = $this->get_menu_by_post_id( $post_id ); + if ( $term_id ) { $term_id = $term_id->term_id; } - ?> - <input type="hidden" class="menu-order-value" name="nova_order[<?php echo (int) $post_id ?>]" value="<?php echo esc_attr( $menu_item->menu_order ) ?>" /> - <input type="hidden" class='nova-menu-term' name="nova_menu_term[<?php echo (int) $post_id ?>]" value="<?php echo esc_attr( $term_id ); ?>"> + ?> + <input type="hidden" class="menu-order-value" name="nova_order[<?php echo (int) $post_id; ?>]" value="<?php echo esc_attr( $menu_item->menu_order ); ?>" /> + <input type="hidden" class='nova-menu-term' name="nova_menu_term[<?php echo (int) $post_id; ?>]" value="<?php echo esc_attr( $term_id ); ?>"> <span class="hide-if-js"> — <a class="nova-move-item-up" data-post-id="<?php echo (int) $post_id; ?>" href="<?php echo esc_url( $up_url ); ?>">up</a> <br /> — <a class="nova-move-item-down" data-post-id="<?php echo (int) $post_id; ?>" href="<?php echo esc_url( $down_url ); ?>">down</a> </span> - <?php + <?php break; } } - function get_menu_by_post_id( $post_id = null ) { - if ( ! $post_id ) + /** + * Get menu item by post ID. + * + * @param int $post_id Post ID. + * + * @return bool|WP_Term + */ + private function get_menu_by_post_id( $post_id = null ) { + if ( ! $post_id ) { return false; + } $terms = get_the_terms( $post_id, self::MENU_TAX ); - if ( ! is_array( $terms ) ) + if ( ! is_array( $terms ) ) { return false; + } return array_pop( $terms ); } @@ -596,50 +763,78 @@ class Nova_Restaurant { /** * Fires on a menu edit page. We might have drag-n-drop reordered */ - function maybe_reorder_menu_items() { - // make sure we clicked our button - if ( ! ( isset( $_REQUEST['menu_reorder_submit'] ) && $_REQUEST['menu_reorder_submit'] === __( 'Save New Order', 'jetpack' ) ) ) + private function maybe_reorder_menu_items() { + // make sure we clicked our button. + if ( + empty( $_REQUEST['menu_reorder_submit'] ) + || __( 'Save New Order', 'jetpack' ) !== $_REQUEST['menu_reorder_submit'] + ) { return; - ; + } - // make sure we have the nonce - if ( ! ( isset( $_REQUEST['drag-drop-reorder'] ) && wp_verify_nonce( $_REQUEST['drag-drop-reorder'], 'drag-drop-reorder' ) ) ) + // make sure we have the nonce. + if ( + empty( $_REQUEST['drag-drop-reorder'] ) + || ! wp_verify_nonce( sanitize_key( $_REQUEST['drag-drop-reorder'] ), 'drag-drop-reorder' ) + ) { return; + } - $term_pairs = array_map( 'absint', $_REQUEST['nova_menu_term'] ); + // make sure we have data to work with. + if ( empty( $_REQUEST['nova_menu_term'] ) || empty( $_REQUEST['nova_order'] ) ) { + return; + } + + $term_pairs = array_map( 'absint', $_REQUEST['nova_menu_term'] ); $order_pairs = array_map( 'absint', $_REQUEST['nova_order'] ); - foreach( $order_pairs as $ID => $menu_order ) { - $ID = absint( $ID ); - unset( $order_pairs[$ID] ); - if ( $ID < 0 ) + foreach ( $order_pairs as $id => $menu_order ) { + $id = absint( $id ); + unset( $order_pairs[ $id ] ); + if ( $id < 0 ) { continue; + } - $post = get_post( $ID ); - if ( ! $post ) + $post = get_post( $id ); + if ( ! $post ) { continue; + } // save a write if the order hasn't changed - if ( $menu_order != $post->menu_order ) - wp_update_post( compact( 'ID', 'menu_order' ) ); + if ( (int) $menu_order !== $post->menu_order ) { + $args = array( + 'ID' => $id, + 'menu_order' => $menu_order, + ); + wp_update_post( $args ); + } // save a write if the term hasn't changed - if ( $term_pairs[$ID] != $this->get_menu_by_post_id( $ID )->term_id ) - wp_set_object_terms( $ID, $term_pairs[$ID], self::MENU_TAX ); - + if ( (int) $term_pairs[ $id ] !== $this->get_menu_by_post_id( $id )->term_id ) { + wp_set_object_terms( $id, $term_pairs[ $id ], self::MENU_TAX ); + } } - $redirect = add_query_arg( array( - 'post_type' => self::MENU_ITEM_POST_TYPE, - 'nova_reordered' => '1' - ), admin_url( 'edit.php' ) ); + $redirect = add_query_arg( + array( + 'post_type' => self::MENU_ITEM_POST_TYPE, + 'nova_reordered' => '1', + ), + admin_url( 'edit.php' ) + ); wp_safe_redirect( $redirect ); exit; } - function edit_menu_items_page_load() { - if ( isset( $_GET['action'] ) ) { + /** + * Handle changes to menu items. + * (process actions, update data, enqueue necessary scripts). + * + * @return void + */ + private function edit_menu_items_page_load() { + if ( isset( $_GET['action'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- we process the form and check nonces in handle_menu_item_actions. $this->handle_menu_item_actions(); } @@ -656,161 +851,191 @@ class Nova_Restaurant { true ); - wp_localize_script( 'nova-drag-drop', '_novaDragDrop', array( - 'nonce' => wp_create_nonce( 'drag-drop-reorder' ), - 'nonceName' => 'drag-drop-reorder', - 'reorder' => __( 'Save New Order', 'jetpack' ), - 'reorderName' => 'menu_reorder_submit' - ) ); + wp_localize_script( + 'nova-drag-drop', + '_novaDragDrop', + array( + 'nonce' => wp_create_nonce( 'drag-drop-reorder' ), + 'nonceName' => 'drag-drop-reorder', + 'reorder' => __( 'Save New Order', 'jetpack' ), + 'reorderName' => 'menu_reorder_submit', + ) + ); add_action( 'the_post', array( $this, 'show_menu_titles_in_menu_item_list' ) ); } - function handle_menu_item_actions() { - $action = (string) $_GET['action']; + /** + * Process actions to move menu items around. + * + * @return void + */ + private function handle_menu_item_actions() { + if ( isset( $_GET['action'] ) ) { + $action = (string) wp_unslash( $_GET['action'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- we check for nonces below, and check against specific strings in switch statement. + } else { + return; + } switch ( $action ) { - case 'move-item-up' : - case 'move-item-down' : - $reorder = false; - - $post_id = (int) $_GET['post_id']; + case 'move-item-up': + case 'move-item-down': + $reorder = false; - $term = $this->get_menu_item_menu_leaf( $post_id ); + if ( empty( $_GET['post_id'] ) ) { + break; + } - // Get all posts in that term - $query = new WP_Query( array( - 'taxonomy' => self::MENU_TAX, - 'term' => $term->slug, - ) ); + $post_id = (int) $_GET['post_id']; - $order = array(); - foreach ( $query->posts as $post ) { - $order[] = $post->ID; - } + $term = $this->get_menu_item_menu_leaf( $post_id ); - if ( 'move-item-up' == $action ) { - check_admin_referer( 'nova_move_item_up_' . $post_id ); + // Get all posts in that term. + $query = new WP_Query( + array( + 'taxonomy' => self::MENU_TAX, + 'term' => $term->slug, + ) + ); - $first_post_id = $order[0]; - if ( $post_id == $first_post_id ) { - break; + $order = array(); + foreach ( $query->posts as $post ) { + $order[] = $post->ID; } - foreach ( $order as $menu_order => $order_post_id ) { - if ( $post_id != $order_post_id ) { - continue; + if ( 'move-item-up' === $action ) { + check_admin_referer( 'nova_move_item_up_' . $post_id ); + + $first_post_id = $order[0]; + if ( $post_id === $first_post_id ) { + break; } - $swap_post_id = $order[$menu_order - 1]; - $order[$menu_order - 1] = $post_id; - $order[$menu_order] = $swap_post_id; + foreach ( $order as $menu_order => $order_post_id ) { + if ( $post_id !== $order_post_id ) { + continue; + } - $reorder = true; - break; - } - } else { - check_admin_referer( 'nova_move_item_down_' . $post_id ); + $swap_post_id = $order[ $menu_order - 1 ]; + $order[ $menu_order - 1 ] = $post_id; + $order[ $menu_order ] = $swap_post_id; - $last_post_id = end( $order ); - if ( $post_id == $last_post_id ) { - break; - } + $reorder = true; + break; + } + } else { + check_admin_referer( 'nova_move_item_down_' . $post_id ); - foreach ( $order as $menu_order => $order_post_id ) { - if ( $post_id != $order_post_id ) { - continue; + $last_post_id = end( $order ); + if ( $post_id === $last_post_id ) { + break; } - $swap_post_id = $order[$menu_order + 1]; - $order[$menu_order + 1] = $post_id; - $order[$menu_order] = $swap_post_id; + foreach ( $order as $menu_order => $order_post_id ) { + if ( $post_id !== $order_post_id ) { + continue; + } - $reorder = true; - } - } + $swap_post_id = $order[ $menu_order + 1 ]; + $order[ $menu_order + 1 ] = $post_id; + $order[ $menu_order ] = $swap_post_id; - if ( $reorder ) { - foreach ( $order as $menu_order => $ID ) { - wp_update_post( compact( 'ID', 'menu_order' ) ); + $reorder = true; + } } - } - break; - case 'move-menu-up' : - case 'move-menu-down' : - $reorder = false; + if ( $reorder ) { + foreach ( $order as $menu_order => $id ) { + wp_update_post( compact( 'id', 'menu_order' ) ); + } + } - $term_id = (int) $_GET['term_id']; + break; + case 'move-menu-up': + case 'move-menu-down': + $reorder = false; - $terms = $this->get_menus(); + if ( empty( $_GET['term_id'] ) ) { + break; + } - $order = array(); - foreach ( $terms as $term ) { - $order[] = $term->term_id; - } + $term_id = (int) $_GET['term_id']; - if ( 'move-menu-up' == $action ) { - check_admin_referer( 'nova_move_menu_up_' . $term_id ); + $terms = $this->get_menus(); - $first_term_id = $order[0]; - if ( $term_id == $first_term_id ) { - break; + $order = array(); + foreach ( $terms as $term ) { + $order[] = $term->term_id; } - foreach ( $order as $menu_order => $order_term_id ) { - if ( $term_id != $order_term_id ) { - continue; + if ( 'move-menu-up' === $action ) { + check_admin_referer( 'nova_move_menu_up_' . $term_id ); + + $first_term_id = $order[0]; + if ( $term_id === $first_term_id ) { + break; } - $swap_term_id = $order[$menu_order - 1]; - $order[$menu_order - 1] = $term_id; - $order[$menu_order] = $swap_term_id; + foreach ( $order as $menu_order => $order_term_id ) { + if ( $term_id !== $order_term_id ) { + continue; + } - $reorder = true; - break; - } - } else { - check_admin_referer( 'nova_move_menu_down_' . $term_id ); + $swap_term_id = $order[ $menu_order - 1 ]; + $order[ $menu_order - 1 ] = $term_id; + $order[ $menu_order ] = $swap_term_id; - $last_term_id = end( $order ); - if ( $term_id == $last_term_id ) { - break; - } + $reorder = true; + break; + } + } else { + check_admin_referer( 'nova_move_menu_down_' . $term_id ); - foreach ( $order as $menu_order => $order_term_id ) { - if ( $term_id != $order_term_id ) { - continue; + $last_term_id = end( $order ); + if ( $term_id === $last_term_id ) { + break; } - $swap_term_id = $order[$menu_order + 1]; - $order[$menu_order + 1] = $term_id; - $order[$menu_order] = $swap_term_id; + foreach ( $order as $menu_order => $order_term_id ) { + if ( $term_id !== $order_term_id ) { + continue; + } - $reorder = true; + $swap_term_id = $order[ $menu_order + 1 ]; + $order[ $menu_order + 1 ] = $term_id; + $order[ $menu_order ] = $swap_term_id; + + $reorder = true; + } } - } - if ( $reorder ) { - update_option( 'nova_menu_order', $order ); - } + if ( $reorder ) { + update_option( 'nova_menu_order', $order ); + } - break; - default : - return; + break; + default: + return; } - $redirect = add_query_arg( array( - 'post_type' => self::MENU_ITEM_POST_TYPE, - 'nova_reordered' => '1' - ), admin_url( 'edit.php' ) ); + $redirect = add_query_arg( + array( + 'post_type' => self::MENU_ITEM_POST_TYPE, + 'nova_reordered' => '1', + ), + admin_url( 'edit.php' ) + ); wp_safe_redirect( $redirect ); exit; } - /* + /** * Add menu title rows to the list table + * + * @param WP_Post $post The Post object. + * + * @return void */ - function show_menu_titles_in_menu_item_list( $post ) { + public function show_menu_titles_in_menu_item_list( $post ) { global $wp_list_table; static $last_term_id = false; @@ -823,13 +1048,13 @@ class Nova_Restaurant { return; } - if ( is_null( $term_id ) ) { + if ( $term_id === null ) { $last_term_id = null; - $term_name = ''; + $term_name = ''; $parent_count = 0; } else { $last_term_id = $term->term_id; - $term_name = $term->name; + $term_name = $term->name; $parent_count = 0; $current_term = $term; while ( $current_term->parent ) { @@ -844,46 +1069,63 @@ class Nova_Restaurant { $url = admin_url( $screen->parent_file ); - $up_url = add_query_arg( array( - 'action' => 'move-menu-up', - 'term_id' => (int) $term_id, - ), wp_nonce_url( $url, 'nova_move_menu_up_' . $term_id ) ); + $up_url = add_query_arg( + array( + 'action' => 'move-menu-up', + 'term_id' => (int) $term_id, + ), + wp_nonce_url( $url, 'nova_move_menu_up_' . $term_id ) + ); - $down_url = add_query_arg( array( - 'action' => 'move-menu-down', - 'term_id' => (int) $term_id, - ), wp_nonce_url( $url, 'nova_move_menu_down_' . $term_id ) ); + $down_url = add_query_arg( + array( + 'action' => 'move-menu-down', + 'term_id' => (int) $term_id, + ), + wp_nonce_url( $url, 'nova_move_menu_down_' . $term_id ) + ); -?> - <tr class="no-items menu-label-row" data-term_id="<?php echo esc_attr( $term_id ) ?>"> + ?> + <tr class="no-items menu-label-row" data-term_id="<?php echo esc_attr( $term_id ); ?>"> <td class="colspanchange" colspan="<?php echo (int) $non_order_column_count; ?>"> - <h3><?php - echo str_repeat( ' — ', (int) $parent_count ); + <h3> + <?php + echo str_repeat( ' — ', (int) $parent_count ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- nothing to escape here. - if ( $term instanceof WP_Term ) { - echo esc_html( sanitize_term_field( 'name', $term_name, $term_id, self::MENU_TAX, 'display' ) ); - edit_term_link( __( 'edit', 'jetpack' ), '<span class="edit-nova-section"><span class="dashicon dashicon-edit"></span>', '</span>', $term ); + if ( $term instanceof WP_Term ) { + echo esc_html( sanitize_term_field( 'name', $term_name, $term_id, self::MENU_TAX, 'display' ) ); + edit_term_link( __( 'edit', 'jetpack' ), '<span class="edit-nova-section"><span class="dashicon dashicon-edit"></span>', '</span>', $term ); - } else { - _e( 'Uncategorized' , 'jetpack' ); - } - ?></h3> + } else { + esc_html_e( 'Uncategorized', 'jetpack' ); + } + ?> + </h3> </td> <td> <?php if ( $term instanceof WP_Term ) { ?> - <a class="nova-move-menu-up" title="<?php esc_attr_e( 'Move menu section up', 'jetpack' ); ?>" href="<?php echo esc_url( $up_url ); ?>"><?php esc_html_e( 'UP', 'jetpack' ); ?></a> + <a class="nova-move-menu-up" title="<?php esc_attr_e( 'Move menu section up', 'jetpack' ); ?>" href="<?php echo esc_url( $up_url ); ?>"><?php echo esc_html_x( 'UP', 'indicates movement (up or down)', 'jetpack' ); ?></a> <br /> - <a class="nova-move-menu-down" title="<?php esc_attr_e( 'Move menu section down', 'jetpack' ); ?>" href="<?php echo esc_url( $down_url ); ?>"><?php esc_html_e( 'DOWN', 'jetpack' ); ?></a> + <a class="nova-move-menu-down" title="<?php esc_attr_e( 'Move menu section down', 'jetpack' ); ?>" href="<?php echo esc_url( $down_url ); ?>"><?php echo esc_html_x( 'DOWN', 'indicates movement (up or down)', 'jetpack' ); ?></a> <?php } ?> </td> </tr> -<?php + <?php } -/* Edit Many Items */ + /* Edit Many Items */ - function add_many_new_items_page_load() { - if ( 'POST' === strtoupper( $_SERVER['REQUEST_METHOD'] ) ) { + /** + * Handle form submissions that aim to add many menu items at once. + * (process posted data and enqueue necessary script). + * + * @return void + */ + public function add_many_new_items_page_load() { + if ( + isset( $_SERVER['REQUEST_METHOD'] ) + && 'POST' === strtoupper( sanitize_text_field( wp_unslash( $_SERVER['REQUEST_METHOD'] ) ) ) + ) { $this->process_form_request(); exit; } @@ -891,7 +1133,12 @@ class Nova_Restaurant { $this->enqueue_many_items_scripts(); } - function enqueue_many_items_scripts() { + /** + * Enqueue script to create many items at once. + * + * @return void + */ + public function enqueue_many_items_scripts() { wp_enqueue_script( 'nova-many-items', Assets::get_file_url_for_environment( @@ -904,12 +1151,17 @@ class Nova_Restaurant { ); } - function process_form_request() { - if ( !isset( $_POST['nova_title'] ) || !is_array( $_POST['nova_title'] ) ) { + /** + * Process form request to create many items at once. + * + * @return void + */ + private function process_form_request() { + if ( ! isset( $_POST['nova_title'] ) || ! is_array( $_POST['nova_title'] ) ) { return; } - $is_ajax = !empty( $_POST['ajax'] ); + $is_ajax = ! empty( $_POST['ajax'] ); if ( $is_ajax ) { check_ajax_referer( 'nova_many_items' ); @@ -917,37 +1169,54 @@ class Nova_Restaurant { check_admin_referer( 'nova_many_items' ); } - foreach ( array_keys( $_POST['nova_title'] ) as $key ) : - // $_POST is already slashed + /* + * $_POST is already slashed + * phpcs:disable WordPress.Security.ValidatedSanitizedInput.MissingUnslash + */ + foreach ( array_keys( $_POST['nova_title'] ) as $key ) : // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- we sanitize below. $post_details = array( 'post_status' => 'publish', 'post_type' => self::MENU_ITEM_POST_TYPE, - 'post_content' => $_POST['nova_content'][$key], - 'post_title' => $_POST['nova_title'][$key], + 'post_content' => ! empty( $_POST['nova_content'] ) && ! empty( $_POST['nova_content'][ $key ] ) + ? sanitize_text_field( $_POST['nova_content'][ $key ] ) + : '', + 'post_title' => isset( $_POST['nova_title'][ $key ] ) + ? sanitize_title( $_POST['nova_title'][ $key ] ) + : '', 'tax_input' => array( - self::MENU_ITEM_LABEL_TAX => $_POST['nova_labels'][$key], - self::MENU_TAX => isset( $_POST['nova_menu_tax'] ) ? $_POST['nova_menu_tax'] : null, + self::MENU_ITEM_LABEL_TAX => isset( $_POST['nova_labels'][ $key ] ) + ? sanitize_meta( self::MENU_ITEM_LABEL_TAX, $_POST['nova_labels'][ $key ], 'term' ) + : null, + self::MENU_TAX => isset( $_POST['nova_menu_tax'] ) + ? sanitize_meta( self::MENU_TAX, $_POST['nova_menu_tax'], 'term' ) + : null, ), ); $post_id = wp_insert_post( $post_details ); - if ( !$post_id || is_wp_error( $post_id ) ) { + if ( ! $post_id || is_wp_error( $post_id ) ) { continue; } - $this->set_price( $post_id, isset( $_POST['nova_price'][$key] ) ? stripslashes( $_POST['nova_price'][$key] ) : '' ); + $this->set_price( + $post_id, + isset( $_POST['nova_price'][ $key ] ) + ? sanitize_meta( 'nova_price', $_POST['nova_price'][ $key ], 'post' ) + : '' + ); + // phpcs:enable WordPress.Security.ValidatedSanitizedInput.MissingUnslash if ( $is_ajax ) : - $post = get_post( $post_id ); - $GLOBALS['post'] = $post; + $post = get_post( $post_id ); + $GLOBALS['post'] = $post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited setup_postdata( $post ); -?> + ?> <td><?php the_title(); ?></td> <td class="nova-price"><?php $this->display_price(); ?></td> <td><?php $this->list_labels( $post_id ); ?></td> <td><?php the_content(); ?></td> -<?php + <?php endif; endforeach; @@ -960,28 +1229,59 @@ class Nova_Restaurant { exit; } - function add_many_new_items_page() { -?> + /** + * Admin page contents for adding many menu items at once. + * + * @return void + */ + public function add_many_new_items_page() { + ?> <div class="wrap"> <h2><?php esc_html_e( 'Add Many Items', 'jetpack' ); ?></h2> - <p><?php _e( 'Use the <kbd>TAB</kbd> key on your keyboard to move between colums and the <kbd>ENTER</kbd> or <kbd>RETURN</kbd> key to save each row and move on to the next.', 'jetpack' ); ?></p> + <p> + <?php + echo wp_kses( + __( 'Use the <kbd>TAB</kbd> key on your keyboard to move between colums and the <kbd>ENTER</kbd> or <kbd>RETURN</kbd> key to save each row and move on to the next.', 'jetpack' ), + array( + 'kbd' => array(), + ) + ); + ?> + </p> <form method="post" action="" enctype="multipart/form-data"> - <p><h3><?php esc_html_e( 'Add to section:', 'jetpack' ); ?> <?php wp_dropdown_categories( array( - 'id' => 'nova-menu-tax', - 'name' => 'nova_menu_tax', - 'taxonomy' => self::MENU_TAX, - 'hide_empty' => false, - 'hierarchical' => true, - ) ); ?></h3></p> + <p> + <h3><?php esc_html_e( 'Add to section:', 'jetpack' ); ?> + <?php + wp_dropdown_categories( + array( + 'id' => 'nova-menu-tax', + 'name' => 'nova_menu_tax', + 'taxonomy' => self::MENU_TAX, + 'hide_empty' => false, + 'hierarchical' => true, + ) + ); + ?> + </h3></p> <table class="many-items-table wp-list-table widefat"> <thead> <tr> <th scope="col"><?php esc_html_e( 'Name', 'jetpack' ); ?></th> <th scope="col" class="nova-price"><?php esc_html_e( 'Price', 'jetpack' ); ?></th> - <th scope="col"><?php _e( 'Labels: <small>spicy, favorite, etc. <em>Separate Labels with commas</em></small>', 'jetpack' ); ?></th> + <th scope="col"> + <?php + echo wp_kses( + __( 'Labels: <small>spicy, favorite, etc. <em>Separate Labels with commas</em></small>', 'jetpack' ), + array( + 'small' => array(), + 'em' => array(), + ) + ); + ?> + </th> <th scope="col"><?php esc_html_e( 'Description', 'jetpack' ); ?></th> </tr> </thead> @@ -1003,7 +1303,7 @@ class Nova_Restaurant { </tbody> <tfoot> <tr> - <th><a class="button button-secondary nova-new-row"><span class="dashicon dashicon-plus"></span> <?php esc_html_e( 'New Row' , 'jetpack' ); ?></a></th> + <th><a class="button button-secondary nova-new-row"><span class="dashicon dashicon-plus"></span> <?php esc_html_e( 'New Row', 'jetpack' ); ?></a></th> <th class="nova-price"></th> <th></th> <th></th> @@ -1017,57 +1317,96 @@ class Nova_Restaurant { </p> </form> </div> -<?php + <?php } -/* Edit One Item */ + /* Edit One Item */ - function register_menu_item_meta_boxes() { + /** + * Create admin meta box to save price for a menu item, + * and add script to add extra checkboxes to the UI. + * + * @return void + */ + public function register_menu_item_meta_boxes() { wp_enqueue_script( 'nova-menu-checkboxes' ); - add_meta_box( 'menu_item_price', __( 'Price', 'jetpack' ), array( $this, 'menu_item_price_meta_box' ), null, 'side', 'high' ); + add_meta_box( + 'menu_item_price', + __( 'Price', 'jetpack' ), + array( $this, 'menu_item_price_meta_box' ), + null, + 'side', + 'high' + ); } - function menu_item_price_meta_box( $post, $meta_box ) { - $price = $this->get_price( $post->ID ); -?> - <label for="nova-price-<?php echo (int) $post->ID; ?>" class="screen-reader-text"><?php esc_html_e( 'Price', 'jetpack' ); ?></label> - <input type="text" id="nova-price-<?php echo (int) $post->ID; ?>" class="widefat" name="nova_price[<?php echo (int) $post->ID; ?>]" value="<?php echo esc_attr( $price ); ?>" /> -<?php + /** + * Meta box to edit the price of a menu item. + * + * @param WP_Post $post The post object. + * + * @return void + */ + public function menu_item_price_meta_box( $post ) { + printf( + '<label for="nova-price-%1$s" class="screen-reader-text">%2$s</label><input type="text" id="nova-price-%1$s" class="widefat" name="nova_price[%1$s]" value="%3$s" />', + (int) $post->ID, + esc_html__( 'Price', 'jetpack' ), + esc_attr( $this->get_price( (int) $post->ID ) ) + ); } - function add_post_meta( $post_id ) { - if ( !isset( $_POST['nova_price'][$post_id] ) ) { + /** + * Save the price of a menu item. + * + * @param int $post_id Post ID. + */ + public function add_post_meta( $post_id ) { + if ( ! isset( $_POST['nova_price'][ $post_id ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing -- nonce handling happens via core, since we hook into wp_insert_post. return; } - $this->set_price( $post_id, stripslashes( $_POST['nova_price'][$post_id] ) ); + $this->set_price( + $post_id, + sanitize_meta( 'nova_price', wp_unslash( $_POST['nova_price'][ $post_id ] ), 'post' ) // phpcs:ignore WordPress.Security.NonceVerification.Missing -- nonce handling happens via core, since we hook into wp_insert_post. + ); } -/* Data */ + /* Data */ - function get_menus( $args = array() ) { - $args = wp_parse_args( $args, array( - 'hide_empty' => false, - ) ); + /** + * Get ordered array of menu items. + * + * @param array $args Optional argumments. + * + * @return array + */ + private function get_menus( $args = array() ) { + $args = wp_parse_args( + $args, + array( + 'hide_empty' => false, + ) + ); $terms = get_terms( self::MENU_TAX, $args ); - if ( !$terms || is_wp_error( $terms ) ) { + if ( ! $terms || is_wp_error( $terms ) ) { return array(); } $terms_by_id = array(); foreach ( $terms as $term ) { - $terms_by_id["{$term->term_id}"] = $term; + $terms_by_id[ "{$term->term_id}" ] = $term; } $term_order = get_option( 'nova_menu_order', array() ); $return = array(); foreach ( $term_order as $term_id ) { - if ( isset( $terms_by_id["$term_id"] ) ) { - $return[] = $terms_by_id["$term_id"]; - unset( $terms_by_id["$term_id"] ); + if ( isset( $terms_by_id[ "$term_id" ] ) ) { + $return[] = $terms_by_id[ "$term_id" ]; + unset( $terms_by_id[ "$term_id" ] ); } } @@ -1078,8 +1417,15 @@ class Nova_Restaurant { return $return; } - function get_menu_item_menu_leaf( $post_id ) { - // Get first menu taxonomy "leaf" + /** + * Get first menu taxonomy "leaf". + * + * @param int $post_id Post ID. + * + * @return bool|WP_Term|WP_Error|null + */ + private function get_menu_item_menu_leaf( $post_id ) { + // Get first menu taxonomy "leaf". $term_ids = wp_get_object_terms( $post_id, self::MENU_TAX, array( 'fields' => 'ids' ) ); foreach ( $term_ids as $term_id ) { @@ -1097,54 +1443,100 @@ class Nova_Restaurant { } - function list_labels( $post_id = 0 ) { + /** + * Get a list of the labels linked to a menu item. + * + * @param int $post_id Post ID. + * + * @return void + */ + private function list_labels( $post_id = 0 ) { $post = get_post( $post_id ); echo get_the_term_list( $post->ID, self::MENU_ITEM_LABEL_TAX, '', _x( ', ', 'Nova label separator', 'jetpack' ), '' ); } - function list_admin_labels( $post_id = 0 ) { - $post = get_post( $post_id ); + /** + * Get a list of the labels linked to a menu item, with links to manage them. + * + * @param int $post_id Post ID. + * + * @return void + */ + private function list_admin_labels( $post_id = 0 ) { + $post = get_post( $post_id ); $labels = get_the_terms( $post->ID, self::MENU_ITEM_LABEL_TAX ); - if ( !empty( $labels ) ) { + if ( ! empty( $labels ) ) { $out = array(); foreach ( $labels as $label ) { - $out[] = sprintf( '<a href="%s">%s</a>', - esc_url( add_query_arg( array( - 'post_type' => self::MENU_ITEM_POST_TYPE, - 'taxonomy' => self::MENU_ITEM_LABEL_TAX, - 'term' => $label->slug - ), 'edit.php' ) ), - esc_html( sanitize_term_field( 'name', $label->name, $label->term_id, self::MENU_ITEM_LABEL_TAX, 'display' ) ) + $out[] = sprintf( + '<a href="%s">%s</a>', + esc_url( + add_query_arg( + array( + 'post_type' => self::MENU_ITEM_POST_TYPE, + 'taxonomy' => self::MENU_ITEM_LABEL_TAX, + 'term' => $label->slug, + ), + 'edit.php' + ) + ), + esc_html( + sanitize_term_field( 'name', $label->name, $label->term_id, self::MENU_ITEM_LABEL_TAX, 'display' ) + ) ); } - echo join( _x( ', ', 'Nova label separator', 'jetpack' ), $out ); + echo join( _x( ', ', 'Nova label separator', 'jetpack' ), $out ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- we build $out ourselves and escape things there. } else { esc_html_e( 'No Labels', 'jetpack' ); } } - function set_price( $post_id = 0, $price = '' ) { - $post = get_post( $post_id ); - - return update_post_meta( $post->ID, 'nova_price', $price ); + /** + * Update post meta with the price defined in meta box. + * + * @param int $post_id Post ID. + * @param string $price Price. + * + * @return int|bool + */ + private function set_price( $post_id = 0, $price = '' ) { + return update_post_meta( $post_id, 'nova_price', $price ); } - function get_price( $post_id = 0 ) { - $post = get_post( $post_id ); - - return get_post_meta( $post->ID, 'nova_price', true ); + /** + * Get the price of a menu item. + * + * @param int $post_id Post ID. + * + * @return bool|string + */ + private function get_price( $post_id = 0 ) { + return get_post_meta( $post_id, 'nova_price', true ); } - function display_price( $post_id = 0 ) { + /** + * Echo the price of a menu item. + * + * @param int $post_id Post ID. + * + * @return void + */ + private function display_price( $post_id = 0 ) { echo esc_html( $this->get_price( $post_id ) ); } -/* Menu Item Loop Markup */ - - /* Does not support nested loops */ + /* Menu Item Loop Markup */ - function get_menu_item_loop_markup( $field = null ) { + /** + * Get markup for a menu item. + * Note: Does not support nested loops. + * + * @param null|string $field The field to get the value for. + * + * @return array + */ + private function get_menu_item_loop_markup( $field = null ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable return $this->menu_item_loop_markup; } @@ -1153,10 +1545,11 @@ class Nova_Restaurant { * Attached to the 'template_include' *filter*, * which fires only during a real blog view (not in admin, feeds, etc.) * - * @param string Template File + * @param string $template Template File. + * * @return string Template File. VERY Important. */ - function setup_menu_item_loop_markup__in_filter( $template ) { + public function setup_menu_item_loop_markup__in_filter( $template ) { add_action( 'loop_start', array( $this, 'start_menu_item_loop' ) ); return $template; @@ -1166,10 +1559,12 @@ class Nova_Restaurant { * If the Query is a Menu Item Query, start outputing the Menu Item Loop Marku * Attached to the 'loop_start' action. * - * @param WP_Query + * @param WP_Query $query Post query. + * + * @return void */ - function start_menu_item_loop( $query ) { - if ( !$this->is_menu_item_query( $query ) ) { + public function start_menu_item_loop( $query ) { + if ( ! $this->is_menu_item_query( $query ) ) { return; } @@ -1184,9 +1579,11 @@ class Nova_Restaurant { * Outputs the Menu Item Loop Marku * Attached to the 'the_post' action. * - * @param WP_Post + * @param WP_Post $post Post object. + * + * @return void */ - function menu_item_loop_each_post( $post ) { + public function menu_item_loop_each_post( $post ) { $this->menu_item_loop_current_term = $this->get_menu_item_menu_leaf( $post->ID ); if ( false === $this->menu_item_loop_last_term_id ) { @@ -1194,7 +1591,7 @@ class Nova_Restaurant { $this->menu_item_loop_open_element( 'menu' ); // Start a new menu section $this->menu_item_loop_header(); // Output the menu's header - } elseif ( $this->menu_item_loop_last_term_id != $this->menu_item_loop_current_term->term_id ) { + } elseif ( $this->menu_item_loop_last_term_id !== $this->menu_item_loop_current_term->term_id ) { // We're not at the very beginning but still need to start a new menu section. End the previous menu section first. $this->menu_item_loop_close_element( 'menu' ); // End the previous menu section @@ -1209,10 +1606,12 @@ class Nova_Restaurant { * If the Query is a Menu Item Query, stop outputing the Menu Item Loop Marku * Attached to the 'loop_end' action. * - * @param WP_Query + * @param WP_Query $query Post query. + * + * @return void */ - function stop_menu_item_loop( $query ) { - if ( !$this->is_menu_item_query( $query ) ) { + public function stop_menu_item_loop( $query ) { + if ( ! $this->is_menu_item_query( $query ) ) { return; } @@ -1225,8 +1624,10 @@ class Nova_Restaurant { /** * Outputs the Menu Group Header + * + * @return void */ - function menu_item_loop_header() { + private function menu_item_loop_header() { $this->menu_item_loop_open_element( 'menu_header' ); $this->menu_item_loop_open_element( 'menu_title' ); echo esc_html( $this->menu_item_loop_current_term->name ); // @todo tax filter @@ -1243,8 +1644,10 @@ class Nova_Restaurant { * Outputs a Menu Item Markup element opening tag * * @param string $field - Menu Item Markup settings field. + * + * @return void */ - function menu_item_loop_open_element( $field ) { + private function menu_item_loop_open_element( $field ) { $markup = $this->get_menu_item_loop_markup(); /** * Filter a menu item's element opening tag. @@ -1258,9 +1661,9 @@ class Nova_Restaurant { * @param array $markup Array of markup elements for the menu item. * @param false|object $term Taxonomy term for current menu item. */ - echo apply_filters( + echo apply_filters( // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- it's escaped in menu_item_loop_class. 'jetpack_nova_menu_item_loop_open_element', - '<' . tag_escape( $markup["{$field}_tag"] ) . $this->menu_item_loop_class( $markup["{$field}_class"] ) . ">\n", + '<' . tag_escape( $markup[ "{$field}_tag" ] ) . $this->menu_item_loop_class( $markup[ "{$field}_class" ] ) . ">\n", $field, $markup, $this->menu_item_loop_current_term @@ -1270,9 +1673,11 @@ class Nova_Restaurant { /** * Outputs a Menu Item Markup element closing tag * - * @param string $field - Menu Item Markup settings field + * @param string $field - Menu Item Markup settings field. + * + * @return void */ - function menu_item_loop_close_element( $field ) { + private function menu_item_loop_close_element( $field ) { $markup = $this->get_menu_item_loop_markup(); /** * Filter a menu item's element closing tag. @@ -1286,9 +1691,9 @@ class Nova_Restaurant { * @param array $markup Array of markup elements for the menu item. * @param false|object $term Taxonomy term for current menu item. */ - echo apply_filters( + echo apply_filters( // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- tag_escape is used. 'jetpack_nova_menu_item_loop_close_element', - '</' . tag_escape( $markup["{$field}_tag"] ) . ">\n", + '</' . tag_escape( $markup[ "{$field}_tag" ] ) . ">\n", $field, $markup, $this->menu_item_loop_current_term @@ -1299,9 +1704,10 @@ class Nova_Restaurant { * Returns a Menu Item Markup element's class attribute. * * @param string $class Class name. - * @return string HTML class attribute with leading whitespace. + * + * @return string HTML class attribute with leading whitespace. */ - function menu_item_loop_class( $class ) { + private function menu_item_loop_class( $class ) { if ( ! $class ) { return ''; } |