functions.php

<?php
/**
 * Dones functions and definitions.
 *
 * @package dones
 */

if ( ! defined( 'ABSPATH' ) ) {
	die( 'Silence is golden.' );
}

require( dirname( __FILE__ ) . '/inc/tags.php' );
require( dirname( __FILE__ ) . '/inc/updater.php' );

/**
 * Returns the current version of the theme.
 *
 * @return string Theme version
 */
function dones_get_version() {
	$theme = wp_get_theme();
	return $theme->get( 'Version' );
}

/**
 * Sets up theme defaults and registers support for various WordPress features.
 */
function dones_setup() {
	/**
	 * Make theme available for translation.
	 */
	load_theme_textdomain( 'dones', get_template_directory() . '/languages' );

	/**
	 * Add theme supports.
	 */
	add_theme_support( 'title-tag' );
	add_theme_support( 'custom-logo', array(
		'width'  => 120,
		'height' => 120,
	) );
}
add_action( 'after_setup_theme', 'dones_setup' );

/**
 * Overrides theme locale to use user-configured locale if assigned.
 *
 * @param string $locale The theme's current locale.
 *
 * @return string The filtered locale.
 */
function dones_set_user_locale( $locale ) {
	if ( is_user_logged_in() ) {
		return get_user_locale();
	}

	return $locale;
}
add_filter( 'theme_locale', 'dones_set_user_locale' );

/**
 * Removes unsupported post types from admin menu.
 */
function dones_remove_unsupported_types_menu_items() {
	remove_menu_page( 'edit.php' );
	remove_menu_page( 'edit.php?post_type=page' );
	remove_menu_page( 'edit-comments.php' );
}
add_action( 'admin_menu', 'dones_remove_unsupported_types_menu_items' );

/**
 * Bypass default document title, deferred to be handled on client.
 *
 * @return string Title override (site name).
 */
function dones_custom_document_title() {
	return get_bloginfo( 'name', 'display' );
}
add_filter( 'pre_get_document_title', 'dones_custom_document_title' );

/**
 * Returns the configured brand color.
 *
 * @return string Brand color.
 */
function dones_get_brand_color() {
	return get_theme_mod( 'brand_color', '#986dda' );
}

/**
 * Enqueue scripts and styles.
 */
function dones_scripts() {
	// Theme stylesheet.
	wp_enqueue_style( 'dones-style', get_theme_file_uri( '/dist/style.css' ), array(), dones_get_version() );
	wp_add_inline_style( 'dones-style', sprintf( 'a { color: %s; }', esc_html( dones_get_brand_color() ) ) );

	// Custom logo with fallback.
	$custom_logo_id = get_theme_mod( 'custom_logo' );
	if ( $custom_logo_id ) {
		$logo = wp_get_attachment_image_url( $custom_logo_id, 'full' );
	} else {
		$logo = get_theme_file_uri( '/img/logo-white.svg' );
	}

	// Application script.
	wp_enqueue_script( 'dones-app', get_theme_file_uri( '/dist/app.js' ), array(), dones_get_version(), true );
	wp_enqueue_script( 'dones-legacy-app', get_theme_file_uri( '/dist/app-legacy.js' ), array(), dones_get_version(), true );
	wp_localize_script( 'dones-app', 'dones', array(
		'siteName'   => get_bloginfo( 'name' ),
		'siteUrl'    => site_url(),
		'apiRoot'    => esc_url_raw( untrailingslashit( get_rest_url() ) ),
		'apiNonce'   => wp_create_nonce( 'wp_rest' ),
		'brandColor' => dones_get_brand_color(),
		'logo'       => $logo,
		'gmtOffset'  => get_option( 'gmt_offset' ),
		'dateFormat' => get_option( 'date_format' ),
		'userId'     => get_current_user_id(),
		'loginUrl'   => wp_login_url( home_url() ),
		'logoutUrl'  => wp_logout_url( home_url() ),
		'preload'    => array_reduce( apply_filters( 'dones_preload', array(
			'/dones/v1/users',
		) ), 'dones_preload_request', array() ),
		'i18n'       => array(
			'An error occurred while saving'             => __( 'An error occurred while saving', 'dones' ),
			'Are you sure you want to delete this done?' => __( 'Are you sure you want to delete this done?', 'dones' ),
			'Cancel'                                     => __( 'Cancel', 'dones' ),
			'Date'                                       => __( 'Date', 'dones' ),
			'Delete'                                     => __( 'Delete', 'dones' ),
			'Done'                                       => __( 'Done', 'dones' ),
			'Done or goal'                               => __( 'Done or goal', 'dones' ),
			'Dones'                                      => __( 'Dones', 'dones' ),
			'Goal'                                       => __( 'Goal', 'dones' ),
			'Log In'                                     => __( 'Log In', 'dones' ),
			'Log Out'                                    => __( 'Log Out', 'dones' ),
			'Next'                                       => __( 'Next', 'dones' ),
			'No dones found for this tag'                => __( 'No dones found for this tag', 'dones' ),
			'No tags found'                              => __( 'No tags found', 'dones' ),
			'Nothing reported yet!'                      => __( 'Nothing reported yet!', 'dones' ),
			'Page Not Found'                             => __( 'Page Not Found', 'dones' ),
			'Pick Date'                                  => __( 'Pick Date', 'dones' ),
			'Previous'                                   => __( 'Previous', 'dones' ),
			'Recent Tags'                                => __( 'Recent Tags', 'dones' ),
			'Submit'                                     => __( 'Submit', 'dones' ),
			/* translators: Heading for tag detail page */
			'Tag: %s'                                    => __( 'Tag: %s', 'dones' ),
			'Tags'                                       => __( 'Tags', 'dones' ),
			'User avatar'                                => __( 'User avatar', 'dones' ),
			'What have you been up to?'                  => __( 'What have you been up to?', 'dones' ),
			'No dones found for this tag'                => __( 'No dones found for this tag', 'dones' ),
			'Changes you made may not be saved.'         => __( 'Changes you made may not be saved.', 'dones' ),
		),
	) );
}
add_action( 'wp_enqueue_scripts', 'dones_scripts' );

/**
 * Overrides the script loader tag to set "type='module'" or add a "nomodule"
 * attribute to serve scripts by browser support of ES modules.
 *
 * @see WP_Scripts::do_item
 * @see https://philipwalton.com/articles/deploying-es2015-code-in-production-today/
 * @see https://caniuse.com/#feat=es6-module
 *
 * @param  string $tag    The `<script>` tag for the enqueued script.
 * @param  string $handle The script's registered handle.
 * @return string         Filtered HTML script tag for the enqueued script.
 */
function dones_set_script_module_attribute( $tag, $handle ) {
	// Override only Dones script handles.
	if ( 0 !== strpos( $handle, 'dones-' ) ) {
		return $tag;
	}

	// Add "nomodule" attribute for legacy scripts.
	$is_legacy = 0 === strpos( $handle, 'dones-legacy-' );
	if ( $is_legacy ) {
		return str_replace( ' src', ' nomodule src', $tag );
	}

	// Set type to "module" for non-legacy scripts.
	return str_replace( 'type=\'text/javascript\' src', 'type=\'module\' src', $tag );
}
add_filter( 'script_loader_tag', 'dones_set_script_module_attribute', 10, 3 );

/**
 * Append result of internal request to REST API for purpose of preloading
 * data to be attached to the page. Expected to be called in the context of
 * `array_reduce`.
 *
 * @param  array  $memo Reduce accumulator.
 * @param  string $path REST API path to preload.
 * @return array        Modified reduce accumulator.
 */
function dones_preload_request( $memo, $path ) {
	$path_parts = parse_url( $path );

	$request = new WP_REST_Request( 'GET', $path_parts['path'] );
	if ( ! empty( $path_parts['query'] ) ) {
		parse_str( $path_parts['query'], $query_params );
		$request->set_query_params( $query_params );
	}

	$response = rest_do_request( $request );
	if ( 200 === $response->status ) {
		$memo[ $path ] = array(
			'body'    => $response->data,
			'headers' => $response->headers,
		);
	}

	return $memo;
}

/**
 * Overrides default preload behavior to include additional data on specific
 * page or in the presence of rewrite query arguments.
 *
 * @param  array $paths REST API paths to preload.
 * @return array        Filtered API paths to preload.
 */
function dones_page_specific_preload( $paths ) {
	global $wp_query;

	// Dones.
	$date = get_query_var( 'dones_date' );
	if ( ! empty( $date ) ) {
		$paths[] = sprintf( '/dones/v1/dones?date=%s', $date );
	}

	// Single tag.
	$tag = get_query_var( 'dones_tag' );
	if ( ! empty( $tag ) ) {
		$page = get_query_var( 'paged' );
		if ( empty( $page ) ) {
			$page = 1;
		}

		$paths[] = sprintf( '/dones/v1/dones?tag=%s&page=%d', $tag, $page );
	}

	// Tag root or single tag.
	if ( isset( $wp_query->query_vars['dones_tag'] ) ) {
		$paths[] = '/dones/v1/tags';
	}

	return $paths;
}
add_filter( 'dones_preload', 'dones_page_specific_preload' );

/**
 * Add custom fields to the Theme Customizer.
 *
 * @param WP_Customize_Manager $wp_customize WP_Customize_Manager instance.
 */
function dones_customize_register( $wp_customize ) {
	// Brand color.
	$wp_customize->add_setting( 'brand_color', array(
		'default'           => '#986dda',
		'sanitize_callback' => 'sanitize_hex_color',
	) );

	$wp_customize->add_control( new WP_Customize_Color_Control(
		$wp_customize,
		'brand_color',
		array(
			'label'    => __( 'Brand Color', 'dones' ),
			'section'  => 'colors',
			'priority' => 5,
		)
	) );
}
add_action( 'customize_register', 'dones_customize_register' );

/**
 * Initialize Dones REST API controllers.
 */
function dones_create_rest_routes() {
	// Tags.
	require_once( dirname( __FILE__ ) . '/inc/endpoints/class-wp-rest-dones-tags-controller.php' );
	$controller = new WP_REST_Dones_Tags_Controller;

	// Dones.
	require_once( dirname( __FILE__ ) . '/inc/endpoints/class-wp-rest-dones-dones-controller.php' );
	$controller = new WP_REST_Dones_Dones_Controller;

	// Users.
	require_once( dirname( __FILE__ ) . '/inc/endpoints/class-wp-rest-dones-users-controller.php' );
	$controller = new WP_REST_Dones_Users_Controller;
	$controller->register_routes();
}
add_action( 'rest_api_init', 'dones_create_rest_routes' );

/**
 * Add rewrite rules for custom route patterns.
 */
function dones_add_rewrite_rules() {
	add_rewrite_rule( '^date(/(\d{4}-\d{2}-\d{2}))?/?$', 'index.php?dones_date=$matches[2]', 'top' );
	add_rewrite_rule( '^tags(/([^\s\.,;!\?/]+)(/page/(\d+))?)?/?$', 'index.php?dones_tag=$matches[2]&paged=$matches[4]', 'top' );

	if ( in_array( current_filter(), array( 'after_switch_theme', 'upgrader_process_complete' ) ) ) {
		flush_rewrite_rules();
	}
}
add_action( 'init', 'dones_add_rewrite_rules' );
add_action( 'after_switch_theme', 'dones_add_rewrite_rules' );
add_action( 'upgrader_process_complete', 'dones_add_rewrite_rules' );

/**
 * Add query variables from custom route patterns.
 *
 * @param  array $query_vars Original query variables.
 * @return array             Modified query variables.
 */
function dones_add_custom_query_vars( $query_vars ) {
	$query_vars[] = 'dones_date';
	$query_vars[] = 'dones_tag';
	return $query_vars;
}
add_filter( 'query_vars', 'dones_add_custom_query_vars' );

/**
 * Redirect to current date for root path requests.
 */
function dones_home_redirect() {
	global $wp;
	if ( home_url() === home_url( $wp->request ) ) {
		wp_safe_redirect( home_url( '/date/' . current_time( 'Y-m-d' ) ) );
		exit;
	}
}
add_action( 'template_redirect', 'dones_home_redirect' );

/**
 * Allow user listing endpoint to include all users, regardless of role and
 * whether published posts exist for the user.
 *
 * @see WP_REST_Users_Controller::get_items
 *
 * @param  array $args Array of arguments for WP_User_Query.
 * @return array       Filtered array of arguments for WP_User_Query.
 */
function dones_allow_list_user( $args ) {
	unset( $args['has_published_posts'] );
	return $args;
}
add_filter( 'rest_user_query', 'dones_allow_list_user' );

/**
 * Register custom post types and taxonomies.
 */
function dones_register_custom_types() {
	// Done custom post type.
	register_post_type( 'done', array(
		'labels'                => array(
			'name'               => _x( 'Dones', 'post type general name', 'dones' ),
			'singular_name'      => _x( 'Done', 'post type singular name', 'dones' ),
			'menu_name'          => _x( 'Dones', 'admin menu', 'dones' ),
			'name_admin_bar'     => _x( 'Done', 'add new on admin bar', 'dones' ),
			'add_new'            => _x( 'Add New', 'done', 'dones' ),
			'add_new_item'       => __( 'Add New Done', 'dones' ),
			'new_item'           => __( 'New Done', 'dones' ),
			'edit_item'          => __( 'Edit Done', 'dones' ),
			'view_item'          => __( 'View Done', 'dones' ),
			'all_items'          => __( 'All Dones', 'dones' ),
			'search_items'       => __( 'Search Dones', 'dones' ),
			'parent_item_colon'  => null,
			'not_found'          => __( 'No dones found.', 'dones' ),
			'not_found_in_trash' => __( 'No dones found in Trash.', 'dones' ),
		),
		'description'           => __( 'Tasks completed or to be completed.', 'dones' ),
		'public'                => true,
		'show_ui'               => true,
		'has_archive'           => false,
		'show_in_menu'          => true,
		'menu_icon'             => 'dashicons-list-view',
		'menu_position'         => 5,
		'exclude_from_search'   => true,
		'capability_type'       => 'post',
		'show_in_rest'          => true,
		'rest_controller_class' => 'WP_REST_Dones_Dones_Controller',
		'capability_type'       => array( 'done', 'dones' ),
		'rewrite'               => false,
		'query_var'             => false,
		'supports'              => array( 'title', 'author' ),
	) );

	// Done tag custom taxonomy.
	register_taxonomy( 'done-tag', 'done', array(
		'labels'                => array(
			'name'              => _x( 'Done Tags', 'taxonomy general name', 'dones' ),
			'singular_name'     => _x( 'Done Tag', 'taxonomy singular name', 'dones' ),
			'search_items'      => __( 'Search Done Tags', 'dones' ),
			'all_items'         => __( 'All Done Tags', 'dones' ),
			'parent_item'       => null,
			'parent_item_colon' => null,
			'edit_item'         => __( 'Edit Done Tag', 'dones' ),
			'update_item'       => __( 'Update Done Tag', 'dones' ),
			'add_new_item'      => __( 'Add New Done Tag', 'dones' ),
			'new_item_name'     => __( 'New Done Tag Name', 'dones' ),
			'menu_name'         => __( 'Done Tag', 'dones' ),
		),
		'rewrite'               => false,
		'show_ui'               => true,
		'show_admin_column'     => true,
		'query_var'             => false,
		'public'                => true,
		'show_in_rest'          => true,
		'rest_controller_class' => 'WP_REST_Dones_Tags_Controller',
		'update_count_callback' => '_update_post_term_count',
		'capabilities'          => array(
			'manage_terms' => 'manage_done-tags',
			'edit_terms'   => 'manage_done-tags',
			'delete_terms' => 'manage_done-tags',
			'assign_terms' => 'edit_dones',
		),
	) );
}
add_action( 'init', 'dones_register_custom_types' );

/**
 * Returns an updated array of all user capabilities when testing whether
 * particular values exist, used in assigning a fallback capability value to
 * the default post type when dones type custom capability is not assigned.
 *
 * @see WP_User::has_cap()
 *
 * @param  array $allcaps An array of all the user's capabilities.
 * @param  array $caps    Actual capabilities for meta capability.
 * @return array          Updated array of all the user's capabilities.
 */
function dones_dones_cap_fallback( $allcaps, $caps ) {
	foreach ( $caps as $cap ) {
		switch ( $cap ) {
			case 'edit_done':
			case 'read_done':
			case 'delete_done':
			case 'edit_dones':
			case 'edit_others_dones':
			case 'publish_dones':
			case 'read_private_dones':
			case 'manage_done-tags':
				// Bail if already assigned.
				if ( isset( $allcaps[ $cap ] ) ) {
					break 2;
				}

				// Try value of equivalent "post" or "category" capability.
				// Force singular post capability to multi, since this is
				// normally handled by meta mapping.
				$fallback_cap = str_replace( '_done-tags', '_categories', $cap );
				$fallback_cap = str_replace( '_dones', '_posts', $fallback_cap );
				$fallback_cap = str_replace( '_done', '_posts', $fallback_cap );
				if ( ! empty( $allcaps[ $fallback_cap ] ) ) {
					$allcaps[ $cap ] = true;
				}
		}
	}

	return $allcaps;
}
add_filter( 'user_has_cap', 'dones_dones_cap_fallback', 10, 2 );

/**
 * Suppresses main query, since we don't use it.
 *
 * @param  string   $request The complete SQL query.
 * @param  WP_Query $query   The WP_Query instance (passed by reference).
 * @return string|bool       The complete SQL query, or false if main query.
 */
function dones_disable_main_query( $request, $query ) {
	if ( $query->is_main_query() && ! is_admin() ) {
		return false;
	}

	return $request;
}
add_action( 'posts_request', 'dones_disable_main_query', 10, 2 );

/**
 * Removes the Done Tags column from the manage (admin) list view.
 *
 * @param array $columns An array of column names.
 * @return array         Filtered array of column names.
 */
function dones_remove_tags_manage_column( $columns ) {
	unset( $columns['taxonomy-done-tag'] );
	$columns['title'] = _x( 'Done Text', 'manage column name', 'dones' );
	return $columns;
}
add_filter( 'manage_done_posts_columns', 'dones_remove_tags_manage_column' );

/**
 * Filters the default rewrite rules array, returning only those explicitly
 * supported by the theme.
 *
 * @param  array $rules Original rewrite rules.
 * @return array        Revised rewrite rules.
 */
function dones_filter_supported_rewrites( $rules ) {
	$rules_to_keep = array(
		// Default rules.
		'^wp-json/?$',
		'^wp-json/(.*)?',
		'robots\.txt$',
		'feed/(feed|rdf|rss|rss2|atom)/?$',
		'(feed|rdf|rss|rss2|atom)/?$',
		'embed/?$',

		// Dones rules.
		'^date(/(\d{4}-\d{2}-\d{2}))?/?$',
		'^tags(/([^\s\.,;!\?/]+)(/page/(\d+))?)?/?$',
	);

	$filtered_rules = array();
	foreach ( $rules_to_keep as $key ) {
		$filtered_rules[ $key ] = $rules[ $key ];
	}

	return $filtered_rules;
}
add_filter( 'rewrite_rules_array', 'dones_filter_supported_rewrites' );

/**
 * Bypass default 404 handling since we know posts data isn't available until
 * preload logic.
 *
 * @param bool $preempt Whether to short-circuit default header status
 *                      handling. Default false.
 * @return bool         Whether to short-circuit default header status
 *                      handling.
 */
function dones_avoid_paged_tags_404( $preempt ) {
	foreach ( array( 'dones_date', 'dones_tag' ) as $var ) {
		$query_var = get_query_var( $var );
		if ( ! empty( $query_var ) ) {
			status_header( 200 );
			return true;
		}
	}

	return $preempt;
}
add_filter( 'pre_handle_404', 'dones_avoid_paged_tags_404' );

/**
 * Reassigns tags for done post upon save, generated from title.
 *
 * @param int     $post_id Post ID.
 * @param WP_Post $post    Post object.
 */
function dones_assign_done_tags( $post_id, $post ) {
	preg_match_all( '/(^|[\s\.,;!\?])#([^\s\.,;!\?]+)/', $post->post_title, $tag_matches );
	$tags = $tag_matches[2];
	wp_set_post_terms( $post_id, $tags, 'done-tag' );
}
add_action( 'save_post_done', 'dones_assign_done_tags', 10, 2 );

/**
 * Returns a default icon URL resource if a site icon isn't configured.
 *
 * @param  string $url  Site icon URL.
 * @param  int    $size Size of the site icon.
 * @return string       Site icon URL, or default value.
 */
function dones_default_site_icon( $url, $size ) {
	$icon_sizes = array( 32, 180, 192, 270, 512 );
	if ( empty( $url ) && in_array( $size, $icon_sizes ) ) {
		return get_theme_file_uri( sprintf( '/img/icon-%d.png', $size ) );
	}

	return $url;
}
add_filter( 'get_site_icon_url', 'dones_default_site_icon', 10, 2 );

/**
 * Unenqueues the default `wp-embed` script, since we're not expecting embeds
 * to be shown (a small page load optimization).
 */
function dones_unenqueue_embeds() {
	wp_deregister_script( 'wp-embed' );
}
add_action( 'wp_footer', 'dones_unenqueue_embeds' );

/**
 * Dequeues default scripts and styles which aren't expected to be used, as an
 * optimization.
 */
function dones_dequeue_unused_scripts_and_styles() {
	wp_dequeue_style( 'wp-block-library' );
}
add_action( 'wp_enqueue_scripts', 'dones_dequeue_unused_scripts_and_styles' );

/**
 * Adds inline style to customize the login form logo.
 */
function dones_login_css() {
	echo sprintf(
		'<style>.login h1 a { background-image: url( %s ); }</style>',
		get_theme_file_uri( '/img/logo.svg' )
	);
}
add_action( 'login_head', 'dones_login_css' );

/**
 * Displays the "About Dones" admin screen.
 */
function dones_render_about() {
	wp_enqueue_style(
		'dones-about',
		get_theme_file_uri( '/inc/admin/about.css' ),
		array(),
		dones_get_version()
	);

	include dirname( __FILE__ ) . '/inc/admin/about.php';
}

/**
 * Registers the "About Dones" admin screen.
 */
function dones_add_about_page() {
	add_theme_page(
		__( 'About Dones', 'dones' ),
		__( 'About Dones', 'dones' ),
		'read',
		'about-dones',
		'dones_render_about'
	);
}
add_action( 'admin_menu', 'dones_add_about_page' );

/**
 * Redirects to the "About Dones" admin screen when theme is activated.
 */
function dones_redirect_theme_activation() {
	if ( is_admin() && isset( $_GET['activated'] ) && 'themes.php' == $GLOBALS['pagenow'] ) {
		wp_redirect( admin_url( 'themes.php?page=about-dones' ) );
		exit();
	}
}
add_action( 'init', 'dones_redirect_theme_activation' );

/**
 * Remove emoji scripts, which are not compatible with dynamic re-rendering.
 */
remove_action( 'wp_head', 'print_emoji_detection_script', 7 );
remove_action( 'wp_print_styles', 'print_emoji_styles' );