diff options
Diffstat (limited to 'plugins/jetpack/modules/custom-post-types/portfolios.php')
| -rw-r--r-- | plugins/jetpack/modules/custom-post-types/portfolios.php | 942 |
1 files changed, 563 insertions, 379 deletions
diff --git a/plugins/jetpack/modules/custom-post-types/portfolios.php b/plugins/jetpack/modules/custom-post-types/portfolios.php index 2fda4bd7..2fc0432c 100644 --- a/plugins/jetpack/modules/custom-post-types/portfolios.php +++ b/plugins/jetpack/modules/custom-post-types/portfolios.php @@ -1,5 +1,13 @@ -<?php - +<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName +/** + * Register a portfolio post type and handle displaying it anywhere on the site. + * + * @package automattic/jetpack + */ + +/** + * Jetpack Portfolio. + */ class Jetpack_Portfolio { const CUSTOM_POST_TYPE = 'jetpack-portfolio'; const CUSTOM_TAXONOMY_TYPE = 'jetpack-portfolio-type'; @@ -7,13 +15,14 @@ class Jetpack_Portfolio { const OPTION_NAME = 'jetpack_portfolio'; const OPTION_READING_SETTING = 'jetpack_portfolio_posts_per_page'; - public $version = '0.1'; - - static function init() { + /** + * Initialize class. + */ + public static function init() { static $instance = false; if ( ! $instance ) { - $instance = new Jetpack_Portfolio; + $instance = new Jetpack_Portfolio(); } return $instance; @@ -25,72 +34,87 @@ class Jetpack_Portfolio { * Setup user option for enabling CPT * If user has CPT enabled, show in admin */ - function __construct() { - // Add an option to enable the CPT - add_action( 'admin_init', array( $this, 'settings_api_init' ) ); + public function __construct() { + // Add an option to enable the CPT. + add_action( 'admin_init', array( $this, 'settings_api_init' ) ); - // Check on theme switch if theme supports CPT and setting is disabled - add_action( 'after_switch_theme', array( $this, 'activation_post_type_support' ) ); + // Check on theme switch if theme supports CPT and setting is disabled. + add_action( 'after_switch_theme', array( $this, 'activation_post_type_support' ) ); - // Make sure the post types are loaded for imports - add_action( 'import_start', array( $this, 'register_post_types' ) ); + // Make sure the post types are loaded for imports. + add_action( 'import_start', array( $this, 'register_post_types' ) ); // Add to REST API post type allowed list. - add_filter( 'rest_api_allowed_post_types', array( $this, 'allow_portfolio_rest_api_type' ) ); + add_filter( 'rest_api_allowed_post_types', array( $this, 'allow_portfolio_rest_api_type' ) ); - $setting = Jetpack_Options::get_option_and_ensure_autoload( self::OPTION_NAME, '0' ); + // If called via REST API, we need to register later in lifecycle. + add_action( 'restapi_theme_init', array( $this, 'maybe_register_cpt' ) ); + + $this->maybe_register_cpt(); + } + + /** + * Registers the custom post types and adds action/filter handlers, but + * only if the site supports it + */ + public function maybe_register_cpt() { + if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { + $setting = get_option( self::OPTION_NAME, '0' ); + } else { + $setting = Jetpack_Options::get_option_and_ensure_autoload( self::OPTION_NAME, '0' ); + } - // Bail early if Portfolio option is not set and the theme doesn't declare support + // Bail early if Portfolio option is not set and the theme doesn't declare support. if ( empty( $setting ) && ! $this->site_supports_custom_post_type() ) { return; } - // CPT magic + // CPT magic. $this->register_post_types(); - add_action( sprintf( 'add_option_%s', self::OPTION_NAME ), array( $this, 'flush_rules_on_enable' ), 10 ); - add_action( sprintf( 'update_option_%s', self::OPTION_NAME ), array( $this, 'flush_rules_on_enable' ), 10 ); - add_action( sprintf( 'publish_%s', self::CUSTOM_POST_TYPE), array( $this, 'flush_rules_on_first_project' ) ); - add_action( 'after_switch_theme', array( $this, 'flush_rules_on_switch' ) ); + add_action( sprintf( 'add_option_%s', self::OPTION_NAME ), array( $this, 'flush_rules_on_enable' ), 10 ); + add_action( sprintf( 'update_option_%s', self::OPTION_NAME ), array( $this, 'flush_rules_on_enable' ), 10 ); + add_action( sprintf( 'publish_%s', self::CUSTOM_POST_TYPE ), array( $this, 'flush_rules_on_first_project' ) ); + add_action( 'after_switch_theme', array( $this, 'flush_rules_on_switch' ) ); - // Admin Customization - add_filter( 'post_updated_messages', array( $this, 'updated_messages' ) ); - add_filter( sprintf( 'manage_%s_posts_columns', self::CUSTOM_POST_TYPE), array( $this, 'edit_admin_columns' ) ); - add_filter( sprintf( 'manage_%s_posts_custom_column', self::CUSTOM_POST_TYPE), array( $this, 'image_column' ), 10, 2 ); - add_action( 'customize_register', array( $this, 'customize_register' ) ); + // Admin Customization. + add_filter( 'post_updated_messages', array( $this, 'updated_messages' ) ); + add_filter( sprintf( 'manage_%s_posts_columns', self::CUSTOM_POST_TYPE ), array( $this, 'edit_admin_columns' ) ); + add_filter( sprintf( 'manage_%s_posts_custom_column', self::CUSTOM_POST_TYPE ), array( $this, 'image_column' ), 10, 2 ); + add_action( 'customize_register', array( $this, 'customize_register' ) ); if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { - // Track all the things - add_action( sprintf( 'add_option_%s', self::OPTION_NAME ), array( $this, 'new_activation_stat_bump' ) ); - add_action( sprintf( 'update_option_%s', self::OPTION_NAME ), array( $this, 'update_option_stat_bump' ), 11, 2 ); - add_action( sprintf( 'publish_%s', self::CUSTOM_POST_TYPE), array( $this, 'new_project_stat_bump' ) ); + // Track all the things. + add_action( sprintf( 'add_option_%s', self::OPTION_NAME ), array( $this, 'new_activation_stat_bump' ) ); + add_action( sprintf( 'update_option_%s', self::OPTION_NAME ), array( $this, 'update_option_stat_bump' ), 11, 2 ); + add_action( sprintf( 'publish_%s', self::CUSTOM_POST_TYPE ), array( $this, 'new_project_stat_bump' ) ); } add_image_size( 'jetpack-portfolio-admin-thumb', 50, 50, true ); - add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) ); + add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) ); - // register jetpack_portfolio shortcode and portfolio shortcode (legacy) - add_shortcode( 'portfolio', array( $this, 'portfolio_shortcode' ) ); - add_shortcode( 'jetpack_portfolio', array( $this, 'portfolio_shortcode' ) ); + // register jetpack_portfolio shortcode and portfolio shortcode (legacy). + add_shortcode( 'portfolio', array( $this, 'portfolio_shortcode' ) ); + add_shortcode( 'jetpack_portfolio', array( $this, 'portfolio_shortcode' ) ); - // Adjust CPT archive and custom taxonomies to obey CPT reading setting - add_filter( 'infinite_scroll_settings', array( $this, 'infinite_scroll_click_posts_per_page' ) ); - add_filter( 'infinite_scroll_results', array( $this, 'infinite_scroll_results' ), 10, 3 ); + // Adjust CPT archive and custom taxonomies to obey CPT reading setting. + add_filter( 'infinite_scroll_settings', array( $this, 'infinite_scroll_click_posts_per_page' ) ); + add_filter( 'infinite_scroll_results', array( $this, 'infinite_scroll_results' ), 10, 3 ); if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { - // Add to Dotcom XML sitemaps - add_filter( 'wpcom_sitemap_post_types', array( $this, 'add_to_sitemap' ) ); + // Add to Dotcom XML sitemaps. + add_filter( 'wpcom_sitemap_post_types', array( $this, 'add_to_sitemap' ) ); } else { - // Add to Jetpack XML sitemap - add_filter( 'jetpack_sitemap_post_types', array( $this, 'add_to_sitemap' ) ); + // Add to Jetpack XML sitemap. + add_filter( 'jetpack_sitemap_post_types', array( $this, 'add_to_sitemap' ) ); } - // Adjust CPT archive and custom taxonomies to obey CPT reading setting - add_filter( 'pre_get_posts', array( $this, 'query_reading_setting' ) ); + // Adjust CPT archive and custom taxonomies to obey CPT reading setting. + add_filter( 'pre_get_posts', array( $this, 'query_reading_setting' ) ); - // If CPT was enabled programatically and no CPT items exist when user switches away, disable + // If CPT was enabled programatically and no CPT items exist when user switches away, disable. if ( $setting && $this->site_supports_custom_post_type() ) { - add_action( 'switch_theme', array( $this, 'deactivation_post_type_support' ) ); + add_action( 'switch_theme', array( $this, 'deactivation_post_type_support' ) ); } } @@ -98,9 +122,9 @@ class Jetpack_Portfolio { * Add a checkbox field in 'Settings' > 'Writing' * for enabling CPT functionality. * - * @return null + * @return void */ - function settings_api_init() { + public function settings_api_init() { add_settings_field( self::OPTION_NAME, '<span class="cpt-options">' . __( 'Portfolio Projects', 'jetpack' ) . '</span>', @@ -114,7 +138,7 @@ class Jetpack_Portfolio { 'intval' ); - // Check if CPT is enabled first so that intval doesn't get set to NULL on re-registering + // Check if CPT is enabled first so that intval doesn't get set to NULL on re-registering. if ( get_option( self::OPTION_NAME, '0' ) || current_theme_supports( self::CUSTOM_POST_TYPE ) ) { register_setting( 'writing', @@ -128,24 +152,41 @@ class Jetpack_Portfolio { * HTML code to display a checkbox true/false option * for the Portfolio CPT setting. * - * @return html + * @return void */ - function setting_html() { + public function setting_html() { if ( current_theme_supports( self::CUSTOM_POST_TYPE ) ) : ?> - <p><?php printf( /* translators: %s is the name of a custom post type such as "jetpack-portfolio" */ __( 'Your theme supports <strong>%s</strong>', 'jetpack' ), self::CUSTOM_POST_TYPE ); ?></p> + <p> + <?php + echo wp_kses( + sprintf( + /* translators: %s is the name of a custom post type such as "jetpack-portfolio" */ + __( 'Your theme supports <strong>%s</strong>', 'jetpack' ), + esc_attr( self::CUSTOM_POST_TYPE ) + ), + array( + 'strong' => array(), + ) + ); + ?> + </p> <?php else : ?> <label for="<?php echo esc_attr( self::OPTION_NAME ); ?>"> <input name="<?php echo esc_attr( self::OPTION_NAME ); ?>" id="<?php echo esc_attr( self::OPTION_NAME ); ?>" <?php echo checked( get_option( self::OPTION_NAME, '0' ), true, false ); ?> type="checkbox" value="1" /> <?php esc_html_e( 'Enable Portfolio Projects for this site.', 'jetpack' ); ?> <a target="_blank" href="https://en.support.wordpress.com/portfolios/"><?php esc_html_e( 'Learn More', 'jetpack' ); ?></a> </label> - <?php endif; + <?php + endif; if ( get_option( self::OPTION_NAME, '0' ) || current_theme_supports( self::CUSTOM_POST_TYPE ) ) : - printf( '<p><label for="%1$s">%2$s</label></p>', + printf( + '<p><label for="%1$s">%2$s</label></p>', esc_attr( self::OPTION_READING_SETTING ), - /* translators: %1$s is replaced with an input field for numbers */ - sprintf( __( 'Portfolio pages display at most %1$s projects', 'jetpack' ), - sprintf( '<input name="%1$s" id="%1$s" type="number" step="1" min="1" value="%2$s" class="small-text" />', + sprintf( + /* translators: %1$s is replaced with an input field for numbers */ + __( 'Portfolio pages display at most %1$s projects', 'jetpack' ), // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- the placeholder contains HTML. + sprintf( + '<input name="%1$s" id="%1$s" type="number" step="1" min="1" value="%2$s" class="small-text" />', esc_attr( self::OPTION_READING_SETTING ), esc_attr( get_option( self::OPTION_READING_SETTING, '10' ) ) ) @@ -154,17 +195,20 @@ class Jetpack_Portfolio { endif; } - /* - * Bump Portfolio > New Activation stat + /** + * Bump Portfolio > New Activation stat. */ - function new_activation_stat_bump() { + public function new_activation_stat_bump() { bump_stats_extras( 'portfolios', 'new-activation' ); } - /* - * Bump Portfolio > Option On/Off stats to get total active + /** + * Bump Portfolio > Option On/Off stats to get total active. + * + * @param mixed $old The old option value. + * @param mixed $new The new option value. */ - function update_option_stat_bump( $old, $new ) { + public function update_option_stat_bump( $old, $new ) { if ( empty( $old ) && ! empty( $new ) ) { bump_stats_extras( 'portfolios', 'option-on' ); } @@ -174,17 +218,17 @@ class Jetpack_Portfolio { } } - /* - * Bump Portfolio > Published Projects stat when projects are published + /** + * Bump Portfolio > Published Projects stat when projects are published. */ - function new_project_stat_bump() { + public function new_project_stat_bump() { bump_stats_extras( 'portfolios', 'published-projects' ); } /** - * Should this Custom Post Type be made available? - */ - function site_supports_custom_post_type() { + * Should this Custom Post Type be made available? + */ + private function site_supports_custom_post_type() { // If the current theme requests it. if ( current_theme_supports( self::CUSTOM_POST_TYPE ) || get_option( self::OPTION_NAME, '0' ) ) { return true; @@ -195,17 +239,17 @@ class Jetpack_Portfolio { return (bool) apply_filters( 'jetpack_enable_cpt', false, self::CUSTOM_POST_TYPE ); } - /* + /** * Flush permalinks when CPT option is turned on/off */ - function flush_rules_on_enable() { + public function flush_rules_on_enable() { flush_rewrite_rules(); } - /* + /** * Count published projects and flush permalinks when first projects is published */ - function flush_rules_on_first_project() { + public function flush_rules_on_first_project() { $projects = get_transient( 'jetpack-portfolio-count-cache' ); if ( false === $projects ) { @@ -218,10 +262,10 @@ class Jetpack_Portfolio { } } - /* + /** * Flush permalinks when CPT supported theme is activated */ - function flush_rules_on_switch() { + public function flush_rules_on_switch() { if ( current_theme_supports( self::CUSTOM_POST_TYPE ) ) { flush_rewrite_rules(); } @@ -230,7 +274,7 @@ class Jetpack_Portfolio { /** * On plugin/theme activation, check if current theme supports CPT */ - static function activation_post_type_support() { + public static function activation_post_type_support() { if ( current_theme_supports( self::CUSTOM_POST_TYPE ) ) { update_option( self::OPTION_NAME, '1' ); } @@ -239,13 +283,15 @@ class Jetpack_Portfolio { /** * On theme switch, check if CPT item exists and disable if not */ - function deactivation_post_type_support() { - $portfolios = get_posts( array( - 'fields' => 'ids', - 'posts_per_page' => 1, - 'post_type' => self::CUSTOM_POST_TYPE, - 'suppress_filters' => false - ) ); + public function deactivation_post_type_support() { + $portfolios = get_posts( + array( + 'fields' => 'ids', + 'posts_per_page' => 1, + 'post_type' => self::CUSTOM_POST_TYPE, + 'suppress_filters' => false, + ) + ); if ( empty( $portfolios ) ) { update_option( self::OPTION_NAME, '0' ); @@ -255,139 +301,180 @@ class Jetpack_Portfolio { /** * Register Post Type */ - function register_post_types() { + public function register_post_types() { if ( post_type_exists( self::CUSTOM_POST_TYPE ) ) { return; } - register_post_type( self::CUSTOM_POST_TYPE, array( - 'labels' => array( - 'name' => esc_html__( 'Projects', 'jetpack' ), - 'singular_name' => esc_html__( 'Project', 'jetpack' ), - 'menu_name' => esc_html__( 'Portfolio', 'jetpack' ), - 'all_items' => esc_html__( 'All Projects', 'jetpack' ), - 'add_new' => esc_html__( 'Add New', 'jetpack' ), - 'add_new_item' => esc_html__( 'Add New Project', 'jetpack' ), - 'edit_item' => esc_html__( 'Edit Project', 'jetpack' ), - 'new_item' => esc_html__( 'New Project', 'jetpack' ), - 'view_item' => esc_html__( 'View Project', 'jetpack' ), - 'search_items' => esc_html__( 'Search Projects', 'jetpack' ), - 'not_found' => esc_html__( 'No Projects found', 'jetpack' ), - 'not_found_in_trash' => esc_html__( 'No Projects found in Trash', 'jetpack' ), - 'filter_items_list' => esc_html__( 'Filter projects list', 'jetpack' ), - 'items_list_navigation' => esc_html__( 'Project list navigation', 'jetpack' ), - 'items_list' => esc_html__( 'Projects list', 'jetpack' ), - ), - 'supports' => array( - 'title', - 'editor', - 'thumbnail', - 'author', - 'comments', - 'publicize', - 'wpcom-markdown', - 'revisions', - 'excerpt', - 'custom-fields', - 'newspack_blocks', - ), - 'rewrite' => array( - 'slug' => 'portfolio', - 'with_front' => false, - 'feeds' => true, - 'pages' => true, - ), - 'public' => true, - 'show_ui' => true, - 'menu_position' => 20, // below Pages - 'menu_icon' => 'dashicons-portfolio', // 3.8+ dashicon option - 'capability_type' => 'page', - 'map_meta_cap' => true, - 'taxonomies' => array( self::CUSTOM_TAXONOMY_TYPE, self::CUSTOM_TAXONOMY_TAG ), - 'has_archive' => true, - 'query_var' => 'portfolio', - 'show_in_rest' => true, - ) ); - - register_taxonomy( self::CUSTOM_TAXONOMY_TYPE, self::CUSTOM_POST_TYPE, array( - 'hierarchical' => true, - 'labels' => array( - 'name' => esc_html__( 'Project Types', 'jetpack' ), - 'singular_name' => esc_html__( 'Project Type', 'jetpack' ), - 'menu_name' => esc_html__( 'Project Types', 'jetpack' ), - 'all_items' => esc_html__( 'All Project Types', 'jetpack' ), - 'edit_item' => esc_html__( 'Edit Project Type', 'jetpack' ), - 'view_item' => esc_html__( 'View Project Type', 'jetpack' ), - 'update_item' => esc_html__( 'Update Project Type', 'jetpack' ), - 'add_new_item' => esc_html__( 'Add New Project Type', 'jetpack' ), - 'new_item_name' => esc_html__( 'New Project Type Name', 'jetpack' ), - 'parent_item' => esc_html__( 'Parent Project Type', 'jetpack' ), - 'parent_item_colon' => esc_html__( 'Parent Project Type:', 'jetpack' ), - 'search_items' => esc_html__( 'Search Project Types', 'jetpack' ), - 'items_list_navigation' => esc_html__( 'Project type list navigation', 'jetpack' ), - 'items_list' => esc_html__( 'Project type list', 'jetpack' ), - ), - 'public' => true, - 'show_ui' => true, - 'show_in_nav_menus' => true, - 'show_in_rest' => true, - 'show_admin_column' => true, - 'query_var' => true, - 'rewrite' => array( 'slug' => 'project-type' ), - ) ); - - register_taxonomy( self::CUSTOM_TAXONOMY_TAG, self::CUSTOM_POST_TYPE, array( - 'hierarchical' => false, - 'labels' => array( - 'name' => esc_html__( 'Project Tags', 'jetpack' ), - 'singular_name' => esc_html__( 'Project Tag', 'jetpack' ), - 'menu_name' => esc_html__( 'Project Tags', 'jetpack' ), - 'all_items' => esc_html__( 'All Project Tags', 'jetpack' ), - 'edit_item' => esc_html__( 'Edit Project Tag', 'jetpack' ), - 'view_item' => esc_html__( 'View Project Tag', 'jetpack' ), - 'update_item' => esc_html__( 'Update Project Tag', 'jetpack' ), - 'add_new_item' => esc_html__( 'Add New Project Tag', 'jetpack' ), - 'new_item_name' => esc_html__( 'New Project Tag Name', 'jetpack' ), - 'search_items' => esc_html__( 'Search Project Tags', 'jetpack' ), - 'popular_items' => esc_html__( 'Popular Project Tags', 'jetpack' ), - 'separate_items_with_commas' => esc_html__( 'Separate tags with commas', 'jetpack' ), - 'add_or_remove_items' => esc_html__( 'Add or remove tags', 'jetpack' ), - 'choose_from_most_used' => esc_html__( 'Choose from the most used tags', 'jetpack' ), - 'not_found' => esc_html__( 'No tags found.', 'jetpack' ), - 'items_list_navigation' => esc_html__( 'Project tag list navigation', 'jetpack' ), - 'items_list' => esc_html__( 'Project tag list', 'jetpack' ), - ), - 'public' => true, - 'show_ui' => true, - 'show_in_nav_menus' => true, - 'show_in_rest' => true, - 'show_admin_column' => true, - 'query_var' => true, - 'rewrite' => array( 'slug' => 'project-tag' ), - ) ); + register_post_type( + self::CUSTOM_POST_TYPE, + array( + 'labels' => array( + 'name' => esc_html__( 'Projects', 'jetpack' ), + 'singular_name' => esc_html__( 'Project', 'jetpack' ), + 'menu_name' => esc_html__( 'Portfolio', 'jetpack' ), + 'all_items' => esc_html__( 'All Projects', 'jetpack' ), + 'add_new' => esc_html__( 'Add New', 'jetpack' ), + 'add_new_item' => esc_html__( 'Add New Project', 'jetpack' ), + 'edit_item' => esc_html__( 'Edit Project', 'jetpack' ), + 'new_item' => esc_html__( 'New Project', 'jetpack' ), + 'view_item' => esc_html__( 'View Project', 'jetpack' ), + 'search_items' => esc_html__( 'Search Projects', 'jetpack' ), + 'not_found' => esc_html__( 'No Projects found', 'jetpack' ), + 'not_found_in_trash' => esc_html__( 'No Projects found in Trash', 'jetpack' ), + 'filter_items_list' => esc_html__( 'Filter projects list', 'jetpack' ), + 'items_list_navigation' => esc_html__( 'Project list navigation', 'jetpack' ), + 'items_list' => esc_html__( 'Projects list', 'jetpack' ), + ), + 'supports' => array( + 'title', + 'editor', + 'thumbnail', + 'author', + 'post-formats', + 'comments', + 'publicize', + 'wpcom-markdown', + 'revisions', + 'excerpt', + 'custom-fields', + 'newspack_blocks', + ), + 'rewrite' => array( + 'slug' => 'portfolio', + 'with_front' => false, + 'feeds' => true, + 'pages' => true, + ), + 'public' => true, + 'show_ui' => true, + 'menu_position' => 20, // below Pages. + 'menu_icon' => 'dashicons-portfolio', // 3.8+ dashicon option. + 'capability_type' => 'page', + 'map_meta_cap' => true, + 'taxonomies' => array( self::CUSTOM_TAXONOMY_TYPE, self::CUSTOM_TAXONOMY_TAG ), + 'has_archive' => true, + 'query_var' => 'portfolio', + 'show_in_rest' => true, + ) + ); + + register_taxonomy( + self::CUSTOM_TAXONOMY_TYPE, + self::CUSTOM_POST_TYPE, + array( + 'hierarchical' => true, + 'labels' => array( + 'name' => esc_html__( 'Project Types', 'jetpack' ), + 'singular_name' => esc_html__( 'Project Type', 'jetpack' ), + 'menu_name' => esc_html__( 'Project Types', 'jetpack' ), + 'all_items' => esc_html__( 'All Project Types', 'jetpack' ), + 'edit_item' => esc_html__( 'Edit Project Type', 'jetpack' ), + 'view_item' => esc_html__( 'View Project Type', 'jetpack' ), + 'update_item' => esc_html__( 'Update Project Type', 'jetpack' ), + 'add_new_item' => esc_html__( 'Add New Project Type', 'jetpack' ), + 'new_item_name' => esc_html__( 'New Project Type Name', 'jetpack' ), + 'parent_item' => esc_html__( 'Parent Project Type', 'jetpack' ), + 'parent_item_colon' => esc_html__( 'Parent Project Type:', 'jetpack' ), + 'search_items' => esc_html__( 'Search Project Types', 'jetpack' ), + 'items_list_navigation' => esc_html__( 'Project type list navigation', 'jetpack' ), + 'items_list' => esc_html__( 'Project type list', 'jetpack' ), + ), + 'public' => true, + 'show_ui' => true, + 'show_in_nav_menus' => true, + 'show_in_rest' => true, + 'show_admin_column' => true, + 'query_var' => true, + 'rewrite' => array( 'slug' => 'project-type' ), + ) + ); + + register_taxonomy( + self::CUSTOM_TAXONOMY_TAG, + self::CUSTOM_POST_TYPE, + array( + 'hierarchical' => false, + 'labels' => array( + 'name' => esc_html__( 'Project Tags', 'jetpack' ), + 'singular_name' => esc_html__( 'Project Tag', 'jetpack' ), + 'menu_name' => esc_html__( 'Project Tags', 'jetpack' ), + 'all_items' => esc_html__( 'All Project Tags', 'jetpack' ), + 'edit_item' => esc_html__( 'Edit Project Tag', 'jetpack' ), + 'view_item' => esc_html__( 'View Project Tag', 'jetpack' ), + 'update_item' => esc_html__( 'Update Project Tag', 'jetpack' ), + 'add_new_item' => esc_html__( 'Add New Project Tag', 'jetpack' ), + 'new_item_name' => esc_html__( 'New Project Tag Name', 'jetpack' ), + 'search_items' => esc_html__( 'Search Project Tags', 'jetpack' ), + 'popular_items' => esc_html__( 'Popular Project Tags', 'jetpack' ), + 'separate_items_with_commas' => esc_html__( 'Separate tags with commas', 'jetpack' ), + 'add_or_remove_items' => esc_html__( 'Add or remove tags', 'jetpack' ), + 'choose_from_most_used' => esc_html__( 'Choose from the most used tags', 'jetpack' ), + 'not_found' => esc_html__( 'No tags found.', 'jetpack' ), + 'items_list_navigation' => esc_html__( 'Project tag list navigation', 'jetpack' ), + 'items_list' => esc_html__( 'Project tag list', 'jetpack' ), + ), + 'public' => true, + 'show_ui' => true, + 'show_in_nav_menus' => true, + 'show_in_rest' => true, + 'show_admin_column' => true, + 'query_var' => true, + 'rewrite' => array( 'slug' => 'project-tag' ), + ) + ); + + register_taxonomy_for_object_type( 'post_format', self::CUSTOM_POST_TYPE ); } /** * Update messages for the Portfolio admin. + * + * @param array $messages Existing post update messages. */ - function updated_messages( $messages ) { + public function updated_messages( $messages ) { global $post; - $messages[self::CUSTOM_POST_TYPE] = array( + $messages[ self::CUSTOM_POST_TYPE ] = array( 0 => '', // Unused. Messages start at index 1. - 1 => sprintf( __( 'Project updated. <a href="%s">View item</a>', 'jetpack'), esc_url( get_permalink( $post->ID ) ) ), + 1 => sprintf( + /* Translators: link to portfolio item's page. */ + __( 'Project 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' ), 4 => esc_html__( 'Project updated.', 'jetpack' ), - /* translators: %s: date and time of the revision */ - 5 => isset( $_GET['revision'] ) ? sprintf( esc_html__( 'Project restored to revision from %s', 'jetpack'), wp_post_revision_title( (int) $_GET['revision'], false ) ) : false, - 6 => sprintf( __( 'Project published. <a href="%s">View project</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__( 'Project 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: link to portfolio item's page. */ + __( 'Project published. <a href="%s">View project</a>', 'jetpack' ), + esc_url( get_permalink( $post->ID ) ) + ), 7 => esc_html__( 'Project saved.', 'jetpack' ), - 8 => sprintf( __( 'Project submitted. <a target="_blank" href="%s">Preview project</a>', 'jetpack'), esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) ), - 9 => sprintf( __( 'Project scheduled for: <strong>%1$s</strong>. <a target="_blank" href="%2$s">Preview project</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( __( 'Project item draft updated. <a target="_blank" href="%s">Preview project</a>', 'jetpack' ), esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) ), + 8 => sprintf( + /* Translators: link to portfolio item's page. */ + __( 'Project submitted. <a target="_blank" href="%s">Preview project</a>', 'jetpack' ), + esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) + ), + 9 => sprintf( + /* Translators: 1: Publishing date and time. 2. Link to portfolio's item page. */ + __( 'Project scheduled for: <strong>%1$s</strong>. <a target="_blank" href="%2$s">Preview project</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: link to portfolio item's page. */ + __( 'Project item draft updated. <a target="_blank" href="%s">Preview project</a>', 'jetpack' ), + esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) + ), ); return $messages; @@ -396,13 +483,15 @@ class Jetpack_Portfolio { /** * Change ‘Title’ column label * Add Featured Image column + * + * @param array $columns An array of column names. */ - function edit_admin_columns( $columns ) { - // change 'Title' to 'Project' + public function edit_admin_columns( $columns ) { + // change 'Title' to 'Project'. $columns['title'] = __( 'Project', 'jetpack' ); if ( current_theme_supports( 'post-thumbnails' ) ) { - // add featured image before 'Project' - $columns = array_slice( $columns, 0, 1, true ) + array( 'thumbnail' => '' ) + array_slice( $columns, 1, NULL, true ); + // add featured image before 'Project'. + $columns = array_slice( $columns, 0, 1, true ) + array( 'thumbnail' => '' ) + array_slice( $columns, 1, null, true ); } return $columns; @@ -410,93 +499,129 @@ class Jetpack_Portfolio { /** * Add featured image to column + * + * @param string $column The name of the column to display. + * @param int $post_id The current post ID. */ - function image_column( $column, $post_id ) { - global $post; - switch ( $column ) { - case 'thumbnail': - echo get_the_post_thumbnail( $post_id, 'jetpack-portfolio-admin-thumb' ); - break; + public function image_column( $column, $post_id ) { + if ( 'thumbnail' !== $column ) { + return; } + + echo get_the_post_thumbnail( $post_id, 'jetpack-portfolio-admin-thumb' ); } /** * Adjust image column width + * + * @param string $hook Page hook. */ - function enqueue_admin_styles( $hook ) { + public function enqueue_admin_styles( $hook ) { $screen = get_current_screen(); - if ( 'edit.php' == $hook && self::CUSTOM_POST_TYPE == $screen->post_type && current_theme_supports( 'post-thumbnails' ) ) { + if ( + 'edit.php' === $hook + && self::CUSTOM_POST_TYPE === $screen->post_type + && current_theme_supports( 'post-thumbnails' ) + ) { wp_add_inline_style( 'wp-admin', '.manage-column.column-thumbnail { width: 50px; } @media screen and (max-width: 360px) { .column-thumbnail{ display:none; } }' ); } } /** * Adds portfolio section to the Customizer. + * + * @param WP_Customize_Manager $wp_customize Customizer instance. */ - function customize_register( $wp_customize ) { + public function customize_register( $wp_customize ) { $options = get_theme_support( self::CUSTOM_POST_TYPE ); if ( ( ! isset( $options[0]['title'] ) || true !== $options[0]['title'] ) && ( ! isset( $options[0]['content'] ) || true !== $options[0]['content'] ) && ( ! isset( $options[0]['featured-image'] ) || true !== $options[0]['featured-image'] ) ) { return; } - $wp_customize->add_section( 'jetpack_portfolio', array( - 'title' => esc_html__( 'Portfolio', 'jetpack' ), - 'theme_supports' => self::CUSTOM_POST_TYPE, - 'priority' => 130, - ) ); + $wp_customize->add_section( + 'jetpack_portfolio', + array( + 'title' => esc_html__( 'Portfolio', 'jetpack' ), + 'theme_supports' => self::CUSTOM_POST_TYPE, + 'priority' => 130, + ) + ); if ( isset( $options[0]['title'] ) && true === $options[0]['title'] ) { - $wp_customize->add_setting( 'jetpack_portfolio_title', array( - 'default' => esc_html__( 'Projects', 'jetpack' ), - 'type' => 'option', - 'sanitize_callback' => 'sanitize_text_field', - 'sanitize_js_callback' => 'sanitize_text_field', - ) ); + $wp_customize->add_setting( + 'jetpack_portfolio_title', + array( + 'default' => esc_html__( 'Projects', 'jetpack' ), + 'type' => 'option', + 'sanitize_callback' => 'sanitize_text_field', + 'sanitize_js_callback' => 'sanitize_text_field', + ) + ); - $wp_customize->add_control( 'jetpack_portfolio_title', array( - 'section' => 'jetpack_portfolio', - 'label' => esc_html__( 'Portfolio Archive Title', 'jetpack' ), - 'type' => 'text', - ) ); + $wp_customize->add_control( + 'jetpack_portfolio_title', + array( + 'section' => 'jetpack_portfolio', + 'label' => esc_html__( 'Portfolio Archive Title', 'jetpack' ), + 'type' => 'text', + ) + ); } if ( isset( $options[0]['content'] ) && true === $options[0]['content'] ) { - $wp_customize->add_setting( 'jetpack_portfolio_content', array( - 'default' => '', - 'type' => 'option', - 'sanitize_callback' => 'wp_kses_post', - 'sanitize_js_callback' => 'wp_kses_post', - ) ); + $wp_customize->add_setting( + 'jetpack_portfolio_content', + array( + 'default' => '', + 'type' => 'option', + 'sanitize_callback' => 'wp_kses_post', + 'sanitize_js_callback' => 'wp_kses_post', + ) + ); - $wp_customize->add_control( 'jetpack_portfolio_content', array( - 'section' => 'jetpack_portfolio', - 'label' => esc_html__( 'Portfolio Archive Content', 'jetpack' ), - 'type' => 'textarea', - ) ); + $wp_customize->add_control( + 'jetpack_portfolio_content', + array( + 'section' => 'jetpack_portfolio', + 'label' => esc_html__( 'Portfolio Archive Content', 'jetpack' ), + 'type' => 'textarea', + ) + ); } if ( isset( $options[0]['featured-image'] ) && true === $options[0]['featured-image'] ) { - $wp_customize->add_setting( 'jetpack_portfolio_featured_image', array( - 'default' => '', - 'type' => 'option', - 'sanitize_callback' => 'attachment_url_to_postid', - 'sanitize_js_callback' => 'attachment_url_to_postid', - 'theme_supports' => 'post-thumbnails', - ) ); + $wp_customize->add_setting( + 'jetpack_portfolio_featured_image', + array( + 'default' => '', + 'type' => 'option', + 'sanitize_callback' => 'attachment_url_to_postid', + 'sanitize_js_callback' => 'attachment_url_to_postid', + 'theme_supports' => 'post-thumbnails', + ) + ); - $wp_customize->add_control( new WP_Customize_Image_Control( $wp_customize, 'jetpack_portfolio_featured_image', array( - 'section' => 'jetpack_portfolio', - 'label' => esc_html__( 'Portfolio Archive Featured Image', 'jetpack' ), - ) ) ); + $wp_customize->add_control( + new WP_Customize_Image_Control( + $wp_customize, + 'jetpack_portfolio_featured_image', + array( + 'section' => 'jetpack_portfolio', + 'label' => esc_html__( 'Portfolio Archive Featured Image', 'jetpack' ), + ) + ) + ); } } /** * Follow CPT reading setting on CPT archive and taxonomy pages + * + * @param WP_Query $query A WP_Query instance. */ - function query_reading_setting( $query ) { + public function query_reading_setting( $query ) { if ( ( ! is_admin() || ( is_admin() && defined( 'DOING_AJAX' ) && DOING_AJAX ) ) && $query->is_main_query() && ( $query->is_post_type_archive( self::CUSTOM_POST_TYPE ) @@ -507,10 +632,12 @@ class Jetpack_Portfolio { } } - /* + /** * If Infinite Scroll is set to 'click', use our custom reading setting instead of core's `posts_per_page`. + * + * @param array $settings Array of Infinite Scroll settings. */ - function infinite_scroll_click_posts_per_page( $settings ) { + public function infinite_scroll_click_posts_per_page( $settings ) { global $wp_query; if ( ( ! is_admin() || ( is_admin() && defined( 'DOING_AJAX' ) && DOING_AJAX ) ) @@ -519,24 +646,30 @@ class Jetpack_Portfolio { || $wp_query->is_tax( self::CUSTOM_TAXONOMY_TYPE ) || $wp_query->is_tax( self::CUSTOM_TAXONOMY_TAG ) ) ) { - $settings['posts_per_page'] = get_option( self::OPTION_READING_SETTING, $settings['posts_per_page'] ); + $settings['posts_per_page'] = get_option( self::OPTION_READING_SETTING, $settings['posts_per_page'] ); // phpcs:ignore WordPress.WP.PostsPerPage.posts_per_page_posts_per_page } return $settings; } - /* + /** * Filter the results of infinite scroll to make sure we get `lastbatch` right. + * + * @param array $results Array of Infinite Scroll results. + * @param array $query_args Array of main query arguments. + * @param WP_Query $query WP Query. */ - function infinite_scroll_results( $results, $query_args, $query ) { + public function infinite_scroll_results( $results, $query_args, $query ) { $results['lastbatch'] = $query_args['paged'] >= $query->max_num_pages; return $results; } /** * Add CPT to Dotcom sitemap + * + * @param array $post_types Array of post types included in sitemap. */ - function add_to_sitemap( $post_types ) { + public function add_to_sitemap( $post_types ) { $post_types[] = self::CUSTOM_POST_TYPE; return $post_types; @@ -544,8 +677,10 @@ class Jetpack_Portfolio { /** * Add to REST API post type allowed list. + * + * @param array $post_types Array of post types to add to the allowed list. Default to `array( 'post', 'page', 'revision' )`. */ - function allow_portfolio_rest_api_type( $post_types ) { + public function allow_portfolio_rest_api_type( $post_types ) { $post_types[] = self::CUSTOM_POST_TYPE; return $post_types; @@ -555,39 +690,44 @@ class Jetpack_Portfolio { * Our [portfolio] shortcode. * Prints Portfolio data styled to look good on *any* theme. * + * @param array $atts Shortcode attributes. + * * @return portfolio_shortcode_html */ - static function portfolio_shortcode( $atts ) { - // Default attributes - $atts = shortcode_atts( array( - 'display_types' => true, - 'display_tags' => true, - 'display_content' => true, - 'display_author' => false, - 'show_filter' => false, - 'include_type' => false, - 'include_tag' => false, - 'columns' => 2, - 'showposts' => -1, - 'order' => 'asc', - 'orderby' => 'date', - ), $atts, 'portfolio' ); - - // A little sanitization - if ( $atts['display_types'] && 'true' != $atts['display_types'] ) { - $atts['display_types'] = false; - } - - if ( $atts['display_tags'] && 'true' != $atts['display_tags'] ) { - $atts['display_tags'] = false; - } + public static function portfolio_shortcode( $atts ) { + // Default attributes. + $atts = shortcode_atts( + array( + 'display_types' => true, + 'display_tags' => true, + 'display_content' => true, // Can be false, true, or full. + 'display_author' => false, + 'show_filter' => false, + 'include_type' => false, + 'include_tag' => false, + 'columns' => 2, + 'showposts' => -1, + 'order' => 'asc', + 'orderby' => 'date', + ), + $atts, + 'portfolio' + ); - if ( $atts['display_author'] && 'true' != $atts['display_author'] ) { - $atts['display_author'] = false; - } + /* + * A little sanitization for our shortcode attributes aiming to use booleans. + * Attributes can be booleans (from the default values) or strings. + */ + foreach ( $atts as $attribute_name => $attribute_value ) { + if ( preg_match( '#^(?:display_|show_)#i', $attribute_name ) ) { + // display_content is a special case. + if ( 'display_content' === $attribute_name && 'full' === $attribute_value ) { + $atts['display_content'] = 'full'; + continue; + } - if ( $atts['display_content'] && 'true' != $atts['display_content'] && 'full' != $atts['display_content'] ) { - $atts['display_content'] = false; + $atts[ $attribute_name ] = self::sanitize_boolean_attribute( $attribute_value ); + } } if ( $atts['include_type'] ) { @@ -602,11 +742,10 @@ class Jetpack_Portfolio { $atts['showposts'] = (int) $atts['showposts']; - if ( $atts['order'] ) { $atts['order'] = urldecode( $atts['order'] ); $atts['order'] = strtoupper( $atts['order'] ); - if ( 'DESC' != $atts['order'] ) { + if ( 'DESC' !== $atts['order'] ) { $atts['order'] = 'ASC'; } } @@ -614,11 +753,11 @@ class Jetpack_Portfolio { if ( $atts['orderby'] ) { $atts['orderby'] = urldecode( $atts['orderby'] ); $atts['orderby'] = strtolower( $atts['orderby'] ); - $allowed_keys = array( 'author', 'date', 'title', 'rand' ); + $allowed_keys = array( 'author', 'date', 'title', 'rand' ); $parsed = array(); - foreach ( explode( ',', $atts['orderby'] ) as $portfolio_index_number => $orderby ) { - if ( ! in_array( $orderby, $allowed_keys ) ) { + foreach ( explode( ',', $atts['orderby'] ) as $orderby ) { + if ( ! in_array( $orderby, $allowed_keys, true ) ) { continue; } $parsed[] = $orderby; @@ -631,7 +770,7 @@ class Jetpack_Portfolio { } } - // enqueue shortcode styles when shortcode is used + // enqueue shortcode styles when shortcode is used. if ( ! wp_style_is( 'jetpack-portfolio-style', 'enqueued' ) ) { wp_enqueue_style( 'jetpack-portfolio-style', plugins_url( 'css/portfolio-shortcode.css', __FILE__ ), array(), '20140326' ); } @@ -640,48 +779,74 @@ class Jetpack_Portfolio { } /** + * Sanitizes an attribute value. + * Attributes can be booleans (from the default values) or strings. + * + * @since 11.0 + * + * @param bool|string $attr Shortcode attribute value. + * + * @return bool + */ + private static function sanitize_boolean_attribute( $attr ) { + if ( $attr && 'true' == $attr ) { // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual + return true; + } + + return false; + } + + /** * Query to retrieve entries from the Portfolio post_type. * + * @param array $atts Shortcode attributes. + * * @return object */ - static function portfolio_query( $atts ) { - // Default query arguments + private static function portfolio_query( $atts ) { + // Default query arguments. $default = array( 'order' => $atts['order'], 'orderby' => $atts['orderby'], 'posts_per_page' => $atts['showposts'], ); - $args = wp_parse_args( $atts, $default ); - $args['post_type'] = self::CUSTOM_POST_TYPE; // Force this post type + $args = wp_parse_args( $atts, $default ); + $args['post_type'] = self::CUSTOM_POST_TYPE; // Force this post type. - if ( false != $atts['include_type'] || false != $atts['include_tag'] ) { + if ( $atts['include_type'] || $atts['include_tag'] ) { $args['tax_query'] = array(); } - // If 'include_type' has been set use it on the main query - if ( false != $atts['include_type'] ) { - array_push( $args['tax_query'], array( - 'taxonomy' => self::CUSTOM_TAXONOMY_TYPE, - 'field' => 'slug', - 'terms' => $atts['include_type'], - ) ); + // If 'include_type' has been set use it on the main query. + if ( $atts['include_type'] ) { + array_push( + $args['tax_query'], + array( + 'taxonomy' => self::CUSTOM_TAXONOMY_TYPE, + 'field' => 'slug', + 'terms' => $atts['include_type'], + ) + ); } - // If 'include_tag' has been set use it on the main query - if ( false != $atts['include_tag'] ) { - array_push( $args['tax_query'], array( - 'taxonomy' => self::CUSTOM_TAXONOMY_TAG, - 'field' => 'slug', - 'terms' => $atts['include_tag'], - ) ); + // If 'include_tag' has been set use it on the main query. + if ( $atts['include_tag'] ) { + array_push( + $args['tax_query'], + array( + 'taxonomy' => self::CUSTOM_TAXONOMY_TAG, + 'field' => 'slug', + 'terms' => $atts['include_tag'], + ) + ); } - if ( false != $atts['include_type'] && false != $atts['include_tag'] ) { + if ( $atts['include_type'] && $atts['include_tag'] ) { $args['tax_query']['relation'] = 'AND'; } - // Run the query and return + // Run the query and return. $query = new WP_Query( $args ); return $query; } @@ -690,52 +855,57 @@ class Jetpack_Portfolio { * The Portfolio shortcode loop. * * @todo add theme color styles + * + * @param array $atts Shortcode attributes. + * * @return html */ - static function portfolio_shortcode_html( $atts ) { - - $query = self::portfolio_query( $atts ); + private static function portfolio_shortcode_html( $atts ) { + $query = self::portfolio_query( $atts ); $portfolio_index_number = 0; ob_start(); - // If we have posts, create the html - // with hportfolio markup + /* + * If we have posts, create the html + * with portfolio markup + */ if ( $query->have_posts() ) { - - // Render styles - //self::themecolor_styles(); - - ?> + /* + * Render styles + * See self::themecolor_styles(); + */ + ?> <div class="jetpack-portfolio-shortcode column-<?php echo esc_attr( $atts['columns'] ); ?>"> - <?php // open .jetpack-portfolio + <?php + // open .jetpack-portfolio. // Construct the loop... while ( $query->have_posts() ) { $query->the_post(); $post_id = get_the_ID(); ?> - <div class="portfolio-entry <?php echo esc_attr( self::get_project_class( $portfolio_index_number, $atts['columns'] ) ); ?>"> + <div class="portfolio-entry <?php echo esc_attr( self::get_project_class( $portfolio_index_number, (int) $atts['columns'] ) ); ?>"> <header class="portfolio-entry-header"> <?php - // Featured image - echo self::get_portfolio_thumbnail_link( $post_id ); + // Featured image. + echo self::get_portfolio_thumbnail_link( $post_id ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- escaped in method. ?> - <h2 class="portfolio-entry-title"><a href="<?php echo esc_url( get_permalink() ); ?>" title="<?php echo esc_attr( the_title_attribute( ) ); ?>"><?php the_title(); ?></a></h2> + <h2 class="portfolio-entry-title"><a href="<?php echo esc_url( get_permalink() ); ?>" title="<?php echo esc_attr( the_title_attribute() ); ?>"><?php the_title(); ?></a></h2> <div class="portfolio-entry-meta"> <?php - if ( false != $atts['display_types'] ) { - echo self::get_project_type( $post_id ); + if ( $atts['display_types'] ) { + echo self::get_project_type( $post_id ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- escaped in method. } - if ( false != $atts['display_tags'] ) { - echo self::get_project_tags( $post_id ); + if ( $atts['display_tags'] ) { + echo self::get_project_tags( $post_id ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- escaped in method. } - if ( false != $atts['display_author'] ) { - echo self::get_project_author( $post_id ); + if ( $atts['display_author'] ) { + echo self::get_project_author( $post_id ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- escaped in method. } ?> </div> @@ -743,74 +913,77 @@ class Jetpack_Portfolio { </header> <?php - // The content - if ( false !== $atts['display_content'] ) { + // The content. + if ( $atts['display_content'] ) { add_filter( 'wordads_inpost_disable', '__return_true', 20 ); if ( 'full' === $atts['display_content'] ) { - ?> + ?> <div class="portfolio-entry-content"><?php the_content(); ?></div> - <?php + <?php } else { - ?> + ?> <div class="portfolio-entry-content"><?php the_excerpt(); ?></div> - <?php + <?php } remove_filter( 'wordads_inpost_disable', '__return_true', 20 ); } ?> </div><!-- close .portfolio-entry --> - <?php $portfolio_index_number++; - } // end of while loop + <?php + $portfolio_index_number++; + } // end of while loop. wp_reset_postdata(); ?> </div><!-- close .jetpack-portfolio --> - <?php - } else { ?> - <p><em><?php _e( 'Your Portfolio Archive currently has no entries. You can start creating them on your dashboard.', 'jetpack' ); ?></p></em> - <?php + <?php + } else { + ?> + <p><em><?php esc_html_e( 'Your Portfolio Archive currently has no entries. You can start creating them on your dashboard.', 'jetpack' ); ?></p></em> + <?php } $html = ob_get_clean(); - // If there is a [portfolio] within a [portfolio], remove the shortcode - if ( has_shortcode( $html, 'portfolio' ) ){ + // If there is a [portfolio] within a [portfolio], remove the shortcode. + if ( has_shortcode( $html, 'portfolio' ) ) { remove_shortcode( 'portfolio' ); } - // Return the HTML block + // Return the HTML block. return $html; } /** * Individual project class * + * @param int $portfolio_index_number Index number when looping through Portfolio items. + * @param int $columns Number of columns in shortcode output. * @return string */ - static function get_project_class( $portfolio_index_number, $columns ) { + private static function get_project_class( $portfolio_index_number, $columns ) { $project_types = wp_get_object_terms( get_the_ID(), self::CUSTOM_TAXONOMY_TYPE, array( 'fields' => 'slugs' ) ); - $class = array(); + $class = array(); - $class[] = 'portfolio-entry-column-'.$columns; - // add a type- class for each project type + $class[] = 'portfolio-entry-column-' . $columns; + // add a type- class for each project type. foreach ( $project_types as $project_type ) { $class[] = 'type-' . esc_html( $project_type ); } - if( $columns > 1) { - if ( ( $portfolio_index_number % 2 ) == 0 ) { + if ( $columns > 1 ) { + if ( ( $portfolio_index_number % 2 ) === 0 ) { $class[] = 'portfolio-entry-mobile-first-item-row'; } else { $class[] = 'portfolio-entry-mobile-last-item-row'; } } - // add first and last classes to first and last items in a row - if ( ( $portfolio_index_number % $columns ) == 0 ) { + // add first and last classes to first and last items in a row. + if ( ( $portfolio_index_number % $columns ) === 0 ) { $class[] = 'portfolio-entry-first-item-row'; - } elseif ( ( $portfolio_index_number % $columns ) == ( $columns - 1 ) ) { + } elseif ( ( $portfolio_index_number % $columns ) === ( $columns - 1 ) ) { $class[] = 'portfolio-entry-last-item-row'; } - /** * Filter the class applied to project div in the portfolio * @@ -821,27 +994,33 @@ class Jetpack_Portfolio { * @param string $class class name of the div. * @param int $portfolio_index_number iterator count the number of columns up starting from 0. * @param int $columns number of columns to display the content in. - * */ - return apply_filters( 'portfolio-project-post-class', implode( " ", $class ) , $portfolio_index_number, $columns ); + return apply_filters( + 'portfolio-project-post-class', // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores + implode( ' ', $class ), + $portfolio_index_number, + $columns + ); } /** * Displays the project type that a project belongs to. * + * @param int $post_id Post ID. + * * @return html */ - static function get_project_type( $post_id ) { + private static function get_project_type( $post_id ) { $project_types = get_the_terms( $post_id, self::CUSTOM_TAXONOMY_TYPE ); - // If no types, return empty string + // If no types, return empty string. if ( empty( $project_types ) || is_wp_error( $project_types ) ) { return; } - $html = '<div class="project-types"><span>' . __( 'Types', 'jetpack' ) . ':</span>'; + $html = '<div class="project-types"><span>' . __( 'Types:', 'jetpack' ) . '</span>'; $types = array(); - // Loop thorugh all the types + // Loop through all the types. foreach ( $project_types as $project_type ) { $project_type_link = get_term_link( $project_type, self::CUSTOM_TAXONOMY_TYPE ); @@ -851,7 +1030,7 @@ class Jetpack_Portfolio { $types[] = '<a href="' . esc_url( $project_type_link ) . '" rel="tag">' . esc_html( $project_type->name ) . '</a>'; } - $html .= ' '.implode( ', ', $types ); + $html .= ' ' . implode( ', ', $types ); $html .= '</div>'; return $html; @@ -860,19 +1039,21 @@ class Jetpack_Portfolio { /** * Displays the project tags that a project belongs to. * + * @param int $post_id Post ID. + * * @return html */ - static function get_project_tags( $post_id ) { + private static function get_project_tags( $post_id ) { $project_tags = get_the_terms( $post_id, self::CUSTOM_TAXONOMY_TAG ); - // If no tags, return empty string + // If no tags, return empty string. if ( empty( $project_tags ) || is_wp_error( $project_tags ) ) { return false; } - $html = '<div class="project-tags"><span>' . __( 'Tags', 'jetpack' ) . ':</span>'; + $html = '<div class="project-tags"><span>' . __( 'Tags:', 'jetpack' ) . '</span>'; $tags = array(); - // Loop thorugh all the tags + // Loop through all the tags. foreach ( $project_tags as $project_tag ) { $project_tag_link = get_term_link( $project_tag, self::CUSTOM_TAXONOMY_TYPE ); @@ -882,7 +1063,7 @@ class Jetpack_Portfolio { $tags[] = '<a href="' . esc_url( $project_tag_link ) . '" rel="tag">' . esc_html( $project_tag->name ) . '</a>'; } - $html .= ' '. implode( ', ', $tags ); + $html .= ' ' . implode( ', ', $tags ); $html .= '</div>'; return $html; @@ -893,10 +1074,11 @@ class Jetpack_Portfolio { * * @return html */ - static function get_project_author() { - $html = '<div class="project-author">'; - /* translators: %1$s is link to author posts, %2$s is author display name */ - $html .= sprintf( __( '<span>Author:</span> <a href="%1$s">%2$s</a>', 'jetpack' ), + private static function get_project_author() { + $html = '<div class="project-author">'; + $html .= sprintf( + /* translators: %1$s is link to author posts, %2$s is author display name */ + __( '<span>Author:</span> <a href="%1$s">%2$s</a>', 'jetpack' ), esc_url( get_author_posts_url( get_the_author_meta( 'ID' ) ) ), esc_html( get_the_author() ) ); @@ -908,9 +1090,11 @@ class Jetpack_Portfolio { /** * Display the featured image if it's available * + * @param int $post_id Post ID. + * * @return html */ - static function get_portfolio_thumbnail_link( $post_id ) { + private static function get_portfolio_thumbnail_link( $post_id ) { if ( has_post_thumbnail( $post_id ) ) { /** * Change the Portfolio thumbnail size. @@ -928,6 +1112,6 @@ class Jetpack_Portfolio { add_action( 'init', array( 'Jetpack_Portfolio', 'init' ) ); -// Check on plugin activation if theme supports CPT -register_activation_hook( __FILE__, array( 'Jetpack_Portfolio', 'activation_post_type_support' ) ); +// Check on plugin activation if theme supports CPT. +register_activation_hook( __FILE__, array( 'Jetpack_Portfolio', 'activation_post_type_support' ) ); add_action( 'jetpack_activate_module_custom-content-types', array( 'Jetpack_Portfolio', 'activation_post_type_support' ) ); |