diff --git a/automatically-paginate-posts.php b/automatically-paginate-posts.php index 350587b29fac0ef53402f3928eed8f9c6f2d7c73..a291ca55c1aebe6b0e30e080d014e494e0f591ff 100644 --- a/automatically-paginate-posts.php +++ b/automatically-paginate-posts.php @@ -1,7 +1,7 @@ <?php /* Plugin Name: Automatically Paginate Posts -Plugin URI: +Plugin URI: http://www.thinkoomph.com/plugins-modules/automatically-paginate-posts/ Description: Automatically inserts the <!--nextpage--> Quicktag into WordPress posts, pages, or custom post type content. Version: 0.1 Author: Erick Hitter (Oomph, Inc.) @@ -108,7 +108,7 @@ class Automatically_Paginate_Posts { * Register settings and settings sections * Settings appear on the Reading page * - * @uses register_setting, add_settings_section, add_settings_field + * @uses register_setting, add_settings_section, __, __return_false, add_settings_field * @action admin_init * @return null */ @@ -116,7 +116,7 @@ class Automatically_Paginate_Posts { register_setting( 'reading', $this->option_name_post_types, array( $this, 'sanitize_supported_post_types' ) ); register_setting( 'reading', $this->option_name_num_pages, array( $this, 'sanitize_num_pages' ) ); - add_settings_section( 'autopaging', 'Automatically Paginate Posts', '__return_false', 'reading' ); + add_settings_section( 'autopaging', __( 'Automatically Paginate Posts', 'autopaging' ), '__return_false', 'reading' ); add_settings_field( 'autopaging-post-types', __( 'Supported post types:', 'autopaging' ), array( $this, 'settings_field_post_types' ), 'reading', 'autopaging' ); add_settings_field( 'autopaging-num-pages', __( 'Number of pages to split content into:', 'autopaging' ), array( $this, 'settings_field_num_pages' ), 'reading', 'autopaging' ); } @@ -210,13 +210,13 @@ class Automatically_Paginate_Posts { /** * Add autopaging metabox * - * @uses this::get_option, add_metabox + * @uses add_metabox, __ * @action add_meta_box * @return null */ public function action_add_meta_boxes() { foreach ( $this->post_types as $post_type ) { - add_meta_box( 'autopaging', 'Post Autopaging', array( $this, 'meta_box_autopaging' ), $post_type, 'side' ); + add_meta_box( 'autopaging', __( 'Post Autopaging', 'autopaging' ), array( $this, 'meta_box_autopaging' ), $post_type, 'side' ); } } @@ -224,7 +224,7 @@ class Automatically_Paginate_Posts { * Render autopaging metabox * * @param object $post - * @uses esc_attr, checked, wp_nonce_field + * @uses esc_attr, checked, _e, __, wp_nonce_field * @return string */ public function meta_box_autopaging( $post ) { @@ -232,8 +232,8 @@ class Automatically_Paginate_Posts { <p> <input type="checkbox" name="<?php echo esc_attr( $this->meta_key_disable_autopaging ); ?>" id="<?php echo esc_attr( $this->meta_key_disable_autopaging ); ?>_checkbox" value="1"<?php checked( (bool) get_post_meta( $post->ID, $this->meta_key_disable_autopaging, true ) ); ?> /> <label for="<?php echo esc_attr( $this->meta_key_disable_autopaging ); ?>_checkbox">Disable autopaging for this post?</label> </p> - <p class="description">Check the box above to prevent this post from automatically being split over two pages.</p> - <p class="description">Note that if the <code><!--nextpage--></code> Quicktag is used to manually page this post, automatic paging won't be applied, regardless of the setting above.</p> + <p class="description"><?php _e( 'Check the box above to prevent this post from automatically being split over multiple pages.', 'autopaging' ); ?></p> + <p class="description"><?php printf( __( 'Note that if the %1$s Quicktag is used to manually page this post, automatic paging won\'t be applied, regardless of the setting above.', 'autopaging' ), '<code><!--nextpage--></code>' ); ?></p> <?php wp_nonce_field( $this->meta_key_disable_autopaging, $this->meta_key_disable_autopaging . '_wpnonce' ); } diff --git a/readme.txt b/readme.txt index 3fd6bc6c7ad3f01f1da90dfa3bd5a6fa6366b0fd..b5b8736d2194f24507c48ceb1086a5be4a705845 100644 --- a/readme.txt +++ b/readme.txt @@ -4,6 +4,50 @@ Donate link: Tags: paginate, nextpage, Quicktag Requires at least: 3.4 Tested up to: 3.4 -Stable tag: +Stable tag: 0.1 +License: GPLv2 or later +License URI: http://www.gnu.org/licenses/gpl-2.0.html -Automatically insert <!--nextpage--> Quicktag into WordPress content \ No newline at end of file +Automatically paginate posts by inserting the <!--nextpage--> Quicktag into WordPress posts, pages, or custom post type content. + +== DESCRIPTION == + +Automatically paginate WordPress content by inserting the <!--nextpage--> Quicktag. + +Option is provided to control what post types are automatically paginated (default is just `post`). Supports `post`, `page`, and any public custom post types. + +Option is also provided to specify how many pages content should be broken out over. + +== Installation == + +1. Upload automatically-paginate-posts to /wp-content/plugins/. +2. Activate plugin through the WordPress Plugins menu. +3. Configure plugin by going to Settings > Reading. + +== Frequently Asked Questions == + += Where do I set the plugin's options = +The plugin's options are added to the built-in **Reading** settings page in WordPress. + += Can I disable the plugin's functionality for specific posts, pages, or custom post type objects? = +Yes, the plugin adds a metabox to individual items in supported post types that allows the autopaging to be disabled on a per-post basis. + += How can I add support for my custom post type? = +Navigate to Settings > Reading in WP Admin to enable this plugin for your custom post type. + +You can also use the filter `autopaging_post_types` to add support by appending your post type's name to the array. + += What filters does this plugin include? = +* `autopaging_post_types` - modify the post types supported by this plugin. Will override the values set under Settings > Reading. +* `autopaging_num_pages_default` - modify the default number of pages over which a post is displayed. Will override the value set under Settings > Reading. +* `autopaging_max_num_pages` - override the maximum number of pages available in the settings page dropdown. +* `autopaging_num_pages` - change the number of pages content is displayed on at runtime. Filter provides access to the full post object in addition to the number of pages. + +== Changelog == + += 0.1 = +* Initial release. + +== Upgrade Notice == += 0.1 = +Initial release \ No newline at end of file