# edit-flow/0.7.2/modules/notifications/notifications.php Edit Flow, version 0.7.2. 963 lines. - Page: https://pluginprobe.com/plugins/edit-flow/0.7.2/code/modules/notifications/notifications.php - Raw: https://pluginprobe.com/plugins/edit-flow/0.7.2/raw/modules/notifications/notifications.php - Modified: 2012-07-03T20:18:16+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/edit-flow/0.7.2/code/modules/notifications/notifications.php#L10-L20`. ```php module_url = $this->get_module_url( __FILE__ ); $args = array( 'title' => __( 'Notifications', 'edit-flow' ), 'short_description' => __( 'Update your team of important changes to your content.', 'edit-flow' ), 'extended_description' => __( 'With email notifications, you can keep everyone updated about what’s happening with a given content. Each status change or editorial comment sends out an email notification to users subscribed to a post. User groups can be used to manage who receives notifications on what.', 'edit-flow' ), 'module_url' => $this->module_url, 'img_url' => $this->module_url . 'lib/notifications_s128.png', 'slug' => 'notifications', 'default_options' => array( 'enabled' => 'on', 'post_types' => array( 'post' => 'on', 'page' => 'on', ), 'always_notify_admin' => 'off', ), 'configure_page_cb' => 'print_configure_view', 'post_type_support' => 'ef_notification', 'autoload' => false, 'settings_help_tab' => array( 'id' => 'ef-notifications-overview', 'title' => __('Overview', 'edit-flow'), 'content' => __('

Notifications ensure you keep up to date with progress your most important content. Users can be subscribed to notifications on a post one by one or by selecting user groups.

When enabled, email notifications can be sent when a post changes status or an editorial comment is left by a writer or an editor.

', 'edit-flow'), ), 'settings_help_sidebar' => __( '

For more information:

Notifications Documentation

Edit Flow Forum

Edit Flow on Github

', 'edit-flow' ), ); $this->module = $edit_flow->register_module( 'notifications', $args ); } /** * Initialize the notifications class if the plugin is enabled */ function init() { // Register our taxonomies for managing relationships $this->register_taxonomies(); // Allow users to use a different user capability for editing post subscriptions $this->edit_post_subscriptions_cap = apply_filters( 'ef_edit_post_subscriptions_cap', $this->edit_post_subscriptions_cap ); // Set up metabox and related actions add_action( 'add_meta_boxes', array( $this, 'add_post_meta_box' ) ); // Saving post actions // self::save_post_subscriptions() is hooked into transition_post_status so we can ensure usergroup data // is properly saved before sending notifs add_action( 'transition_post_status', array( $this, 'save_post_subscriptions' ), 0, 3 ); add_action( 'transition_post_status', array( $this, 'notification_status_change' ), 10, 3 ); add_action( 'ef_post_insert_editorial_comment', array( $this, 'notification_comment') ); add_action( 'delete_user', array($this, 'delete_user_action') ); add_action( 'ef_send_scheduled_email', array( $this, 'send_single_email' ), 10, 4 ); add_action( 'admin_init', array( $this, 'register_settings' ) ); // Javascript and CSS if we need it add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) ); add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) ); } /** * Load the capabilities onto users the first time the module is run * * @since 0.7 */ function install() { // Add necessary capabilities to allow management of notifications $notifications_roles = array( 'administrator' => array('edit_post_subscriptions'), 'editor' => array('edit_post_subscriptions'), 'author' => array('edit_post_subscriptions'), ); foreach ( $notifications_roles as $role => $caps ) { $this->add_caps_to_role( $role, $caps ); } } /** * Upgrade our data in case we need to * * @since 0.7 */ function upgrade( $previous_version ) { global $edit_flow; // Upgrade path to v0.7 if ( version_compare( $previous_version, '0.7' , '<' ) ) { // Migrate whether notifications were enabled or not if ( $enabled = get_option( 'edit_flow_notifications_enabled' ) ) $enabled = 'on'; else $enabled = 'off'; $edit_flow->update_module_option( $this->module->name, 'enabled', $enabled ); delete_option( 'edit_flow_notifications_enabled' ); // Migrate whether to always notify the admin if ( $always_notify_admin = get_option( 'edit_flow_always_notify_admin' ) ) $always_notify_admin = 'on'; else $always_notify_admin = 'off'; $edit_flow->update_module_option( $this->module->name, 'always_notify_admin', $always_notify_admin ); delete_option( 'edit_flow_always_notify_admin' ); // Technically we've run this code before so we don't want to auto-install new data $edit_flow->update_module_option( $this->module->name, 'loaded_once', true ); } } /** * Register the taxonomies we use to manage relationships * * @since 0.7 * * @uses register_taxonomy() */ function register_taxonomies() { // Load the currently supported post types so we only register against those $supported_post_types = $this->get_post_types_for_module( $this->module ); $args = array( 'hierarchical' => false, 'update_count_callback' => '_update_post_term_count', 'label' => false, 'query_var' => false, 'rewrite' => false, 'show_ui' => false ); foreach( array( $this->following_users_taxonomy, $this->unfollowing_users_taxonomy ) as $taxonomy ) { register_taxonomy( $taxonomy, $supported_post_types, $args ); } } /** * Enqueue necessary admin scripts * * @since 0.7 * * @uses wp_enqueue_script() */ function enqueue_admin_scripts() { if ( $this->is_whitelisted_functional_view() ) { wp_enqueue_script( 'jquery-listfilterizer' ); wp_enqueue_script( 'jquery-quicksearch' ); wp_enqueue_script( 'edit-flow-notifications-js', $this->module_url . 'lib/notifications.js', array( 'jquery', 'jquery-listfilterizer', 'jquery-quicksearch' ), EDIT_FLOW_VERSION, true ); } } /** * Enqueue necessary admin styles, but only on the proper pages * * @since 0.7 * * @uses wp_enqueue_style() */ function enqueue_admin_styles() { if ( $this->is_whitelisted_functional_view() || $this->is_whitelisted_settings_view() ) { wp_enqueue_style( 'jquery-listfilterizer' ); wp_enqueue_style( 'edit-flow-notifications-css', $this->module->module_url . 'lib/notifications.css', false, EDIT_FLOW_VERSION ); } } /** * Add the subscriptions meta box to relevant post types */ function add_post_meta_box() { if ( !current_user_can( $this->edit_post_subscriptions_cap ) ) return; $usergroup_post_types = $this->get_post_types_for_module( $this->module ); foreach ( $usergroup_post_types as $post_type ) { add_meta_box( 'edit-flow-notifications', __( 'Notifications', 'edit-flow'), array( $this, 'notifications_meta_box'), $post_type, 'advanced' ); } } /** * Outputs box used to subscribe users and usergroups to Posts * * @todo add_cap to set subscribers for posts; default to Admin and editors */ function notifications_meta_box() { global $post, $post_ID, $edit_flow; ?>

get_following_users( $post->ID, 'id' ); $select_form_args = array( 'list_class' => 'ef-post_following_list', ); $this->users_select_form( $followers, $select_form_args ); ?>
module_enabled( 'user_groups' ) && in_array( $this->get_current_post_type(), $this->get_post_types_for_module( $edit_flow->user_groups->module ) ) ): ?>

get_following_usergroups( $post->ID, 'ids' ); $edit_flow->user_groups->usergroups_select_form( $following_usergroups ); ?>
edit_post_subscriptions_cap ) ) { $users = isset( $_POST['ef-selected-users'] ) ? $_POST['ef-selected-users'] : array(); $usergroups = isset( $_POST['following_usergroups'] ) ? $_POST['following_usergroups'] : array(); $this->save_post_following_users( $post, $users ); if ( $this->module_enabled( 'user_groups' ) && in_array( $this->get_current_post_type(), $this->get_post_types_for_module( $edit_flow->user_groups->module ) ) ) $this->save_post_following_usergroups( $post, $usergroups ); } } /** * Sets users to follow specified post * * @param int $post ID of the post */ function save_post_following_users( $post, $users = null ) { if( !is_array( $users ) ) $users = array(); // Add current user to following users $user = wp_get_current_user(); if ( $user && apply_filters( 'ef_notification_auto_subscribe_current_user', true, 'subscription_action' ) ) $users[] = $user->ID; // Add post author to following users if ( apply_filters( 'ef_notification_auto_subscribe_post_author', true, 'subscription_action' ) ) $users[] = $post->post_author; $users = array_unique( array_map( 'intval', $users ) ); $follow = $this->follow_post_user( $post, $users, false ); } /** * Sets usergroups to follow specified post * * @param int $post ID of the post * @param array $usergroups Usergroups to follow posts */ function save_post_following_usergroups( $post, $usergroups = null ) { if( !is_array($usergroups) ) $usergroups = array(); $usergroups = array_map( 'intval', $usergroups ); $follow = $this->follow_post_usergroups($post, $usergroups, false); } /** * Set up and send post status change notification email */ function notification_status_change( $new_status, $old_status, $post ) { global $edit_flow; // Kill switch for notification if ( ! apply_filters( 'ef_notification_status_change', $new_status, $old_status, $post ) || ! apply_filters( "ef_notification_{$post->post_type}_status_change", $new_status, $old_status, $post ) ) return false; $supported_post_types = $this->get_post_types_for_module( $this->module ); if ( !in_array( $post->post_type, $supported_post_types ) ) return; // No need to notify if it's a revision, auto-draft, or if post status wasn't changed $ignored_statuses = apply_filters( 'ef_notification_ignored_statuses', array( $old_status, 'inherit', 'auto-draft' ), $post->post_type ); if ( !in_array( $new_status, $ignored_statuses ) ) { // Get current user $current_user = wp_get_current_user(); $post_author = get_userdata( $post->post_author ); //$duedate = $edit_flow->post_metadata->get_post_meta($post->ID, 'duedate', true); $blogname = get_option('blogname'); $body = ''; $post_id = $post->ID; $post_title = ef_draft_or_post_title( $post_id ); $post_type = ucwords( $post->post_type ); if( 0 != $current_user->ID ) { $current_user_display_name = $current_user->display_name; $current_user_email = sprintf( '(%s)', $current_user->user_email ); } else { $current_user_display_name = __( 'WordPress Scheduler', 'edit-flow' ); $current_user_email = ''; } // Email subject and first line of body // Set message subjects according to what action is being taken on the Post if ( $old_status == 'new' || $old_status == 'auto-draft' ) { /* translators: 1: site name, 2: post type, 3. post title */ $subject = sprintf( __( '[%1$s] New %2$s Created: "%3$s"', 'edit-flow' ), $blogname, $post_type, $post_title ); /* translators: 1: post type, 2: post id, 3. post title, 4. user name, 5. user email */ $body .= sprintf( __( 'A new %1$s (#%2$s "%3$s") was created by %4$s %5$s', 'edit-flow' ), $post_type, $post_id, $post_title, $current_user->display_name, $current_user->user_email ) . "\r\n"; } else if ( $new_status == 'trash' ) { /* translators: 1: site name, 2: post type, 3. post title */ $subject = sprintf( __( '[%1$s] %2$s Trashed: "%3$s"', 'edit-flow' ), $blogname, $post_type, $post_title ); /* translators: 1: post type, 2: post id, 3. post title, 4. user name, 5. user email */ $body .= sprintf( __( '%1$s #%2$s "%3$s" was moved to the trash by %4$s %5$s', 'edit-flow' ), $post_type, $post_id, $post_title, $current_user_display_name, $current_user_email ) . "\r\n"; } else if ( $old_status == 'trash' ) { /* translators: 1: site name, 2: post type, 3. post title */ $subject = sprintf( __( '[%1$s] %2$s Restored (from Trash): "%3$s"', 'edit-flow' ), $blogname, $post_type, $post_title ); /* translators: 1: post type, 2: post id, 3. post title, 4. user name, 5. user email */ $body .= sprintf( __( '%1$s #%2$s "%3$s" was restored from trash by %4$s %5$s', 'edit-flow' ), $post_type, $post_id, $post_title, $current_user_display_name, $current_user_email ) . "\r\n"; } else if ( $new_status == 'future' ) { /* translators: 1: site name, 2: post type, 3. post title */ $subject = sprintf( __('[%1$s] %2$s Scheduled: "%3$s"'), $blogname, $post_type, $post_title ); /* translators: 1: post type, 2: post id, 3. post title, 4. user name, 5. user email */ $body .= sprintf( __( '%1$s #%2$s "%3$s" was scheduled by %4$s %5$s' ), $post_type, $post_id, $post_title, $current_user_display_name, $current_user_email ) . "\r\n"; } else if ( $new_status == 'publish' ) { /* translators: 1: site name, 2: post type, 3. post title */ $subject = sprintf( __( '[%1$s] %2$s Published: "%3$s"', 'edit-flow' ), $blogname, $post_type, $post_title ); /* translators: 1: post type, 2: post id, 3. post title, 4. user name, 5. user email */ $body .= sprintf( __( '%1$s #%2$s "%3$s" was published by %4$s %5$s', 'edit-flow' ), $post_type, $post_id, $post_title, $current_user_display_name, $current_user_email ) . "\r\n"; } else if ( $old_status == 'publish' ) { /* translators: 1: site name, 2: post type, 3. post title */ $subject = sprintf( __( '[%1$s] %2$s Unpublished: "%3$s"', 'edit-flow' ), $blogname, $post_type, $post_title ); /* translators: 1: post type, 2: post id, 3. post title, 4. user name, 5. user email */ $body .= sprintf( __( '%1$s #%2$s "%3$s" was unpublished by %4$s %5$s', 'edit-flow' ), $post_type, $post_id, $post_title, $current_user_display_name, $current_user_email ) . "\r\n"; } else { /* translators: 1: site name, 2: post type, 3. post title */ $subject = sprintf( __( '[%1$s] %2$s Status Changed for "%3$s"', 'edit-flow' ), $blogname, $post_type, $post_title ); /* translators: 1: post type, 2: post id, 3. post title, 4. user name, 5. user email */ $body .= sprintf( __( 'Status was changed for %1$s #%2$s "%3$s" by %4$s %5$s', 'edit-flow'), $post_type, $post_id, $post_title, $current_user_display_name, $current_user_email ) . "\r\n"; } /* translators: 1: date, 2: time, 3: timezone */ $body .= sprintf( __( 'This action was taken on %1$s at %2$s %3$s', 'edit-flow' ), date_i18n( get_option( 'date_format' ) ), date_i18n( get_option( 'time_format' ) ), get_option( 'timezone_string' ) ) . "\r\n"; $old_status_friendly_name = $this->get_post_status_friendly_name( $old_status ); $new_status_friendly_name = $this->get_post_status_friendly_name( $new_status ); // Email body $body .= "\r\n"; /* translators: 1: old status, 2: new status */ $body .= sprintf( __( '%1$s => %2$s', 'edit-flow' ), $old_status_friendly_name, $new_status_friendly_name ); $body .= "\r\n\r\n"; $body .= "--------------------\r\n\r\n"; $body .= sprintf( __( '== %s Details ==', 'edit-flow' ), $post_type ) . "\r\n"; $body .= sprintf( __( 'Title: %s', 'edit-flow' ), $post_title ) . "\r\n"; /* translators: 1: author name, 2: author email */ $body .= sprintf( __( 'Author: %1$s (%2$s)', 'edit-flow' ), $post_author->display_name, $post_author->user_email ) . "\r\n"; $edit_link = htmlspecialchars_decode( get_edit_post_link( $post_id ) ); if ( $new_status != 'publish' ) { $preview_nonce = wp_create_nonce( 'post_preview_' . $post_id ); $view_link = add_query_arg( array( 'preview' => true, 'preview_id' => $post_id, 'preview_nonce' => $preview_nonce ), get_permalink($post_id) ); } else { $view_link = htmlspecialchars_decode( get_permalink( $post_id ) ); } $body .= "\r\n"; $body .= __( '== Actions ==', 'edit-flow' ) . "\r\n"; $body .= sprintf( __( 'Add editorial comment: %s', 'edit-flow' ), $edit_link . '#editorialcomments/add' ) . "\r\n"; $body .= sprintf( __( 'Edit: %s', 'edit-flow' ), $edit_link ) . "\r\n"; $body .= sprintf( __( 'View: %s', 'edit-flow' ), $view_link ) . "\r\n"; $body .= $this->get_notification_footer($post); $this->send_email( 'status-change', $post, $subject, $body ); } } /** * Set up and set editorial comment notification email */ function notification_comment( $comment ) { $post = get_post($comment->comment_post_ID); $supported_post_types = $this->get_post_types_for_module( $this->module ); if ( !in_array( $post->post_type, $supported_post_types ) ) return; // Kill switch for notification if ( ! apply_filters( 'ef_notification_editorial_comment', $comment, $post ) ) return false; $user = get_userdata( $post->post_author ); $current_user = wp_get_current_user(); $post_id = $post->ID; $post_type = ucwords( $post->post_type ); $post_title = ef_draft_or_post_title( $post_id ); // Check if this a reply //$parent_ID = isset( $comment->comment_parent_ID ) ? $comment->comment_parent_ID : 0; //if($parent_ID) $parent = get_comment($parent_ID); // Set user to follow post, but make it filterable if ( apply_filters( 'ef_notification_auto_subscribe_current_user', true, 'comment' ) ) $this->follow_post_user($post, (int) $current_user->ID); // Set the post author to follow the post but make it filterable if ( apply_filters( 'ef_notification_auto_subscribe_post_author', true, 'comment' ) ) $this->follow_post_user( $post, (int) $post->post_author ); $blogname = get_option('blogname'); /* translators: 1: blog name, 2: post title */ $subject = sprintf( __( '[%1$s] New Editorial Comment: "%2$s"', 'edit-flow' ), $blogname, $post_title ); /* translators: 1: post id, 2: post title, 3. post type */ $body = sprintf( __( 'A new editorial comment was added to %3$s #%1$s "%2$s"', 'edit-flow' ), $post_id, $post_title, $post_type ) . "\r\n\r\n"; /* translators: 1: comment author, 2: author email, 3: date, 4: time */ $body .= sprintf( __( '%1$s (%2$s) said on %3$s at %4$s:', 'edit-flow' ), $current_user->display_name, $current_user->user_email, mysql2date(get_option('date_format'), $comment->comment_date), mysql2date(get_option('time_format'), $comment->comment_date) ) . "\r\n"; $body .= "\r\n" . $comment->comment_content . "\r\n"; // @TODO: mention if it was a reply /* if($parent) { } */ $body .= "\r\n--------------------\r\n"; $edit_link = htmlspecialchars_decode( get_edit_post_link( $post_id ) ); $view_link = htmlspecialchars_decode( get_permalink( $post_id ) ); $body .= "\r\n"; $body .= __( '== Actions ==', 'edit-flow' ) . "\r\n"; $body .= sprintf( __( 'Reply: %s', 'edit-flow' ), $edit_link . '#editorialcomments/reply/' . $comment->comment_ID ) . "\r\n"; $body .= sprintf( __( 'Add editorial comment: %s', 'edit-flow' ), $edit_link . '#editorialcomments/add' ) . "\r\n"; $body .= sprintf( __( 'Edit: %s', 'edit-flow' ), $edit_link ) . "\r\n"; $body .= sprintf( __( 'View: %s', 'edit-flow' ), $view_link ) . "\r\n"; $body .= "\r\n" . sprintf( __( 'You can see all editorial comments on this %s here: ', 'edit-flow' ), $post_type ). "\r\n"; $body .= $edit_link . "#editorialcomments" . "\r\n\r\n"; $body .= $this->get_notification_footer($post); $this->send_email( 'comment', $post, $subject, $body ); } function get_notification_footer( $post ) { $body = ""; $body .= "\r\n--------------------\r\n"; $body .= sprintf( __( 'You are receiving this email because you are subscribed to "%s".', 'edit-flow' ), ef_draft_or_post_title ($post->ID ) ); $body .= "\r\n"; $body .= sprintf( __( 'This email was sent %s.', 'edit-flow' ), date( 'r' ) ); $body .= "\r\n \r\n"; $body .= get_option('blogname') ." | ". get_bloginfo('url') . " | " . admin_url('/') . "\r\n"; return $body; } /** * send_email() */ function send_email( $action, $post, $subject, $message, $message_headers = '' ) { // Get list of email recipients -- set them CC $recipients = $this->_get_notification_recipients( $post, true ); if( $recipients && ! is_array( $recipients ) ) $recipients = explode( ',', $recipients ); if( EF_NOTIFICATION_USE_CRON ) { $this->schedule_emails( $recipients, $subject, $message, $message_headers ); } else if ( !empty( $recipients ) ) { foreach( $recipients as $recipient ) { $this->send_single_email( $recipient, $subject, $message, $message_headers ); } } } /** * Schedules emails to be sent in succession * * @param mixed $recipients Individual email or array of emails * @param string $subject Subject of the email * @param string $message Body of the email * @param string $message_headers. (optional) Message headers * @param int $time_offset (optional) Delay in seconds per email */ function schedule_emails( $recipients, $subject, $message, $message_headers = '', $time_offset = 1 ) { $recipients = (array) $recipients; $send_time = time(); foreach( $recipients as $recipient ) { wp_schedule_single_event( $send_time, 'ef_send_scheduled_email', array( $recipient, $subject, $message, $message_headers ) ); $send_time += $time_offset; } } /** * Sends an individual email * * @param mixed $to Email to send to * @param string $subject Subject of the email * @param string $message Body of the email * @param string $message_headers. (optional) Message headers */ function send_single_email( $to, $subject, $message, $message_headers = '' ) { wp_mail( $to, $subject, $message, $message_headers ); } /** * Returns a list of recipients for a given post * * @param $post object * @param $string bool Whether to return recipients as comma-delimited string or array * @return string or array of recipients to receive notification */ private function _get_notification_recipients( $post, $string = false ) { global $edit_flow; $post_id = $post->ID; if( !$post_id ) return; $authors = array(); $admins = array(); $recipients = array(); // Email all admins, if enabled if( 'on' == $this->module->options->always_notify_admin ) $admins[] = get_option('admin_email'); $usergroup_users = array(); if ( $this->module_enabled( 'user_groups' ) ) { // Get following users and usergroups $usergroups = $this->get_following_usergroups( $post_id, 'ids' ); foreach( (array)$usergroups as $usergroup_id ) { $usergroup = $edit_flow->user_groups->get_usergroup_by( 'id', $usergroup_id ); foreach( (array)$usergroup->user_ids as $user_id ) { $usergroup_user = get_user_by( 'id', $user_id ); if ( $usergroup_user ) $usergroup_users[] = $usergroup_user->user_email; } } } $users = $this->get_following_users( $post_id, 'user_email' ); // Merge arrays and filter any duplicates $recipients = array_merge( $authors, $admins, $users, $usergroup_users ); $recipients = array_unique( $recipients ); // Process the recipients for this email to be sent foreach( $recipients as $key => $user_email ) { // Get rid of empty email entries if ( empty( $recipients[$key] ) ) unset( $recipients[$key] ); // Don't send the email to the current user unless we've explicitly indicated they should receive it if ( false === apply_filters( 'ef_notification_email_current_user', false ) && wp_get_current_user()->user_email == $user_email ) unset( $recipients[$key] ); } // Filter to allow further modification of recipients $recipients = apply_filters( 'ef_notification_recipients', $recipients, $post, $string ); // If string set to true, return comma-delimited if ( $string && is_array( $recipients ) ) { return implode( ',', $recipients ); } else { return $recipients; } } /** * Set set user to follow posts * * @param $post Post object * @param $users array (optional) List of users to be added. If not included, the current user is added. * @param $append bool Whether users should be added to following_users list or replace existing list */ function follow_post_user( $post, $users, $append = true ) { // Clean up data we're using $post_id = ( is_int($post) ) ? $post : $post->ID; if( !is_array($users) ) $users = array($users); $user_terms = array(); foreach( $users as $user ) { if( is_int($user) ) $user_data = get_userdata($user); else if( is_string($user) ) $user_data = get_userdatabylogin($user); else $user_data = $user; if( $user_data ) { // Name and slug of term are the username; $name = $user_data->user_login; /** TODO: ONLY ADD IF USER IS NOT PART OF $this->exclude_users_taxonomy for the post **/ // if( !user_excluding_post($post_id, $user) ) // Add user as a term if they don't exist $term = $this->add_term_if_not_exists($name, $this->following_users_taxonomy); if(!is_wp_error($term)) { $user_terms[] = $name; } } } $set = wp_set_object_terms( $post_id, $user_terms, $this->following_users_taxonomy, $append ); return; } /** * Removes user from following_users taxonomy for the given Post, so they no longer receive future notifications * Called when delete_user action is fired * * @param $post Post object */ function unfollow_post_user( $post, $user = 0 ) { global $current_user; // TODO: Finish this $post_id = $post->ID; //if(!$user) $user = wp_get_current_user(); if(!$post_id || !$user || $user->ID == 0) return; // Name and slug of term are the username; $name = $user->user_login; // Remove the user from the following_users taxonomy if( term_exists($name, $this->following_users_taxonomy) ) { $set = wp_set_object_terms( $post->ID, $name, $this->following_users_taxonomy, true ); $old_term_ids = wp_get_object_terms($post_id, $this->following_users_taxonomy, array('fields' => 'ids', 'orderby' => 'none')); /* $delete_terms = array_diff($old_tt_ids, $tt_ids); if ( $delete_terms ) { $in_delete_terms = "'" . implode("', '", $delete_terms) . "'"; do_action( 'delete_term_relationships', $object_id, $delete_terms ); $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_delete_terms)", $object_id) ); do_action( 'deleted_term_relationships', $object_id, $delete_terms ); wp_update_term_count($delete_terms, $taxonomy); } */ } // Add user to the unfollowing_users taxonomy $insert = $this->add_term_if_not_exists($name, $this->unfollowing_users_taxonomy); if(!is_wp_error($insert)) { $exclude = wp_set_object_terms( $post_id, $name, $this->unfollowing_users_taxonomy, true ); } return; } /** * follow_post_usergroups() * */ function follow_post_usergroups( $post, $usergroups = 0, $append = true ) { global $edit_flow; if ( !$this->module_enabled( 'user_groups' ) ) return; $post_id = ( is_int($post) ) ? $post : $post->ID; if( !is_array($usergroups) ) $usergroups = array($usergroups); $usergroup_terms = array(); foreach( $usergroups as $usergroup ) { // Name and slug of term is the usergroup slug $usergroup_data = $edit_flow->user_groups->get_usergroup_by( 'id', $usergroup ); } $set = wp_set_object_terms( $post_id, $usergroups, $this->following_usergroups_taxonomy, $append ); return; } /** * Removes users that are deleted from receiving future notifications (i.e. makes them unfollow posts FOREVER!) * * @param $id int ID of the user */ function delete_user_action( $id ) { if( !$id ) return; // get user data $user = get_userdata($id); if( $user ) { // Delete term from the following_users taxonomy $user_following_term = get_term_by('name', $user->user_login, $this->following_users_taxonomy); if( $user_following_term ) wp_delete_term($user_following_term->term_id, $this->following_users_taxonomy); // Delete term from the unfollowing_users taxonomy $user_unfollowing_term = get_term_by('name', $user->user_login, $this->unfollowing_users_taxonomy); if( $user_unfollowing_term ) wp_delete_term($user_unfollowing_term->term_id, $this->unfollowing_users_taxonomy); } return; } /** * Add user as a term if they aren't already * @param $term string term to be added * @param $taxonomy string taxonomy to add term to * @return WP_error if insert fails, true otherwise */ function add_term_if_not_exists( $term, $taxonomy ) { if ( !term_exists($term, $taxonomy) ) { $args = array( 'slug' => sanitize_title($term) ); return wp_insert_term( $term, $taxonomy, $args ); } return true; } /** * Gets a list of the users following the specified post * * @param int $post_id The ID of the post * @param string $return The field to return * @return array $users Users following the specified posts */ function get_following_users( $post_id, $return = 'user_login' ) { // Get following_users terms for the post $users = wp_get_object_terms( $post_id, $this->following_users_taxonomy, array('fields' => 'names') ); // Don't have any following users if( !$users || is_wp_error($users) ) return array(); // if just want user_login, return as is if ( $return == 'user_login' ) return $users; foreach( (array)$users as $key => $user ) { switch( $user ) { case is_int( $user ): $search = 'id'; break; case is_email( $user ): $search = 'email'; break; default: $search = 'login'; break; } $new_user = get_user_by( $search, $user ); if ( !$new_user ) continue; switch( $return ) { case 'user_login': $users[$key] = $new_user->user_login; break; case 'id': $users[$key] = $new_user->ID; break; case 'user_email': $users[$key] = $new_user->user_email; break; } } if( !$users || is_wp_error($users) ) $users = array(); return $users; } /** * Gets a list of the usergroups that are following specified post * * @param int $post_id * @return array $usergroups All of the usergroup slugs */ function get_following_usergroups( $post_id, $return = 'all' ) { global $edit_flow; // Workaround for the fact that get_object_terms doesn't return just slugs if( $return == 'slugs' ) $fields = 'all'; else $fields = $return; $usergroups = wp_get_object_terms( $post_id, $this->following_usergroups_taxonomy, array( 'fields' => $fields ) ); if( $return == 'slugs' ) { $slugs = array(); foreach($usergroups as $usergroup) { $slugs[] = $usergroup->slug; } $usergroups = $slugs; } return $usergroups; } /** * Gets a list of posts that a user is following * * @param string|int $user user_login or id of user * @param array $args * @return array $posts Posts a user is following */ function get_user_following_posts( $user = 0, $args = null ) { if ( !$user ) $user = (int) wp_get_current_user()->ID; if ( is_int($user) ) $user = get_userdata($user)->user_login; $post_args = array( $this->following_users_taxonomy => $user, 'posts_per_page' => '10', 'orderby' => 'modified', 'order' => 'DESC', ); $post_args = apply_filters( 'ef_user_following_posts_query_args', $post_args ); $posts = get_posts( $post_args ); return $posts; } /** * Register settings for notifications so we can partially use the Settings API * (We use the Settings API for form generation, but not saving) * * @since 0.7 */ function register_settings() { add_settings_section( $this->module->options_group_name . '_general', false, '__return_false', $this->module->options_group_name ); add_settings_field( 'post_types', __( 'Post types for notifications:', 'edit-flow' ), array( $this, 'settings_post_types_option' ), $this->module->options_group_name, $this->module->options_group_name . '_general' ); add_settings_field( 'always_notify_admin', __( 'Always notify blog admin', 'edit-flow' ), array( $this, 'settings_always_notify_admin_option'), $this->module->options_group_name, $this->module->options_group_name . '_general' ); } /** * Chose the post types for notifications * * @since 0.7 */ function settings_post_types_option() { global $edit_flow; $edit_flow->settings->helper_option_custom_post_type( $this->module ); } /** * Option for whether the blog admin email address should be always notified or not * * @since 0.7 */ function settings_always_notify_admin_option() { $options = array( 'off' => __( 'Disabled', 'edit-flow' ), 'on' => __( 'Enabled', 'edit-flow' ), ); echo ''; } /** * Validate our user input as the settings are being saved * * @since 0.7 */ function settings_validate( $new_options ) { // Whitelist validation for the post type options if ( !isset( $new_options['post_types'] ) ) $new_options['post_types'] = array(); $new_options['post_types'] = $this->clean_post_type_options( $new_options['post_types'], $this->module->post_type_support ); // Whitelist validation for the 'always_notify_admin' options if ( !isset( $new_options['always_notify_admin'] ) || $new_options['always_notify_admin'] != 'on' ) $new_options['always_notify_admin'] = 'off'; return $new_options; } /** * Settings page for notifications * * @since 0.7 */ function print_configure_view() { ?>
module->options_group_name ); ?> module->options_group_name ); ?> module->name ) . '" />'; ?>